GUI Menus

File: plugins/SoapsArena/gui.yml

Master switch: gui.enabled in config.yml and settings.enabled in gui.yml.

Command menus (/sar stats, /sar top, /sar list) also respect gui.gui-enabled in config.yml (chat fallback when false).

---

Global GUI settings

From gui.yml settings:

Key	Default	Effect
enabled	true	Enable inventory menus in this file
filler-material	GRAY_STAINED_GLASS_PANE	Empty-slot filler
filler-name	" "	Filler display name
open-sound	BLOCK_CHEST_OPEN	Sound on open (NONE to disable)
open-sound-volume	0.7	Open volume
open-sound-pitch	1.2	Open pitch
click-sound	UI_BUTTON_CLICK	Click sound (NONE to disable)
click-sound-volume	0.5	Click volume
click-sound-pitch	1.0	Click pitch

size on each menu is row count (not total slots).

---

Menus

Menu id	Purpose
main-hub	Main arena hub (/sar menu)
arena-browser	Browse and join arenas (/sar list when GUI on)
player-stats	Player statistics (/sar stats when GUI on)
admin-control	Admin panel (needs soapsarena.admin)
leaderboards	Leaderboard tabs
leaderboard-view	Paginated leaderboard entries (/sar top when GUI on)

Open with /sar menu or [open_menu] <id> actions inside gui.yml. Action comments in gui.yml also accept underscore forms such as main_hub / arena_browser.

Wand Room Settings, kit picker, and kit preview are code-built menus (not entries in the table above).

---

Placeholders in GUI text

{player}, {arenas_available}, {in_game}, {current_room}, {total_kills}, {total_deaths}, {total_wins}, {duel_wins}, {win_streak}, {best_win_streak}, {kdr}, {room}, {players}, {max_players}, {status}, {mode} (Kits or Own gear), {time_limit}, {fall_damage}, {hunger}, {action}, {tab}, {rank}, {value}, {page}

---

GUI actions

Action	Description
[close]	Close inventory
[open_menu] <id>	Open another menu
[command] <cmd>	Player runs command
[prev_page] / [next_page]	Pagination
[refresh]	Rebuild menu
[join_random]	Quickjoin the best available room
[leave_game]	Leave queue, prepare, or match
[help]	Show help
[reload]	Reload plugin (admin)
[tab] kills/wins/streak	Leaderboard tab
[feedback] <msg-key>	Send message key from messages.yml
[none]	Decorative, no click

Items can use permission: soapsarena.admin to hide from non-admins.

See SoapsCommon GUI docs for shared bracket action syntax.

Defaults: Default gui.yml · Config Reference · Reload: Getting Started