EssentialsGUI [BSP] - Playerfriendly Essentials Warp and Kit GUI v1.0.2 (Beta)

Creates userfriendly warp- and kit GUI menus using the Essentials configuration files.

  1. Blackixx
    Tested Minecraft Versions:
    • 1.7
    • 1.8
    • 1.9
    • 1.10
    • 1.11
    • 1.12
    EssentialsGUI
    This plugin uses your Essentials (or EssentialsX) configuration files to create very playerfriendly and intuitive chest GUI menus.

    Using this plugin players will be able to preview your Essentials Kits (including all items) and purchase or receive them with one simple click.

    If you enable the warp GUI players will be able to see a fancy list of all possible warps and teleport to them by simply clicking the warp icon they want.

    EssentialsGUI is a BossShopPro addon. It requires BossShopPro and Essentials or EssentialsX in order to work.


    [​IMG]
    • Super easy and intuitive to use
    • No need to invest time in configuration: Everything ready to be instantly used (Everything is configurable if you want to customize the plugin though)
    • Sign support
    • Supports both Essentials and EssentialsX
    Kits GUI
    [​IMG]
    • Automatic creation of kit menu, where all kits are listed (optional: Only show kits owned by the player)
    • Kits can be previewed and directly taken if available and owned
    • You can define what players will see if they don't own the kit. Maybe explain how to purchase the kit?

    Warps GUI
    [​IMG]

    (Colored warp icons and different durability using the '%warpid% placeholder')
    [​IMG]
    (Warp icons without real variation)

    • Automatic listing of all available Essentials warps in one neat GUI menu (Optional: Only show warps located in the same world as the player)
    • Players can click the warp icons to teleport
    • Warp delays, prices, required permissions etc. still depend on your Essentials settings: Everything handled as if players would manually enter the warp command
    Obviously because the creation of warp icons is automated, you can not give every warp a custom look, but instead all warp icons have the same setup. You can add some differences using placeholders like '%warpid%', however if you want a fancy warp menu, where every warp icon fits to its destination, an automated warp GUI is nothing for you. Then instead you can create your very own warp menu using BossShopPro and pick custom looks for every warp yourself.

    [​IMG]
    EssentialsGUI created menus use the same permissions as any other BossShopPro menu:
    • BossShop.open - Allows to open all shops via sign/command
    • BossShop.open.sign - Allows to open all shops via sign
    • BossShop.open.sign.<shopname> - Allows to open the named shop via sign
    • BossShop.open.command - Allows to open all shops via command
    • BossShop.open.command.<shopname> - Allows to open the named shop via command

    How to set up EssentialsGUI signs?
    Simply put the sign text defined in your configuration files into the first line of your sign. Default sign texts: '[Kits]' and '[Warps]'.


    Main config
    Code (Text):
    # EssentialsGUI
    # by Felix Neubauer
    #
    #
    # Settings:
    # FirstLetterUppercase:
    # If enabled the first letter of the name of the warp/kit will be transformed into upper case.
    #
    # Enabled:
    # Set this to false if you do not want the related menus to be created/loaded.
    Settings:
      Warp:
        FirstLetterUppercase: true
        Enabled: true
      Kit:
        FirstLetterUppercase: true
        Enabled: true
    Kit menu
    Code (Text):
    ## kitshopitem:
    ## Here you can define the look and functionality of every kit icon.
    ## By default clicking and checking out the preview of a kit is free.
    ## The reward when clicking the icon is the preview-menu being opened.
    ## Besides the default configuration uses the '%kititem_1%' placeholder to make the icon look like the first item of the kit.
    ## That way icons look different and already give a preview of the actual kit.
    kitshopitem:
      PriceType: NOTHING
      RewardType: SHOP
      Reward: 'KitPreview_%kitname%'
      MenuItem:
      - '%kititem_1%'
      - 'name:&f&n&lKit&0 &6&l%kitname%'
      - 'lore:&8Click in order to preview/activate the kit.'
      - hideflags:all
      - amount:1
    ## Uncomment the condition below if you want only player-owned kits to be shown
    #  Condition:
    #  - type:essentialskit
    #  - owns:%kitname%
    ##
    ##
    ## Everything below this comment works just like every BossShopPro shop.
    ## More information can be found here: https://www.spigotmc.org/wiki/bossshoppro-configuration/
    ShopName: Kits
    DisplayName: '&6&lKits'
    Command: kits:kitgui
    signs:
      text: '[Kits]'
      NeedPermissionToCreateSign: false
    shop:
      Back:
        MenuItem:
        - lore:&8Back to Menu
        - name:&cBack
        - amount:1
        - type:REDSTONE
        RewardType: SHOP
        Reward: menu
        PriceType: NOTHING
        Message: ''
        ExtraPermission: ''
        InventoryLocation: 18
    Kit preview menu
    Code (Text):
    # Everything in this configuration file works just like every BossShopPro shop.
    # More information can be found here: https://www.spigotmc.org/wiki/bossshoppro-configuration/
    # The menu will automatically be filled with all items contained in the related kit. These items can be seen but not taken by the player.
    # By default players can use the 'Activate' icon to execute the kit command, if they own the kit. Else they will see the 'NotOwned' icon telling information
    # about how to purchase kits.
    ShopName: 'KitPreview_%kitname%'
    DisplayName: 'KitPreview &6&l%kitname%'
    shop:
      Activate:
        MenuItem:
        - name:&6&lReceive kit
        - lore:&8Click to receive the kit.
        - amount:1
        - type:CHEST
        RewardType: PLAYERCOMMAND
        Reward:
        - 'kit %kitname%'
        PriceType: NOTHING
        Message: ''
        ExtraPermission: ''
        InventoryLocation: 46
        Condition:
        - type:essentialskit
        - owns:%kitname%
      NotOwned:
        MenuItem:
        - name:&6&lKit Information
        - lore1:&cYou do not own that kit.
        - lore3:&8Click to purchase the &6%kitname% kit&8.
        - amount:1
        - type:CHEST
        RewardType: NOTHING
        PriceType: NOTHING
        Message: '&8You can purchase kits here: <TODO>.'
        ExtraPermission: ''
        InventoryLocation: 46
      Back:
        MenuItem:
        - lore:&8Back to Kits menu
        - name:&cBack
        - amount:1
        - type:REDSTONE
        RewardType: SHOP
        Reward: kits
        PriceType: NOTHING
        Message: ''
        ExtraPermission: ''
        InventoryLocation: 54
    Warp menu
    Code (Text):
    ## warpshopitem:
    ## Here you can define the look and functionality of every warp icon.
    ## By default clicking a warp and as result executing the warp command is free.
    ## The reward of clicking the icon is the warp command being executed.
    ## Possible warp delays, prices or required permissions depend on your Essentials settings
    ## as all this plugin does is making the player execute a specific warp command.
    ## One possibility to make your automated warp icons look different is by using the placeholder '%warpid%' which will be replaced with the id of the icon (from 0 to <amount of icons> -1).
    ## In the default configuration the warpid is combined with modulo in order to generate colorful wool icons. Of course you can remove the durability line if you do not want that effect.
    warpshopitem:
      PriceType: NOTHING
      RewardType: PLAYERCOMMAND
      Reward:
      - 'warp %warpname%'
      MenuItem:
      - name:&f&n&lWarp&0 &6&l%warpname%.
      - 'lore:&8Click in order to warp to %warpname%.'
      - type:WOOL
      - amount:1
      - 'durability:%warpid% % 15'
    ## Uncomment the playerworld condition if you want players to only see local warps which are in the same world as they are.
      Condition:
      - type:essentialswarp
      - 'validworld:%warpname%'
    #  - 'playerworld:%warpname%'
    ##
    ## Everything below this comment works just like every BossShopPro shop.
    ## More information can be found here: https://www.spigotmc.org/wiki/bossshoppro-configuration/
    ShopName: Warps
    DisplayName: '&1&lWarps'
    Command: warps:warpgui
    signs:
      text: '[Warps]'
      NeedPermissionToCreateSign: false
    shop:
      Back:
        MenuItem:
        - lore:&8Back to Menu
        - name:&cBack
        - amount:1
        - type:REDSTONE
        RewardType: SHOP
        Reward: menu
        PriceType: NOTHING
        Message: ''
        ExtraPermission: ''
        InventoryLocation: 54


    IMPORTANT:
    Does only support kits where the items were directly defined in the Essentials config file. Kits using commands are not supported.

    Warning:
    Has not been tested with old Essentials builds.
    B_Z_27_MC and ViscousHurricane like this.

Recent Reviews

  1. iDarky
    iDarky
    5/5,
    Version: v1.0.2 (Beta)
    Excellent plugin! But /warp menu isn't working for me for some reason. Please help me. Thanks

    EDIT:

    Where is the config.yml located at. Thanks
    1. Blackixx
      Author's Response
      Thanks for the review, although that's not a place for questions. Simpy use a Spigot PM to get quick help :)
  2. krazybeat
    krazybeat
    5/5,
    Version: v1.0.2 (Beta)
    The best programmer! Already helped me in several problems, I use all the plugins! awesome plugins! :)
    1. Blackixx
      Author's Response
      Thanks a lot :)