# menu.yml You can use PlaceholderAPI and local placeholders found in [#menu-placeholders](https://docs.aeonxd.xyz/plugins/placeholders#menu-placeholders "mention") ## Main Menu options ### Title {% code fullWidth="false" %} ```yaml title: TEXT ``` {% endcode %} The menu title. Format: ### Rows {% code fullWidth="false" %} ```yaml rows: NUMBER # 1 - 6 ``` {% endcode %} The number of rows the menu should have (1 to 6). ### Open When Empty {% code fullWidth="false" %} ```yaml open_when_empty: BOOLEAN # true / false ``` {% endcode %} Whether to open the menu even if there are no players to display. ### Leaderboard {% code fullWidth="false" %} ```yaml leaderboard_item: display_name: "TEXT" # ... ``` {% endcode %} Define how a leaderboard looks in the menu. *** ## Menu options ### Title {% code fullWidth="false" %} ```yaml title: TEXT ``` {% endcode %} The menu title. Format: ### Rows {% code fullWidth="false" %} ```yaml rows: NUMBER # 1 - 6 ``` {% endcode %} The number of rows the menu should have (1 to 6). ### Max Entries ```yaml max_entries: NUMBER ``` The maximum number of entries allowed in a menu (above 0). ### Open When Empty {% code fullWidth="false" %} ```yaml open_when_empty: BOOLEAN # true / false ``` {% endcode %} Whether to open the menu even if there are no players to display. ### Refresh Cooldown {% code fullWidth="false" %} ```yaml refresh_cooldown: NUMBER ``` {% endcode %} Cooldown to use the REFRESH click command in milliseconds\ Set to 0 to disable ### Leaderboard Player {% code fullWidth="false" %} ```yaml leaderboard_player: display_name: "TEXT" # ... ``` {% endcode %} Define how a leaderboard player item looks in the menu. {% hint style="info" %} See [#items](#items "mention") on how to create items {% endhint %} *** ## Items ### Syntax {% code fullWidth="false" %} ```yaml itemName: custom_model_data: NUMBER leather_color: COLOR amount: NUMBER display_name: TEXT lore: - TEXT - TEXT enchantments: - ENCHANTMENT;LEVEL item_flags: - ITEM_FLAG hide_: BOOLEAN hide_tooltip: BOOLEAN glow: BOOLEAN click_commands: - "[TYPE] DATA" left_click_commands: - "[TYPE] DATA" right_click_commands: - "[TYPE] DATA" shift_left_click_commands: - "[TYPE] DATA" shift_right_click_commands: - "[TYPE] DATA" ``` {% endcode %} This is the common syntax for creating items. Below are the explanations for each option. ### Custom Model Data {% code fullWidth="false" %} ```yaml custom_model_data: NUMBER ``` {% endcode %} The custom model data for the item. Used with custom resource packs. ### Leather Color {% code fullWidth="false" %} ```yaml leather_color: COLOR ``` {% endcode %} The RGB colors in leather armor. Format: R,G,B (values separated by a comma) ### Amount {% code fullWidth="false" %} ```yaml amount: NUMBER ``` {% endcode %} The item's amount. Default: 1. Max: 99 ### Display Name {% code fullWidth="false" %} ```yaml display_name: TEXT ``` {% endcode %} The item display name. Uses MiniMessage format: ### Lore {% code fullWidth="false" %} ```yaml lore: - TEXT - TEXT ``` {% endcode %} The item lore. Uses MiniMessage format: ### Enchantments {% code fullWidth="false" %} ```yaml enchantments: - ENCHANTMENT;LEVEL ``` {% endcode %} The item enchantments. ### Item Flag {% code fullWidth="false" %} ```yaml item_flags: - ITEM_FLAG ``` {% endcode %} The item flags. Alternative: ```yaml hide_enchants: BOOLEAN # true / false hide_attributes: BOOLEAN # true / false hide_unbreakable: BOOLEAN # true / false hide_destroys: BOOLEAN # true / false hide_placed_on: BOOLEAN # true / false hide_additional_tooltip: BOOLEAN # true / false hide_dye: BOOLEAN # true / false hide_armor_trim: BOOLEAN # true / false hide_stored_enchants: BOOLEAN # true / false ``` ### Hide Tooltip {% code fullWidth="false" %} ```yaml hide_tooltip: BOOLEAN # true / false ``` {% endcode %} Whether the item should hide its tooltip completely. ### Glow {% code fullWidth="false" %} ```yaml glow: BOOLEAN # true / false ``` {% endcode %} Whether the item should glow. ### Click Commands {% code fullWidth="false" %} ```yaml click_commands: # Universal for all click types - "[TYPE] DATA" left_click_commands: # Left click - "[TYPE] DATA" right_click_commands: # Right click - "[TYPE] DATA" shift_left_click_commands: # Shift + Left click - "[TYPE] DATA" shift_right_click_commands: # Shift + Right click - "[TYPE] DATA" ``` {% endcode %}
TypeArgument (Data)DescriptionExample
PLAYERCommand without "/"Executes a command as the player"[PLAYER] help"
CONSOLECommand without "/"Executes a command from the console"[CONSOLE] give %player_name% minecraft:diamond 1"
CHATMessageSends a chat message as the player"[CHAT] Hey there!"
MESSAGEMessageSends a message to the player"[MESSAGE] Hey %player_name%!"
SOUNDKey: https://www.digminecraft.com/lists/sound_list_pc.php

