Menus

A hundred and eighteen menu files ship, in two places that behave completely differently.

A malformed file is named in the log and left unregistered, rather than silently loading empty.

How your menus are kept up to date

Every folder of owner menus is refreshed on start and on every reload, before the menus are read. For each file the plugin compares three things: what is on disk, what shipped this time, and the defaults you last had, which it keeps in .defaults/files/ inside the plugin folder.

• A missing file is written.
• A key a release adds is written into your file straight away, comments included. Nobody can have chosen something that did not exist yet.
• A default that changed on a key you never touched is not applied. It waits in /exylialib updates, where you apply it or keep what you have.
• Anything you changed or deleted is never touched.

On a server that already had the files before this tracking existed, every value on disk counts as yours, and a key missing from a file is offered in /exylialib updates rather than written — it may be one you deleted. A file that does not parse is left alone and reported.

Files that declare a version

The twenty-one protection screens and modules/player-settings/menus/settings.yml carry menu-version: 4. When a release ships a higher number than the file on disk (a file without the key counts as 0), the file is replaced outright, your edits with it, and your previous file is kept next to it as <name>.yml.v<old version>. That is reserved for a layout change an old file cannot survive.

The headers of modules/crates/menus/history.yml, modules/crates/menus/preview.yml, the three screens in modules/economy/menus/ and menus/currency_select.yml still say they are written once and never overwritten. Your edits are kept, but keys a release adds are written into them as described above.

The trade window, modules/trade/window.yml, is not a menu file — its slots are fixed by the plugin — but it is kept up to date the same way. See Trade and vaults.

The player-facing menus

These are the ones worth styling.

The protection screens are covered in Protections.

The admin screens

Forty-nine files in menus/admin/, one flow per module, reached from that module's admin command: mines with their levels, composition and degrade chains; crates with their rewards, animation and pity; loot chest templates and placed chests; item spawners and their locations; power-up zones, their entries and their locations; regen zones and their flag grid; duel rooms and their flags; portals; jump pads; AFK zones; warps; kits; rewards; bounties; shop categories and products; currencies and the economy settings; and item updates.

They work, and you should not edit them. The plugin replaces the folder from the jar so that a button added in a release reaches servers that already have it.

Outside that folder, modules/warps/menus/warp_setup.yml is the warp editor, and modules/protections/menus/ holds the protection admin screens — admin, admin_protection, tiers, tier and cleanup, reached from /protections admin. Those six are kept like any owner menu. See Protection admin.

The file schema

A menu file is:

title: "…"
size: 54
type: PAGINATION
open_sounds: ["UI_BUTTON_CLICK|1.0|1.0"]
click_sounds: []
refresh: { mode: SMART, interval: 40 }
filler:
  global: { material: GRAY_STAINED_GLASS_PANE, name: " " }
  pagination: { material: BARRIER, name: "Nothing here" }
pagination:
  slots: '10-16,19-25,28-34'
  item_template: { material: "%icon%", name: "%name%", lore: [], actions: ["survivalcore:…"] }
  navigation:
    previous: { slot: 45, material: ARROW }
    next:     { slot: 53, material: ARROW }
items:
  close: { slot: 49, material: BARRIER, name: "Close", actions: ["survivalcore:close_menu"] }

State templates

A paginated list can draw a row differently depending on its state. modules/kits/menus/list.yml has four — item_template, cooldown_template, used_template, locked_template — and the kit preview's claim section has six.

Actions

The key is always actions:, a list of strings. The click type is a prefix inside the string:

actions:
  - "left: survivalcore:mine_edit %mine_id%"
  - "right: survivalcore:mine_delete %mine_id%"
  - "shift_left: survivalcore:mine_set_weight %mine_id%"

left:, right:, middle:, shift_left:, shift_right: and drop: are the prefixes; no prefix means any click. survivalcore:<name> is one of this plugin's three hundred and thirty-seven actions; close, previous_page and next_page are ExyliaLib's own.

Materials

A Bukkit material, a placeholder (%kit_icon%), basehead-<base64>, playerhead-%name% or playerhead:%name%. Both head forms are in use in the shipped files.

Actions worth binding elsewhere

The plugin registers 337 actions under the survivalcore: namespace, and they work from any ExyliaLib menu in any plugin — a hub selector, an NPC, a hotbar item. Each one does nothing while its module is off. The ones most worth knowing: