Skip to content

Latest commit

 

History

History
213 lines (163 loc) · 4.38 KB

gui.md

File metadata and controls

213 lines (163 loc) · 4.38 KB
Raw
description
All GUI menu related options & configurations

GUI

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.

{% hint style="info" %} To disable the open command, simply delete the line of this option. {% endhint %}

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

{% hint style="warning" %} 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. {% endhint %}

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.

{% hint style="info" %} Size option only works for CHEST inventory types. Even for that it is optional and will default to 54. {% endhint %}

Register Command

register_command: true

Registers the open command with the server.

{% hint style="info" %} Must be manually added to the menu. {% endhint %}

{% hint style="info" %} Server will need to be restarted. {% endhint %}

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

{% hint style="info" %}

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.