Default menu keys

Last updated Nov 2, 2026

Default menu keys

Code defaults from SoapsCommon 2.0.1 when a menu YAML omits a key.

Edit menus in the owning plugin’s GUI folder. See GUI System.

See also: Config Reference · Default item keys

Key Default
title Menu id
size 3 (rows)
filler unset
border unset
open-permission unset
open-command unset
open-sound unset
open-sound-volume 0.5
open-sound-pitch 1.0
close-action unset
conditional-fillers empty
refresh 0 (disabled)

Minimal menu example

title: "<gold>Example Menu"
size: 3

items:
  close:
    slot: 22
    material: BARRIER
    name: "<red>Close"
    action: "[close]"

  spawn:
    slot: 13
    material: COMPASS
    name: "<green>Go to spawn"
    action: "[command] spawn"

Still stuck? Ask about this page