🖨️GUIs

Configuration the menus

Since the GUI configuration follows the same structure this page will cover everything you need to know about the GUIs

Items

The item are composed of multiple properties, here are them:

  • material: The material of the item (Here is the enum).

  • name: This for customizing the name of the item.

  • lore: This for customizing the description of the item.

  • custom-model: This for adding a custom model data to the item

  • head-texture: This for defining a custom head texture to the item (The item should be a PLAYER_HEAD).

  • head-owner: This for defining a custom owner to the item (The item should be a PLAYER_HEAD).

  • symbol: I advice to not touch it, it's for GUI disposition customization.

  • nbt: Very simple, you don't touch it 🙂.

Examples:

storage:
    name: '&a&lSTORAGE'
    lore:
    - '&a¤ &fLeft Click to open storage'
    - '&a¤ &fRight Click to sell items'
    - '&aStorage&7:&f %storage_value%'
    - '&aSell Price&7:&f %storage_price%&a$'
    material: PLAYER_HEAD
    head-texture: https://textures.minecraft.net/texture/68bdc7a1d6cff76a9255652d3165532285acc3a9d1c0f12f39ca007769a7ea14
    nbt: storage
    symbol: s
xp:
    name: '&e&lCOLLECT XP'
    lore:
    - '&e¤ &fClick to collect XP'
    - '&eXp Storage&7:&f %xp_value%'
    material: PAPER
    custom-model: 324
    nbt: xp
    symbol: x

GUI Disposition

If you want to change the position of the item there is something called "GUI Disposition" that you can change for every GUI inside the plugin.

Let's look at an example and try to understand it.

Gui-Disposition:
- '---------'
- '--i-s-x--'
- '---------'

The - are the empty items, i is the information item, s is the storage item and x is the xp item. Here is how it looks ingame.

Available Placeholders

There are quite a few placeholders you can use inside the spawner GUI.

Here is the list:

  • %displayname% - To display the spawner type in this way "Iron Golem".

  • %displayname_caps% - To display the spawner type in this way "IRON GOLEM".

  • %color% - To display the spawner's defined color.

  • %drop_info% - To display the item amount dropped each spawn, displayed this way "5 - 10" or "5"

  • %xp_info% - To display the XP dropped each spawn, displayed this way "5 - 10" or "5"

  • %speed% - To display the speed of each spawn, displayed this way "1" or "2" (it's in second).

  • %stack% - To display the amount of spawner stacked

  • %storage_percentage% - To display the percentage of the storage that is full, displayed this way: "75.8" (The % sign is not displayed)

  • %xp_percentage% - To display the percentage of the XP that is full, displayed this way: "75.8" (The % sign is not displayed)

  • %storage_amount% - To display the amount of item stored.

  • %xp_amount% - To display the amount of XP stored.

  • %storage_value% - To display the percentage and the amount of items stored in a fancy way, displayed this way: "45/1000 (4.5%) Not Filled"

  • %xp_value% - To display the percentage and the amount of XP stored in a fancy way, displayed this way: "45/1000 (4.5%) Not Filled"

  • %storage_price% - To display the sell price of the stored items, displayed this way: "5.6k", "8.5M" or "123".

Last updated