Join GUI - SpleefX/SpleefX GitHub Wiki
The join GUI is a menu that contains joinable (and non-joinable, depends on customization) arenas, with a special item that represents each arena stage (running, waiting, regenerating, etc.)
To display the join GUI, run the following command:
/<mode> joingui
Permission: spleefx.mode.joingui, where mode is the game-mode. (Allowed by default)
The Join GUI settings can be controlled through /plugins/SpleefX/gui/join-gui.yml.
| Field | Description |
|---|---|
| Title | The title of the inventory. Can accept {extension} as a placeholder for the extension's display name |
| Rows | The amount of rows this menu has |
| StagesToDisplay | The arena stages that can be displayed in the GUI |
| Items | The GUI items, each one assigned to a specific arena stage. See this to understand the format |
You can also use arena placeholders in the item's display name and/or lore.
Arena stages:
-
needs_setup: The arena is not fully setup. Appears when:
- the arena's team count is less than 2 (in case of teams mode)
- the arena's minimum player count is less than 2 (in FFA mode).
- not all spawn-points are defined.
- waiting: The arena is waiting for players to join
- countdown: The arena is in countdown. Players are allowed to join as long as the arena is not full
- active: The arena is currently active and occupied
- regenerating: The arena is regenerating to its original structure. Regenerating is an extremely quick process hence this stage is rarely spotted.
- disabled: The arena and/or the extension is/are disabled.
To reload the join GUI, run /spleefx reload.