Menu Config - nulli0n/NexEngine-spigot GitHub Wiki
All plugin GUIs are also fully customizable. You can add or remove items, change GUI behavior, add simple animations and change item actions.
From version 2.2.8 GUI configuration was simplified a lot.
Every GUI item has its own type, which defines default item action on click. Some GUIs can provide its own, additional types. Let's consider the default ones:
- NONE - Default item type, if no other was specified. Does nothing.
- CLOSE - Closes current GUI.
- RETURN - Returns to a previous menu (if supported).
- PAGE_NEXT - Opens next page (if supported and if there is any).
- PAGE_PREVIOUS - Opens previous page (if supported and if there is any).
- CONFIRMATION_ACCEPT - Confirm the operation (for confirmation GUIs).
- CONFIRMATION_DECLINE - Decline the operation (for confirmation GUIs).
Usually, all supported types are already present in default configs with special items. You can add or remove them if needed.
Check Item Options page for item settings.
Item Format
You can use PlaceholderAPI in item names and lores. Let's consider the following example:
# This is section name for GUI items. It can be different sometimes, but usually always the same.
Content:
# This is your unique item identifier.
page_next:
# Priority setting will make items with higher priority to override items with lower one.
# For example, this can be used on 'page' items, when they have to be added over other items in the same slot(s).
Priority: 10
# Item options. Go to Engine Formats for list of all options available.
Item:
Material: ENDER_EYE
Name: '&e&lNext Page ā'
# Slots, where this item will be displayed.
Slots: 37
# Item type.
Type: PAGE_NEXT
# Custom actions on item click (in addition to or instead of 'Type' setting).
Click_Actions:
# Click type. Allowed: LEFT, RIGHT, SHIFT_LEFT, SHIFT_RIGHT
# And a list of commands:
# - 'command1'
# - 'command2'
# - 'etc'
# You can use PlaceholderAPI here.
LEFT:
- 'say Hello %player_name%!'
page_previous:
Priority: 10
Item:
Material: ENDER_EYE
Name: '&e&lā Previous Page'
Slots: 43
Type: PAGE_PREVIOUS
return:
Item:
Material: BARRIER
Name: '&c&lClose'
Slots: 40
Type: CLOSE