menus.yml
The buttons of the /ah chest menus: their items, names, lore and slots, and the background of each screen. Written to plugins/ProtonAuctions/menus.yml. Apply changes with /ahadmin reload.
The file has one block per menu:
| Block | The menu | Title from this file | Height from this file | Buttons in this file |
|---|---|---|---|---|
mainMenu | The main browse grid. | No | Yes | previous-page, next-page, sorting, category-selector, search, search-active, clear-search, loading |
confirmMenu | The purchase confirmation. | No | Yes | item-preview, cancel, confirm |
myAuctionsMenu | Your own listings (/ah my). | No | Yes | tab-active, tab-expired, tab-sold, previous-page, next-page, empty-placeholder |
claimMenu | The claim bin (/ah claim). | No | No | None, only the background. |
categoryMenu | The category picker. | No | No | all-categories, back |
searchMenu | The search screen. | No | Yes | current-query, enter-query, clear-search, back |
bidMenu | Not used. The bidding screen is fixed. | No | No | None |
cancelMenu | The cancel confirmation. | No | Yes | item-preview, abort, confirm |
adminMenu | The admin actions screen. | Yes | Yes | item-preview, force-end, delete, view-info, copy-id, back |
shulkerPreviewMenu | The shulker box preview. | Yes | Yes | back, bid-action, buy-action |
historyMenu | The sales history screen. | No | No | previous-page, next-page, back |
currencySelectionMenu | The currency picker, shown when you sell with more than one currency, or with barter on. | No | No | cancel, item-preview |
Where a title does not come from this file, it comes from the language file. See Localization.
Menu keys
Each menu block has:
| Key | Default | What it does |
|---|---|---|
title | The menu title, MiniMessage. Only adminMenu and shulkerPreviewMenu use it. | |
rows | 6 | Menu height, 1 to 6, for the menus marked Yes above. |
fillItem | The background item placed in empty slots. Uses the item keys below. | |
items | A map of named buttons in the menu. Each uses the item keys below. |
On mainMenu and myAuctionsMenu, a button only shows on the bottom row, except loading and empty-placeholder, which sit in the grid. Changing rows there moves the bottom row, so the buttons disappear unless they move too. Keep the main grid at 6 rows.
Item keys
Both fillItem and every entry under items use these keys:
| Key | Default | What it does |
|---|---|---|
material | STONE | The item material. |
name | The item name, MiniMessage. | |
lore | Lore lines, MiniMessage. | |
slot | 0 | The slot the item sits in. |
glow | false | Give the item an enchant glow. |
customModelData | 0 | A resource-pack model id. 0 means none. |
Some names and lore include ${...} tokens the plugin fills in per menu, such as a listing's price, seller, or time remaining. Keep those tokens where you want the value to show.
mainMenu: items: search: material: COMPASS name: '<yellow>Search</yellow>' slot: 51 glow: true