⚔️Item Syntaxis

Menu items are defined in the YAML configuration files (punish_menu.yml, punish_details_menu.yml, time_selector_menu.yml, history_menu.yml) under the menu.items (or similar) section.

All YAML text files must be valid for the plugin to work, so check for errors in your changes at https://jsonformatter.org/yaml-validator

Here’s the general syntax for defining a menu item:

menu:
  items:
    <item_key>: # Unique identifier for the item (e.g., ban, mute, info)
      material: <material_name>[:<custom_model_data>] # Minecraft Material enum name (e.g., DIAMOND_SWORD, PLAYER_HEAD). Optional metadata.
      name: <display_name> # Display name of the item (supports color codes and placeholders)
      lore: # Lore of the item (list of strings, supports color codes and placeholders)
        - "<lore_line_1>"
        - "<lore_line_2>"
        - "..."
      player_head: <player_name_or_texture_url> # Optional: Player username or direct texture URL for PLAYER_HEAD material
      quantity: <quantity> # Optional: Item quantity (default: 1)
      slot: <slot_number(s)> # Inventory slot number or comma-separated slots or ranges (e.g., '13', '10,11,12', '20-25')
      left_click_actions: # Actions to perform on left click (list)
        - "<click_action_1>"
        - "<click_action_2>"
        - "..."
      right_click_actions: # Actions to perform on right click (list)
        - "<click_action_1>"
        - "<click_action_2>"
        - "..."

Example Item Configuration:

punish_menu.yml

ban: # Ban punishment item configuration.
      material: 'PLAYER_HEAD'
      player_head: 'http://textures.minecraft.net/texture/55effce109de50f5853b0c32dcc1a28cf62a504b610e71e22f1fde6fc1a4b93d'
      slot: '13' # Slot for the ban item.
      name: '&c&lBan' # Display name for the ban item.
      lore: # Lore for the ban item.
        - '&7Left-Click to ban'
        - '&7player &b{target}&7.'
      left_click_actions: # Actions performed on left click.
        - 'OPEN_MENU:ban_details' # Open menu action. Syntax: 'OPEN_MENU:<menu_key>'
      right_click_actions: # Actions performed on right click.
        - 'OPEN_MENU:ban_details' # Open menu action. Syntax: 'OPEN_MENU:<menu_key>'

punish_details_menu.yml

set_reason: # Set Reason item for Kick
  material: 'BOOK:2' #<material_name>:<custom_model_data>
  slot: '11' # Inventory slot
  name: '&eSet Kick Reason' # Display name
  lore: # Item lore
    - '&fCurrent Reason: &b{reason}' # Placeholder for current reason
    - ''
    - '&7Click to set the'
    - '&7reason for the kick.'
    - ''
  left_click_actions: # Actions on left click.
    - 'PLAY_SOUND:BLOCK_ANVIL_DESTROY:1.0:2.0' # Play sound action. Syntax: 'PLAY_SOUND:<sound_name>:<volume>:<pitch>'
    - 'REQUEST_INPUT:reason_input' # Request text input action. Syntax: 'REQUEST_INPUT:<input_type>'
    - 'TITLE:&c&lWrite the punish reason:&7in the chat:5:20:20' # Display title action. Syntax: 'TITLE:<title>:<subtitle>:<stay>:<fadein>:<fadeout>'
  right_click_actions: # Actions on right click.
    - 'PLAY_SOUND:BLOCK_ANVIL_DESTROY:1.0:2.0' # Play sound action. Syntax: 'PLAY_SOUND:<sound_name>:<volume>:<pitch>'
    - 'REQUEST_INPUT:reason_input' # Request text input action. Syntax: 'REQUEST_INPUT:<input_type>'
    - 'TITLE:&c&lWrite the punish reason:&7in the chat:5:20:20' # Display title action. Syntax: 'TITLE:<title>:<subtitle>:<stay>:<fadein>:<fadeout>'

More examples

