menus.yml

The buttons of the /ah chest menus: their items, names, lore and slots, plus the height and 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	Buttons in this file
mainMenu	The main browse grid.	previous-page, next-page, sorting, category-selector, search, search-active, clear-search, loading
confirmMenu	The purchase confirmation.	item-preview, cancel, confirm
myAuctionsMenu	Your own listings (/ah my).	tab-active, tab-expired, tab-sold, previous-page, next-page, empty-placeholder
claimMenu	The claim bin (/ah claim).	None, only the height and the background.
categoryMenu	The category picker.	all-categories, previous-page, next-page, back
searchMenu	The search screen.	current-query, enter-query, clear-search, back
bidMenu	The bidding screen.	border, item-preview, your-bid, raise-1, raise-10, raise-100, raise-1000, raise-10000, custom-amount, submit, back, buyout, force-end, delete
cancelMenu	The cancel confirmation.	item-preview, abort, confirm
adminMenu	The admin actions screen.	item-preview, force-end, delete, view-info, copy-id, back
shulkerPreviewMenu	The shulker box preview.	back, bid-action, buy-action
historyMenu	The sales history screen.	previous-page, next-page, back
currencySelectionMenu	The currency picker, shown when you sell with more than one currency, or with barter on.	cancel, item-preview, previous-page, next-page

Every menu takes its height from this file. Titles come from the language file, see Localization, except the adminMenu title, which is the title key here.

Menu keys

Each menu block has:

Key	Default	What it does
title		The menu title, MiniMessage. Only adminMenu uses it.
rows	depends on the menu	Menu height, 1 to 6. On the list screens, mainMenu, myAuctionsMenu, claimMenu, categoryMenu, historyMenu and currencySelectionMenu, the bottom row holds the buttons and the rows above it hold the listings, so 2 is the smallest height there.
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.
contentSlots	(empty)	On mainMenu, myAuctionsMenu, historyMenu, categoryMenu and currencySelectionMenu: the slots that hold listings or entries, counted from 0 at the top left. Empty uses every slot above the bottom row. A slot outside those rows is not used, and the console says so when the file loads.

Where buttons go

• On the list screens, buttons sit on the bottom row. Slots 45 to 53 always mean the bottom row, whatever the height, so the default slots keep working when you change rows.
• On mainMenu and myAuctionsMenu, a button in any other slot is hidden, and the console says so. loading and empty-placeholder are the exception: they sit among the listings.
• On categoryMenu, historyMenu and currencySelectionMenu, only the column of a button's slot counts. The button always shows on the bottom row, in that column.
• On the other screens, keep every button inside the height you set. On bidMenu, a button that does not fit is hidden and the console says so.
• On mainMenu and bidMenu, a slot of -1 hides a button.

The bidding screen

• border fills the whole row its slot is in.
• item-preview shows the listing's item and your-bid the bid you are about to place.
• raise-1, raise-10, raise-100, raise-1000 and raise-10000 add 1, 10, 100, 1,000 and 10,000 to your bid. custom-amount asks for an amount in chat, submit places the bid and back goes back.
• buyout only shows when the listing has a buyout price. force-end and delete only show to staff in admin mode.
• Leave a button's name and lore empty to use the text from the language file, or fill them in to replace it.

A menus.yml from an older version, with the old bid buttons, gets this layout when it loads.

Page buttons

categoryMenu and currencySelectionMenu have previous-page and next-page buttons for when there are more entries than fit. An older menus.yml gets them added when it loads.

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. Without a colour it shows in white, and it is never italic unless you make it so.
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

Copy