Default Config Files

SoapsCommon does not ship a config.yml. This page lists the default values used when suite plugins load GUI YAML through SoapsCommon.

---

_settings.yml defaults

If a plugin's gui/_settings.yml is missing, these defaults apply:

filler-material: GRAY_STAINED_GLASS_PANE
filler-name: " "
border-material: BLACK_STAINED_GLASS_PANE
click-sound: UI_BUTTON_CLICK
click-sound-volume: 0.5
click-sound-pitch: 1.0

---

Menu defaults

When a menu YAML omits a key:

title: <menu id>
size: 3
filler: null
border: null
open-permission: null
open-command: null
open-sound: null
open-sound-volume: 0.5
open-sound-pitch: 1.0
close-action: null
conditional-fillers: {}
refresh: 0

---

Item defaults

slot: "0"
material: STONE
name: ""
lore: []
material-active: null
name-active: null
lore-active: null
name-alt: null
permission: null
action: null
requires-online: false
right-action: null
middle-action: null
shift-left-action: null
shift-right-action: null
drop-action: null
number-action: null
skull-owner: null
custom-model-data: 0
amount: 1
glow: false
flags: null
view-condition: null

---

Example minimal menu

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"

Save this in the owning plugin's GUI folder, not in SoapsCommon. Register or reference the menu id the way that plugin documents (for SoapsAdmin, use /sa menu <id> after placing the file in gui/).

---

Shared config keys (consumer plugins)

These are not in SoapsCommon but use the same key names everywhere:

settings:
  debug: false

gui:
  enabled: true

integrations:
  soapsquest:
    enabled: false

See Configuration.