kill: # Kill player item configuration.
  material: 'PLAYER_HEAD'
  player_head: 'Herobrine'
  slot: '43' # Slot for the kill player item.
  name: '&2&lKILL PLAYER' # Display name for the kill player item.
  lore: # Lore for the kill player item.
    - '&7Left-Click to sentence'
    - '&7player to &4death&7.'
    - ''
    - '&fRight-Click to &aheal'
  left_click_actions: # Actions performed on left click.
    - 'PLAY_SOUND:ENTITY_WITCH_CELEBRATE:1.0:0.6' # Play sound action. Syntax: 'PLAY_SOUND:<sound_name>:<volume>:<pitch>'
    - 'GIVE_EFFECT_TARGET:WITHER:9999:3:true' # Give effect to target action. Syntax: 'GIVE_EFFECT_TARGET:<effect_type>:<duration_seconds>:<amplifier>:<show_particles(optional)>'
    - 'PLAY_SOUND_TARGET:ENTITY_WITHER_SHOOT:1.0:0.6' # Play sound to target action. Syntax: 'PLAY_SOUND_TARGET:<sound_name>:<volume>:<pitch>'
    - 'TITLE_TARGET:#481358&lYou Have Been Sentenced to Death:&8&nYou will not escape the claws of death.:30:20:20' # Title to target action. Syntax: 'TITLE_TARGET:<title>:<subtitle>:<time_seconds>:<fade_in_ticks>:<fade_out_ticks>'
    - 'MESSAGE:' # Message action. Syntax: 'MESSAGE:<message>'
    - 'MESSAGE:#9feadc&l{target} #481358&lHas Been Sentenced to Death.' # Message action. Syntax: 'MESSAGE:<message>'
    - 'MESSAGE:' # Message action. Syntax: 'MESSAGE:<message>'
  right_click_actions: # Actions performed on right click.
    - 'PLAY_SOUND:ENTITY_PILLAGER_AMBIENT:1.0:0.6' # Play sound action. Syntax: 'PLAY_SOUND:<sound_name>:<volume>:<pitch>'
    - 'CONSOLE_COMMAND:heal {target}' # Console command action. Syntax: 'CONSOLE_COMMAND:<command>'
    - 'TITLE_TARGET:#9feadc&lYou Have Been Blessed:#d8f69c&lWith Forgiveness! &e&nLucky you!:10:20:20' # Title to target action. Syntax: 'TITLE_TARGET:<title>:<subtitle>:<time_seconds>:<fade_in_ticks>:<fade_out_ticks>'
    - 'PLAY_SOUND_TARGET:ENTITY_WITHER_DEATH:1.0:0.6' # Play sound to target action. Syntax: 'PLAY_SOUND_TARGET:<sound_name>:<volume>:<pitch>'
    - 'MESSAGE:' # Message action. Syntax: 'MESSAGE:<message>'
    - 'MESSAGE:#9feadc&l{target} #d8f69c&lHas Been Forgiven.' # Message action. Syntax: 'MESSAGE:<message>'
    - 'MESSAGE:' # Message action. Syntax: 'MESSAGE:<message>'

tp-me: # TP to me item configuration.
  material: 'PLAYER_HEAD'
  player_head: 'http://textures.minecraft.net/texture/54d48ac7e65b91467904f2f4d154556776ffa9cd2d526b12a0499bb59cc656c7'
  slot: '41' # Slot for the tp-me item.
  name: '&e&lTP TO ME' # Display name for the tp-me item.
  lore: # Lore for the tp-me item.
    - '&7Click to TP &b{target}'
    - '&7to your actual location.'
  left_click_actions: # Actions performed on left click.
    - 'PLAYER_COMMAND:tp {target} {player}' # Player command action. Syntax: 'PLAYER_COMMAND:<command>'
    - 'PLAY_SOUND:ITEM_CHORUS_FRUIT_TELEPORT:1.0:0.6' # Play sound action. Syntax: 'PLAY_SOUND:<sound_name>:<volume>:<pitch>'
    - 'PLAY_SOUND_TARGET:ITEM_CHORUS_FRUIT_TELEPORT:1.0:0.6' # Play sound to target action. Syntax: 'PLAY_SOUND_TARGET:<sound_name>:<volume>:<pitch>'
  right_click_actions: # Actions performed on right click.
    - 'PLAYER_COMMAND:tp {target} {player}' # Player command action. Syntax: 'PLAYER_COMMAND:<command>'
    - 'PLAY_SOUND:ITEM_CHORUS_FRUIT_TELEPORT:1.0:0.6' # Play sound action. Syntax: 'PLAY_SOUND:<sound_name>:<volume>:<pitch>'
    - 'PLAY_SOUND_TARGET:ITEM_CHORUS_FRUIT_TELEPORT:1.0:0.6' # Play sound to target action. Syntax: 'PLAY_SOUND_TARGET:<sound_name>:<volume>:<pitch>'

clearinv: # Clear inventory item configuration.
  material: 'PLAYER_HEAD'
  player_head: 'http://textures.minecraft.net/texture/8045743910f23cecff1008ab6adf797d8e6297b2a43c70df572f2e8245697237'
  slot: '42' # Slot for the clear inventory item.
  name: '&4&lCLEAR INVENTORY' # Display name for the clear inventory item.
  lore: # Lore for the clear inventory item.
    - '&7Click to clear'
    - "&7player's &finventory&7."
  left_click_actions: # Actions performed on left click.
    - 'PLAYER_COMMAND_OP:clearinventory {target}' # Player command OP action. Syntax: 'PLAYER_COMMAND_OP:<command>'
    - 'PLAY_SOUND:ENTITY_WITHER_SHOOT:1.0:0.5' # Play sound action. Syntax: 'PLAY_SOUND:<sound_name>:<volume>:<pitch>'
    - 'MESSAGE_TARGET:&c&nYour inventory has been deleted by an administrator.' # Message to target action. Syntax: 'MESSAGE_TARGET:<message>'
  right_click_actions: # Actions performed on right click.
    - 'PLAYER_COMMAND_OP:clearinventory {target}' # Player command OP action. Syntax: 'PLAYER_COMMAND_OP:<command>'
    - 'PLAY_SOUND:ENTITY_WITHER_SHOOT:1.0:0.5' # Play sound action. Syntax: 'PLAY_SOUND:<sound_name>:<volume>:<pitch>'
    - 'MESSAGE_TARGET:&c&nYour inventory has been deleted by an administrator.' # Message to target action. Syntax: 'MESSAGE_TARGET:<message>'