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. (The menu will not work without it)

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 should be always set, but it doesn't work for all inventory types.

Args (Arguments)

args:
TEXT: #
TEXT: #
  • TEXT The argument name (Should be unique).

  • # The number of word (amount of spaces) the argument can handle (The value of -1 should only be used in the last argument. It will make the argument handles all the world until the last one).

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: 1
second: 1
last: -1
  • {first} returns FirstArg

  • {second} returns SecondArg

  • {last} returns And the rest

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.

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.