GUI

All GUI menu related options & configurations
Syntax
gui_menus:
  menuname:
    menu_title: "TEXT"
    open_command: COMMAND
    open_requirement: EXPRESSION
    open_commands:
      - "[ACTIONTYPE] ACTION"
      - "[ACTIONTYPE] ACTION"
    inventory_type: "TEXT"
    size: #
    update_interval: #
    items:
If you're using an external GUI-file (separate .yml file) your configuration will start at the menu_title: option.
Menu Title
menu_title: "TEXT"
The menu title that is shown at the top of the GUI. You can use color and formatting codes here, and PlaceholderAPI placeholders.
Open Command
open_command: COMMAND
Multiple open commands:
open_command:
  - COMMAND
  - COMMAND_2
The command used to open the GUI menu. It can only be a single word.
To disable the open command, simply delete the line of this option.
Open Requirements
open_requirement:
 requirements:
   TEXT:
     type: <type>
Sets requirements a player should have to open the GUI menu. Check the Requirements page for more info.
Open Commands
open_commands:
  - "[ACTIONTYPE] ACTION"
  - "[ACTIONTYPE] ACTION"
Runs the command(s) you set when the player opens the menu.
Close Commands
close_commands:
  - "[ACTIONTYPE] ACTION"
  - "[ACTIONTYPE] ACTION"
Runs the command(s) you set when the player close the menu by clicking an item with close action ([close]).
Inventory Type
inventory_type: "TEXT"
Default value: CHEST
Supported types:
ANVIL
BARREL
BEACON
BLAST_FURNACE
BREWING
CARTOGRAPHY
DISPENSER
DROPPER
ENCHANTING
ENDER_CHEST
FURNACE
GRINDSTONE
HOPPER
LOOM
PLAYER
SHULKER_BOX
SMOKER
WORKBENCH
Allows you to define a different type of Inventory.
Size
size: #
Default value: 54
Supported values:
9
18
27
36
45
54
Sets the inventory size.
Size option only works for CHEST inventory types. Even for that it is optional and will default to 54.
Register Command
register_command: true
Registers the open command with the server.
Must be manually added to the menu.
Args (Arguments)
args:
- "TEXT"
- "TEXT"
- "TEXT"
TEXT The argument name (Should be unique).
Gives you the ability to set arguments after the open command, and use them inside the menu by adding the argument placeholder (the argument name inside curly braces {TEXT}).
You can have multiple arguments, and they will be set in the same order in the open command.
/COMMAND FirstArg SecondArg And the rest
args:
- first
- second
- last
{first} returns FirstArg
{second} returns SecondArg
{last} returns And the rest
Argument placeholders can be used in Placeholder-Material, Display Name, Lore, and Actions only.
It's highly recommended to add the Args Usage Message option.
Requires Register Command to be true.
Args Usage Message
args_usage_message: "TEXT"
Sets the usage message for the menu. If the player didn't set the required arguments. It will be sent to the player if he didn't set the arguments. You can use color and formatting codes here. Requires Arguments to be defined.
Update Interval
update_interval: #
This is for any items that use the update: option (Check it here).
The number defines the delay (in seconds) between each refresh of the placeholders in an item's lore/display name.
Note: This refreshes/updates the placeholders only.
Items
items:
This line should be left as is. It is merely telling the plugin you are about to begin defining items.
Check the Item page for more information.
Options & Configurations
Item
Last updated 3 months ago