menu.yml

Menu options

You can use PlaceholderAPI and local placeholders found in Menu Placeholders

Title

title: TEXT

The menu title. Format: https://docs.advntr.dev/minimessage/format.html

Rows

rows: NUMBER # 1 - 6

The number of rows the menu should have (1 to 6).

Max Entries

max_entries: NUMBER

The maximum number of entries allowed in a menu (above 0).

Open When Empty

open_when_empty: BOOLEAN # true / false

Whether to open the menu even if there are no players to display.

Leaderboard Player

leaderboard_player:
  display_name: "TEXT"
  # ...

Define how a leaderboard player item looks in the menu.

See Items on how to create items

Items

Syntax

itemName:
  custom_model_data: NUMBER
  amount: NUMBER
  display_name: TEXT
  lore:
  - TEXT
  - TEXT
  enchantments:
  - ENCHANTMENT;LEVEL
  item_flags:
  - ITEM_FLAG
  hide_<item_flag>: 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"

This is the common syntax for creating items. Below are the explanations for each option.

Custom Model Data

custom_model_data: NUMBER

The custom model data for the item. Used with custom resource packs.

Amount

amount: NUMBER

The item's amount. Default: 1

Display Name

display_name: TEXT

The item display name. Uses MiniMessage format: https://docs.advntr.dev/minimessage/format.html

Lore

lore:
- TEXT
- TEXT

The item lore. Uses MiniMessage format: https://docs.advntr.dev/minimessage/format.html

Enchantments

enchantments:
- ENCHANTMENT;LEVEL

The item enchantments. https://www.digminecraft.com/lists/enchantment_list_pc.php

Item Flag

item_flags:
- ITEM_FLAG

The item flags. https://jd.papermc.io/paper/1.20.4/org/bukkit/inventory/ItemFlag.html

Alternative:

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

Glow

glow: BOOLEAN # true / false

Whether the item should glow.

Click Commands

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"

Type

Argument (Data)

Description

Example

PLAYER

Command without "/"

Executes a command as the player

"[PLAYER] help"

CONSOLE

Command without "/"

Executes a command from the console

"[CONSOLE] give %player_name% minecraft:diamond 1"

CHAT

Message

Sends a chat message as the player

"[CHAT] Hey there!"

MESSAGE

Message

Sends a message to the player

"[MESSAGE] Hey %player_name%!"

SOUND

Key: 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"

Closes the menu

"[CLOSE]"

Goes to the previous menu page

"[PREVIOUS]"

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.items and boards.boardName.custom_items

Material

material: TEXT

The item material. https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Material.html

Supported skull material values:

material: head-somePlayer
material: head-%player_name%

material: basehead-<base64 texture>
material: texture-<>

Slot(s)

slot: NUMBER # 0 - 53 (depends on menu size)

Multiple slots:

slots:
- NUMBER
- NUMBER

Ranged slots:

slots:
- NUMBER-NUMBER
- NUMBER-NUMBER

The slots the item should be in, first slot is 0.

Leaderboard Player Items

Custom material, glow, and enchantments are not supported. You can use placeholders found in Leaderboard Player Specific Placeholders

Previousboards.yml Nextother.yml

Last updated 25 days ago