Volume (optional): A float number >= 0

Pitch (optional): A float number, 0.0 - 2.0		Sends a sound effect to the player"[SOUND] entity.generic.explode"

"[SOUND] entity.generic.explode 1.0"

"[SOUND] entity.generic.explode 1.0 2.0"
CLOSE-Closes the menu"[CLOSE]"
PREVIOUS-Goes to the previous menu page"[PREVIOUS]"
NEXT-Goes to the next menu page"[NEXT]"
FIRST-Goes to the first menu page"[FIRST]"
LAST-Goes to the last menu page"[LAST]"
[SEARCH]Input: double
SCORE ABOVE
SCORE BELOW
SCORE EQUALS

Input: integer
POSITION ABOVE
POSITION BELOW
POSITION EQUALS

Input: string
NAME CONTAINS
NAME CONTAINS IGNORECASE

NAME EQUALS
NAME EQUALS IGNORECASE

Optional, if omitted, will use NAME CONTAINS IGNORECASE		Opens a sign as an input mean and displays the matched players based on the criteria (defined in data)

IGNORECASE: the input is case-insensitive		"[SEARCH]"
"[SEARCH] NAME EQUALS IGNORECASE"
[RESETSEARCH]-Resets search filters used in [SEARCH]"[RESETSEARCH]"
[REFRESH]-Reloads entry values and updates placeholders"[REFRESH]"
## Slotted Items Items that have slots associated with them. Found in: * **menu.yml > menu > items** * **boards.yml > boards > \[board] > custom\_items** ### Material {% code fullWidth="false" %} ```yaml material: TEXT ``` {% endcode %} The item material. Supported skull material values: 
material: head-playerName
material: head-%player_name% # Viewer's skull texture

material: basehead-<base64 texture>
material: texture-<id>
### Slot(s) {% code fullWidth="false" %} ```yaml slot: NUMBER # 0 - 53 (depends on menu size) ``` {% endcode %} Multiple slots: ```yaml slots: - NUMBER - NUMBER ``` Ranged slots: ```yaml slots: - NUMBER-NUMBER - NUMBER-NUMBER ``` The slots the item should be in, first slot is 0. Max: 53 (with 6 menu rows) ## Leaderboard Player Items Custom material, glow, and enchantments are not supported.\ You can use placeholders found in [#leaderboard-player-specific-placeholders](https://docs.aeonxd.xyz/plugins/placeholders#leaderboard-player-specific-placeholders "mention") [^1]: The ID after `https://textures.minecraft.net/textures/`