GUI Menus

Inventory menus are controlled by gui.enabled in config.yml and layout in gui.yml. Version 1.2.4.

Page map only: what each menu is for. Full layout dump: Default gui.yml.

When GUIs are disabled, use /sf help and subcommands instead.

Player / staff how-to

Who	Open	Notes
Player	/sf menu, /sf stats	Hub, browser, quick join
Host	Lobby unlock GUI	When locked floors exist
Staff	Wand Floor Editor / Falling Hazard / Room Settings; /sf menu → Admin Control	Needs wand / soapsfloor.admin.gui

Global GUI settings

Master kill switch: config.yml → gui.enabled (default true).

From gui.yml settings (cosmetics / sounds only):

Key	Default	Effect
filler-material	GRAY_STAINED_GLASS_PANE	Empty slot filler
filler-name	" "	Filler display name
open-sound	BLOCK_CHEST_OPEN	Sound on open
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

Menu size

size is row count (3 to 6), not total slots.

Menu	Rows	Slots
Weakness Vote	5	45
Main Hub	4	36
Player Stats	5	45
Player Settings	3	27
Admin Control	5	45
Room Browser	5	45
Leaderboard Rooms	5	45
Leaderboard View	5	45
Schematic Browser	5	45

Menus

Main Hub (/sf menu)

4 rows. Player actions stay centered; Admin sits in the top-right corner (GRAY_DYE @8) so the grid does not leave a hole when you lack soapsfloor.admin.gui.

Row	Items
1	Quick Join, Room Browser, Your Stats
2	Leaderboards, Session Status
Footer	Close
Corner	Admin (staff only)

No Commands, Leave Session, or Settings submenu on the hub. Editor feedback lives under Admin Control (or /sf settings toggle feedback). Leave a run with /sf leave.

Slot item	Action	Permission
Quick Join	/sf quickjoin	None
Room Browser	Open room browser	None
Your Stats	Open player stats	None
Leaderboards	Open leaderboard room list	None
Session Status	Display only	None
Admin	Open admin panel	soapsfloor.admin.gui
Close	Close menu	None

Admin Control

Reload, debug, room browser shortcut, and editor feedback toggle. Back / Close in the footer.

Player Settings

Compact feedback-only menu (not linked from the hub). Prefer Admin Control or /sf settings toggle feedback.

Room Browser

Paginated list of rooms. Click a room to join. Previous is hidden on the first page; Next is hidden on the last page.

Placeholders on room items: {room_id}, {floors}, {players}, {max_players}, {status}, {best_time}.

Player Stats (/sf stats)

Shows {total_kills}, {games_completed}, {best_time_current_room}, {best_time_overall}, {best_room_name}, {rooms_with_best}.

Leaderboards

1. Pick a room from the room list.
2. View Best Time or Best Kills tabs.

Schematic Browser

Used from /sf schematics or Shift + Right Click wand in editor.

• Toggle between schematics and packs (only complete/saved packs are listed)
• Schematics mode lists .schem files from plugins/SoapsFloor/schematics/
• Packs mode lists packs from plugins/SoapsFloor/packs/
• Empty Packs tab: Create pack (type an id in chat once)
• Floor selector: layer count, start floor, Confirm. Replace? appears if floors already have content
• After Confirm the browser closes (reopen with Shift + Right Click / /sf schematics)
• Pack authoring uses Pack weights (Add schematic Back returns to that menu)
• Locked floors stay after free floors when layers are added

Weakness Vote

Opens automatically when a run's weakness vote starts (if GUIs are enabled).

• 5-row layout with spaced option icons
• Clock header shows time left and your current vote
• Click an option to vote (or change vote); /sf vote <n> still works
• Soft-refreshes each second while the timer runs

Floor Editor (wand editor)

Opened from the editor hotbar comparator.

1. Hub. Select a floor, then open a settings panel.
2. Access & locks. Set currency, item costs, and the boss flag.
3. Mob settings. Set min/max counts, manage the entry list, add via chat, or use defaults.
4. Countdown. Per-floor wait after clear (Drop: before the floor drops. Climb: before the next floor opens). Inherit the room default from Room Settings, or set a custom value.
5. Custom commands. Commands that run when the floor starts.

See Locked Floors.

Falling Hazard / Rising Flood (wand editor)

Opened from the editor hotbar magma cream. Room-wide, off by default. Saves to the room YAML. Drop rooms show Falling Hazard. Climb rooms show Rising Flood.

• With GUI on: enable/disable, style (particles / water / lava on Climb), start timing, fall/rise interval, hit modes, particle, color, advanced look options
• On Climb, enabling flood sets Escape win mode. Disabling it sets Clear mode
• Particle: left/right cycle presets; shift-click to type any Bukkit name in chat
• With GUI off: right-click toggles enabled/disabled

See Falling Hazard.

Room Settings (wand editor)

Opened from the editor hotbar nether star. Hub with categories:

Category	Contents
Lobby & party	Auto-start, min/max, join in progress, countdown, party scaling
Lives & combat	Party lives, keep inventory/XP, PvP
Rewards & weakness	Reward table, weakness voting
Direction & climb	Direction, climb reveal / overhead / mob fall, win mode, after-clear (Stay / Ladder / Stair pack), Choose stair pack picker + validate, connector ghost On/Off + adjust, retire lower floor, void enclosure
Rising Flood / Falling Hazard	Shortcut to the hazard menu

Climb clear mode (flood Off) uses after-clear settings: Stay, Ladder (support material in chat), or Stair pack (opens a pack picker). Ladder and Stair open a path, wait for the party upstairs, close the hole, then spawn mobs. Choose stair pack uses schematic-based icons and refreshes the amber connector ghost on click. Connector ghost shows or hides that path. Adjust in world: look slides XZ, scroll nudges, shift-scroll rotates, axis y −1…+2. Chat//sf connector Move/Seam/Done (x y z free rotate, floor starter all here, reset done cancel). Selected connection is brighter; Starter→1 is adjustable. Escape mode (flood On) hides after-clear options.

Lobby unlock (host)

Shown to the session host before the run when locked floors exist.

• Open the next locked floor (pays currency and/or items)
• Start the run when auto-start / waiting timer is not driving the lobby

GUI actions

Defined in gui.yml header comments:

Action	Effect
[close]	Close menu
[open_menu] <id>	Open another menu
[command] <cmd>	Player runs command
[prev_page] / [next_page]	Pagination
[refresh]	Refresh current menu
[join_random]	Join random room
[leave_session]	Leave session
[help]	Show help
[toggle] feedback	Toggle feedback mode
[toggle] actionbar	Toggle actionbar hints
[toggle] preview	Toggle floor preview
[reload]	Reload config
[debug]	Show debug info
[tab] time / [tab] kills	Leaderboard tab
[none]	Decorative only

Menu IDs for [open_menu]: main_hub, room_browser, stats, settings, admin, leaderboards, leaderboard_view, schematic_browser.

Per-item permissions

Add permission: soapsfloor.some.perm on a gui.yml item to hide it from players without that node.

Customizing

Edit titles, materials, lore, and slots in gui.yml. Use MiniMessage formatting. Reload with /sf reload.

---

Defaults: Default gui.yml · Hub: Config Reference