Buttons

Buttons are the interactive elements within a menu that players can click to trigger various actions. Each button can be customized to display specific menus, run commands, send messages, and more.

Buttons component of a menu is a list of buttons, which has the following properties:

Button Display

Slot

Description: Defines the position of the button in the menu. Slot numbers start from 0 and go up to the size of the menu.

Type: Integer or List of Integer or String

Optional: true

Example:

slot: 10

slots: 
    - 1
    - 2
    - 3
    
slots:
    - "5 to 9"
    - 12

slots: "0 to 44"

Amount

Description: Specifies how many of the item should be displayed in the button slot.

Type: Integer

Optional: true

Example:

amount: 1

Material

Description: The Minecraft material for the button. This is the actual item that players will see in the slot.

Type: Material

Optional: false

Example:

material: DIAMOND_SWORD

material: head-%player_name%

material: basehead-eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvNDJjZjMyYjI1Y2FjZDhjODMyOWVhYjc3MmRlMDExODI2MjZjYzBlY2QzMzdlY2Y3Y2M1MTc3OWZlMjE1ZWVkZiJ9fX0=

Image

Description:

URL or Material for displaying custom icons for image (primarily used for Bedrock users).

Type: URL or Material

Optional: true

Example:

# Example 1
image: https://example.com/image.png

# Example 2
image: PAPER

Path

Description:

Texture path for image, can override image

Type: URL or Material

Optional: true

Example:

path: textures/i/glyph_world_template.png

Name

Description: The display name of the button item. Supports color codes and placeholders.

Type: String or Map of String

Optional: false

Example:

name: "&cCommand Action"

name: 
    java: "<red>Command <white><small>Action</small>"
    bedrock: "Command Action"

Lore

Description: Descriptive text that appears when players hover over the button. Supports multiple lines, color codes, and placeholders.

Type: List of Strings or Map of list

Optional: false

Example:

lore: 
    - "&7Click to execute a command"
    - "<black>Line 2 of lore"
    
    
lore:
    java:
        - "line 1"
        - "line 2"
    bedrock:
        - "Some text"

Enchantments

Description: A list of enchantments applied to the button item, such as SHARPNESS, UNBREAKING, etc.

Type: List of Enchantments

Optional: true

Example:

enchantments:
    - SHARPNESS: 5
    - UNBREAKING: 5

Custom Model data

Description: The Minecraft custom model data for the item

Type: Integer

Optional: true

Example:

custom_model_data: 12131

Glow

Description: makes the item glow

Type: Boolean

Optional: true

Example:

glow: true

Hide Enchants

Description: hides the enchants of the button

Type: Boolean

Optional: true

Example:

hide_enchants: true

hide_enchantments: true

Hide Attributes

Description: hides the attributes of the button

Type: Boolean

Optional: true

Example:

hide_attributes: true

Button Conditions

Items

Description: Required items that are required to click the button, They will be taken to performs the actions

Type: List of Items

Optional: true

Example:

items:
  - material: DIAMOND
    amount: 1
    name: "name of the item if wanted, can be removed"
    lore: "lore of the item if wanted, can be removed"
# enchantments can also be added like in the main button

Price

Description: Defines the in-game cost (e.g., currency) required to click this button. Useful in shops or trade menus. requires Vault

Type: Float

Optional: true

Example:

price: 200.99

Requirements

Description: Conditions that must be met for the button to be visible or clickable. These can include permissions or placeholders.

Checkout Requirements for the requirements

Type: Map of view and click

Both view and click take a List of Requirements

Optional: true

Example:

requirements:
    view:
        - 
    click:
        -

Checkout next page to create Requirements

Actions

Description: Defines the actions triggered when the button is clicked. Multiple actions can be linked to a single button.

Type: List of actions

Optional: false

Example:

actions:
      - console: "give %player% diamond_sword" # Command ran a the console
      - message: "You have received an epic sword!" # message sent to the player
      - sound: "ITEM_PICKUP" # Sound played
      - player: "say hi" # command ran by player (can also be command:)
      - sound: "ENTITY_EXPERIENCE_ORB_PICKUP"
      - menu: "anothermenu" # Open another menu
      - close # Close the menu