Menus

Every in-game menu is fully editable. On first start PhantomBans creates a plugins/PhantomBans/menus/ folder with one file per menu, so you can restyle any button, move it, reskin it with a resource pack, or lay out your own filler design.

For how the menus are used in-game, see In-Game Menus.

The files

Because the shared chrome lives in common.yml, editing the border, brand banner, close button, or page controls there changes every menu at once.

Item keys

Every item in every menu accepts the same keys:

close:
  slot: 8
  material: BARRIER
  custom-model-data: 0
  glow: true
  name: '<red><bold>Close</bold></red>'
  lore:
    - '<gray>Close this menu.</gray>'

Menu titles and row counts are configurable too, at the top of each file:

title: '<gradient:#9B30FF:#FF3A6E>Punish » {player}</gradient>'
rows: 6

Filler designs

Each menu file has a fillers: block. Add as many named entries as you like, each with its own material, to build layered pane designs:

fillers:
  border:
    material: BLACK_STAINED_GLASS_PANE
    slots: border        # the outer edge
  accent:
    material: PURPLE_STAINED_GLASS_PANE
    slots: [3, 5]        # explicit slots

slots takes one of:

• border - the outer edge of the menu
• fill - every slot
• a list like [3, 5, 21] - exactly those slots

Fillers are painted first, so your buttons always sit on top. Remove the fillers: block from a menu to fall back to the single border pane defined in common.yml.

Dynamic items

Some menus build their items from live data. Those still take all the keys above, plus a little extra:

• History rows (history.yml, staffhistory.yml) pick their material from a materials: map by punishment type, with a default:

  entry:
    materials:
      BAN: BARRIER
      MUTE: PAPER
      KICK: LEATHER_BOOTS
      WARN: ORANGE_DYE
      default: BOOK
    name: '<color:#9B30FF><bold>#{id} {type}</bold></color>'
    removed-line: '<red>Removed by {removed_by} on {removed_at}</red>'
    evidence-line: '<color:#1AFFB2>Evidence: {evidence_url}</color>'

  The {removed} and {evidence} lore lines only appear when they apply.

• Risk tiles (lookup.yml, punish.yml) pick their material from a materials: map by score tier: low, medium, high, critical.

• Duration buttons (duration.yml) are a buttons: map where each entry has a slot and a duration (parsed, and available as {duration} in the lore). Add, remove, or reorder them freely.

• Reason and template grids (reason.yml, template.yml) use a top-level slots: list for where the entries are placed.

Placeholders

Names and lore accept placeholders in curly braces. The useful ones per menu:

Apply your changes

After editing any menu file, run:

/phantombans reload