GUI Menus

Last updated Jul 6, 2026

GUI Menus

File: plugins/SoapsArena/gui.yml

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


Global GUI settings

Key Default
enabled true
filler-material GRAY_STAINED_GLASS_PANE
open-sound BLOCK_CHEST_OPEN
click-sound UI_BUTTON_CLICK

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

Open with /sar menu or [open_menu] <id> actions inside gui.yml.


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}, {time_limit}, {fall_damage}, {hunger}, {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] Join random open arena
[leave_game] Leave current game
[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.

Discord