GUI

All GUI menu related options & configurations

Syntax

menu_title: "TEXT"
open_command: COMMAND
open_requirement: EXPRESSION
open_commands:
  - "[ACTIONTYPE] ACTION"
  - "[ACTIONTYPE] ACTION"
inventory_type: "TEXT"
size: #
update_interval: #
items:

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.

Placeholders Support Arguments

arguments_support_placeholders: true

In version 1.14.1 of DeluxeMenus, the order of placeholders and arguments being parsed was changed for security reasons. If you know there is no security risk for you, the old order can be reverted by adding this option.

Security Warning!

Some placeholders do more than returning values. To prevent user input from being used directly into placeholders, this option is disabled by default. If you know the placeholders you use inside menus are not doing such things, feel free to enable this option!

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 that have the close action ([close]).

At the moment, it is not possible to run these actions when a menu is closed by other means such as pressing the "ESC" key.

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.

Server will need to be restarted.

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}).

Arguments can also be specified when the [openguimenu] action is used.

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

• It's highly recommended to add the Args Usage Message option.

• Requires Register Command to be enabled!

Arguments Wrong Usage Message

args_usage_message: "TEXT"

Custom message to be sent to a player when he uses a command to open a menu but does not specify the required arguments. Colors and formatters can be used in this message.

Requires Arguments to be defined.

Argument Requirements

Arguments can have their own requirements and they are checked before the menu is opened.

args:
  player:
   requirements:
     regex:
       type: "regex matches"
       input: "{player}"
       regex: "^[a-zA-Z]{2,16}$"
       deny_commands:
         - "[message] That's not a valid player!"
     length:
       type: "string length"
       input: "{player}"
       min: 2
       max: 32
       deny_commands:
         - "[message] Player must be between 2 and 32 characters long."
     player:
       type: "is object"
       input: "{player}"
       object: "player"
       deny_commands:
         - "[message] Must be a player's username or UUID."

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.