GUIs and Menus

Last updated Oct 28, 2026

GUIs and Menus

SoapsAdmin panels are Java-backed staff and player menus. Customize look and click actions in one file: gui.yml.

You cannot create new panel ids. Only built-in menus can be customized.

Global settings

Setting File Effect
settings.enabled gui.yml Turns all GUIs on or off
Filler, border, click sound gui.yml → settings: Defaults for every panel

Open panels with soapsadmin.gui. Manage gui.yml with soapsadmin.guiconfig.

Commands

Command Description
/sa dashboard Player dashboard
/sa admin Admin hub (Duty, Server, Content, Travel, Punish, Staff Tools)
/sa admin <panel> Open a specific admin panel
/sa guiconfig list List built-in panels
/sa guiconfig reload Reload gui.yml
/sa guiconfig regenerate Rewrite gui.yml from jar defaults (saves gui.yml.bak)
/sa reload gui Same as /sa guiconfig reload

Customizing panels

  1. Edit plugins/SoapsAdmin/gui.yml (created on first boot).
  2. Change title, size, filler, border, and per-item material, name, lore, slot, glow, amount, custom-model-data, skull-owner, and actions.
  3. You can add decorative items on an existing panel if they have a material, slot, and tagged action.
  4. Run /sa guiconfig reload.

If the file is broken, delete gui.yml and reload, or run /sa guiconfig regenerate.

Actions use the tagged form [type] …, for example [open_menu] dashboard, [command] /spawn, [close], [dummy], [message] Hello, and jar types such as [prev_page].

Click binds: left, right, shift-left, shift-right, drop, number key, and F (f-action). Middle-click is not used.

Common menu ids

Menu ID Purpose
dashboard Admin hub landing
admin-hub-duty Staff panel, Support Hub, lookup, vanish and staff mode
admin-hub-server Health, performance, worlds, modules, maintenance, gamerules
support-hub Reports and tickets
admin-hub-content Economy, kits, recipes, MOTD, announcements
admin-hub-travel Warps, homes, waypoints, item editor
admin-hub-punish Punish action picker
punish-player-select Player list after a punish action
admin-hub-tools Staff tool picker
staff-tool-player-select Online player list for a staff tool
playerinfo Player overview with Inspect and Actions
playerinfo-hub-inspect Invsee, endersee, notes, alts, snapshot, spectate
playeraction Per-player actions
trade Player trade offers
player-dashboard Player dashboard
staffpanel Online player browser
playerselect Online player select
reportselect Report target picker
inv-snapshot-players Inventory snapshot player list
health Server health and performance shortcuts
reports Report list
ticket-list / ticket-view Support tickets
kit-list / kit-manager / kit-editor Kits
economy-admin / economy-baltop / economy-select / baltop Economy
shop-hub / shop-buy / shop-sell Shop
homes / warps / friend-list Player utilities
custom-commands and related Custom commands
broadcast-templates Broadcast templates
audit-hub / audit-browser Audit tools
gamerules Gamerule editor
attributes Attribute editor
waypoint-list / spawner-list Lists
player-vault / vault-list Player vaults
spawner-editor / recipe-browser / itemeditor Content tools
rtp-worlds RTP world picker
mail-inbox / rules / motd-editor Mail, rules, MOTD

Hub flow

  • /sa admin opens hub tiles instead of one crowded page.
  • Punish and Staff Tools: choose the action first, then pick a player.
  • Player lists: left-click runs the action, right-click opens Player Info, shift-click opens Actions when available.
  • Filter and search are remembered for the staff session.
  • Duty toggles and common Actions refresh in place instead of closing the menu.
  • Support Hub covers reports for abuse and tickets for help.
  • Jar upgrades still supply missing stock wiring at runtime. Regenerate gui.yml when you want a fresh on-disk template.

Files

File Role
gui.yml Live customization and settings

Still stuck? Ask about this page