items.yml

Define custom items used by the plugin. This file controls internal item templates (materials, names, lore, enchants, flags, model data) which are referenced across the plugin (classes, GUIs, menus).

Where to find it

Generated after the first server start:

• plugins/Zentrix/items.yml

What you edit here

• Internal item IDs and their properties

• Display names (Hex &#RRGGBB and legacy & codes)

• Lore lines shown in GUIs

• Enchantments, custom model data, amount, slot

• Item flags and glow/unbreakable toggles

Use these internal item IDs (e.g., warrior-sword) in other config files like classes.yml as id: "custom:warrior-sword".

---

Introduction

items.yml is the canonical list of internal, reusable item definitions. Instead of repeating the same item properties in multiple files, reference a single item key from here. This keeps kits, menus, and GUIs consistent and easy to update.

---

File structure

Each item is a top-level key with the following typical properties:

<item-key>:
  material: <Bukkit_MATERIAL | "itemsadder:namespace:id" | "nexo:id">
  display-name: "<string>"
  lore:
    - "<line1>"
    - "<line2>"
  custom-model-data: <integer>
  amount: <1-64>
  slot: <0-8>
  glow: <true|false>
  unbreakable: <true|false>
  enchantments:
    - "NAME:LEVEL"
  flags:
    - HIDE_ATTRIBUTES
    - HIDE_ENCHANTS
    # ...

---

Configuration fields

material

The base item source.

• Vanilla: Bukkit material enum (e.g., IRON_SWORD, BARRIER, KNOWLEDGE_BOOK)

• ItemsAdder: itemsadder:namespace:id

• Nexo: nexo:id

Wrap ItemsAdder/Nexo values in quotes because they contain :.

material: IRON_SWORD

material: "itemsadder:myitems:custom_sword"

material: "nexo:battle_axe"

display-name

Item name shown in GUIs and inventories. Supports Hex and legacy color codes.

display-name: "&#FF5555&l•&r &7ᴡᴀʀʀɪᴏʀ'ꜱ ꜱᴡᴏʀᴅ"

lore

Array of strings shown under the item name. Use these for descriptive GUI text and brief usage hints.

lore:
  - "&r"
  - "&#FF5555ᴅᴇꜱᴄʀɪᴘᴛɪᴏɴ"
  - "  &7ꜱᴡᴏʀᴅ ᴏꜰ ᴀ ᴛʀᴜᴇ ᴡᴀʀʀɪᴏʀ."

custom-model-data

Integer used by resource packs to swap models.

custom-model-data: 0

amount

Stack size when given (1–64).

amount: 1

slot

Preferred inventory slot (0–8 for hotbar). Not all systems will enforce this.

slot: 8

glow & unbreakable

Visual/enchant behavior.

glow: true
unbreakable: false

enchantments

List of enchantments in "name:level" format (lower/upper case accepted).

enchantments:
  - "sharpness:1"
  - "looting:1"

flags

Hide UI attributes from the item tooltip (HIDE_ENCHANTS, HIDE_ATTRIBUTES, HIDE_UNBREAKABLE, HIDE_ADDITIONAL_TOOLTIP, etc.).

flags:
  - HIDE_ATTRIBUTES
  - HIDE_ENCHANTS

---

External plugins & referencing

You have two clean ways to use ItemsAdder/Nexo items:

1. Reference them directly where used (recommended for one-offs):

   • material: "itemsadder:namespace:id"

   • material: "nexo:id"

2. Or define a reusable internal key here, using material: "itemsadder:..." / material: "nexo:...", then reference it elsewhere as material: "custom:<item-key>".

If you’re reusing the same external item in many places, define it once in items.yml. Then reference it via custom:<item-key>. This keeps naming/lore/flags consistent.

---

Example breakdown: Leave Game item

This entry shows a typical GUI item with slot, lore, and flags.

leave-game:
  material: BARRIER
  display-name: "&#FF5555&l•&r &7ʟᴇᴀᴠᴇ ɢᴀᴍᴇ"
  lore:
    - "&r"
    - "&#FF5555ᴅᴇꜱᴄʀɪᴘᴛɪᴏɴ"
    - "  &7ʟᴇᴀᴠᴇ ᴛʜᴇ ᴄᴜʀʀᴇɴᴛ ɢᴀᴍᴇ ᴀɴᴅ"
    - "  &7ʀᴇᴛᴜʀɴ ᴛᴏ ᴛʜᴇ ʟᴏʙʙʏ."
    - "&r"
    - "&#FF5555&l| &r&7ʀɪɢʜᴛ-ᴄʟɪᴄᴋ ᴛᴏ ʟᴇᴀᴠᴇ"
  custom-model-data: 0
  amount: 1
  slot: 8
  glow: false
  unbreakable: false
  flags:
    - HIDE_ATTRIBUTES
    - HIDE_ADDITIONAL_TOOLTIP

What this config does:

• Uses BARRIER as the base material so it stands out.

• Places the item in hotbar slot 8.

• Hides attributes to keep tooltip clean.

---

Example breakdown: Warrior sword

This is a kit item referenced by classes.yml as id: "custom:warrior-sword".

warrior-sword:
  material: IRON_SWORD
  display-name: "&#FF5555&l•&r &7ᴡᴀʀʀɪᴏʀ'ꜱ ꜱᴡᴏʀᴅ"
  lore:
    - "&r"
    - "&#FF5555ᴅᴇꜱᴄʀɪᴘᴛɪᴏɴ"
    - "  &7ꜱᴡᴏʀᴅ ᴏꜰ ᴀ ᴛʀᴜᴇ ᴡᴀʀʀɪᴏʀ."
    - "&r"
    - "&#FF5555ᴇɴᴄʜᴀɴᴛᴍᴇɴᴛꜱ"
    - "  &7ꜱʜᴀʀᴘɴᴇꜱꜱ &#FF5555➟ &7ɪɪ"
  enchantments:
    - "sharpness:1"
  flags:
    - HIDE_ATTRIBUTES
    - HIDE_ENCHANTS
    - HIDE_ADDITIONAL_TOOLTIP

What this config does:

• Defines a reusable sword with an enchantment and compact tooltip.

• Referenced in kits to ensure consistent naming and lore across the plugin.

---

Full configuration

Expand: default items.yml

# -----------------------------------------------------------------------------
# Zentrix Battle Royale - Items Configuration
# Developed by Harsh
# -----------------------------------------------------------------------------

# =============================================================================
# ITEM CONFIGURATION REFERENCE
# =============================================================================
# This file defines custom items used by the plugin.
#
# MATERIAL FORMATS:
#   material: DIAMOND_SWORD              Vanilla Bukkit Material
#   material: "itemsadder:namespace:id"  ItemsAdder custom item
#   material: "nexo:item_id"             Nexo custom item
#
# PROPERTY GUIDE:
#   material:           Required. Bukkit Material OR external item reference.
#   display-name:       Item name supporting Hex (&#RRGGBB) and Legacy (&c) colors.
#   lore:               List of description lines.
#   custom-model-data:  Integer for resource packs.
#   amount:             Stack size (1-64).
#   slot:               Inventory slot (0-8 for hotbar).
#   glow:               Set to true to add enchantment glint without actual enchants.
#   unbreakable:        Set to true to make the item unbreakable.
#
#   enchantments:       List format: "NAME:LEVEL" (e.g., "sharpness:5").
#
#   flags:              Hide specific attributes from the item tooltip.
#                       (HIDE_ENCHANTS, HIDE_ATTRIBUTES, HIDE_UNBREAKABLE, etc.)
#
# EXTERNAL ITEM BEHAVIOR:
#   When using ItemsAdder or Nexo items:
#   - If no metadata is configured, the external item's default metadata is used.
#   - You can override specific properties (display-name, lore, enchantments, etc.)
#     and the rest will be preserved from the original external item.
#
# EXAMPLES:
#   # Use ItemsAdder item with default metadata
#   my-custom-sword:
#     material: "itemsadder:mynamespace:epic_sword"
#
#   # Use Nexo item with custom display name (other properties from Nexo)
#   my-nexo-item:
#     material: "nexo:legendary_axe"
#     display-name: "&#FF5555Renamed Axe"
#
#   # Vanilla item with full configuration
#   vanilla-item:
#     material: DIAMOND_SWORD
#     display-name: "&#55FFFFMy Sword"
#     enchantments:
#       - "sharpness:5"

# =============================================================================
# LOBBY & GAME MANAGEMENT ITEMS
# =============================================================================

# Leave Game Item
# Given to players in the waiting lobby and to spectators.
# Action: Removes the player from the current game.
leave-game:
  material: BARRIER
  display-name: "&#FF5555&l•&r &7ʟᴇᴀᴠᴇ ɢᴀᴍᴇ"
  lore:
    - "&r"
    - "&#FF5555ᴅᴇꜱᴄʀɪᴘᴛɪᴏɴ"
    - "  &7ʟᴇᴀᴠᴇ ᴛʜᴇ ᴄᴜʀʀᴇɴᴛ ɢᴀᴍᴇ ᴀɴᴅ"
    - "  &7ʀᴇᴛᴜʀɴ ᴛᴏ ᴛʜᴇ ʟᴏʙʙʏ."
    - "&r"
    - "&#FF5555&l| &r&7ʀɪɢʜᴛ-ᴄʟɪᴄᴋ ᴛᴏ ʟᴇᴀᴠᴇ"
  custom-model-data: 0
  amount: 1
  slot: 8
  glow: false
  unbreakable: false
  flags:
    - HIDE_ATTRIBUTES
    - HIDE_ADDITIONAL_TOOLTIP

# Recipes Book
# Opens the recipe browser GUI.
# Locked in inventory during lobby, waiting, and starting states.
recipes-book:
  enabled: true
  material: KNOWLEDGE_BOOK
  display-name: "&#FFD700&l•&r &7ʀᴇᴄɪᴘᴇꜱ"
  lore:
    - "&r"
    - "&#FFD700ᴅᴇꜱᴄʀɪᴘᴛɪᴏɴ"
    - "  &7ᴠɪᴇᴡ ᴀʟʟ ᴀᴠᴀɪʟᴀʙʟᴇ ᴄʀᴀꜰᴛɪɴɢ"
    - "  &7ʀᴇᴄɪᴘᴇꜱ ꜰᴏʀ ᴛʜᴇ ɢᴀᴍᴇ."
    - "&r"
    - "&#FFD700&l| &r&7ᴄʟɪᴄᴋ ᴛᴏ ʙʀᴏᴡꜱᴇ"
  custom-model-data: 0
  amount: 1
  slot: 0
  glow: true
  unbreakable: false
  flags:
    - HIDE_ATTRIBUTES
    - HIDE_ENCHANTS
    - HIDE_ADDITIONAL_TOOLTIP

# Class Picker
# Opens the class selection GUI.
# Given to players in the waiting lobby.
class-picker:
  material: NETHER_STAR
  display-name: "&#AA55FF&l•&r &7ꜱᴇʟᴇᴄᴛ ᴄʟᴀꜱꜱ"
  lore:
    - "&r"
    - "&#AA55FFᴅᴇꜱᴄʀɪᴘᴛɪᴏɴ"
    - "  &7ᴄʜᴏᴏꜱᴇ ʏᴏᴜʀ ʙᴀᴛᴛʟᴇ ᴄʟᴀꜱꜱ."
    - "  &7ᴇᴀᴄʜ ᴄʟᴀꜱꜱ ʜᴀꜱ ᴜɴɪǫᴜᴇ ᴀʙɪʟɪᴛɪᴇꜱ."
    - "&r"
    - "&#AA55FF&l| &r&7ᴄʟɪᴄᴋ ᴛᴏ ꜱᴇʟᴇᴄᴛ"
  custom-model-data: 0
  amount: 1
  slot: 4
  glow: true
  unbreakable: false
  flags:
    - HIDE_ATTRIBUTES
    - HIDE_ENCHANTS
    - HIDE_ADDITIONAL_TOOLTIP

# =============================================================================
# CLASS KIT ITEMS
# =============================================================================
# These items are referenced in 'classes.yml' by their ID (e.g., "custom:warrior-sword").

# Warrior Class
warrior-sword:
  material: IRON_SWORD
  display-name: "&#FF5555&l•&r &7ᴡᴀʀʀɪᴏʀ'ꜱ ꜱᴡᴏʀᴅ"
  lore:
    - "&r"
    - "&#FF5555ᴅᴇꜱᴄʀɪᴘᴛɪᴏɴ"
    - "  &7ꜱᴡᴏʀᴅ ᴏꜰ ᴀ ᴛʀᴜᴇ ᴡᴀʀʀɪᴏʀ."
    - "&r"
    - "&#FF5555ᴇɴᴄʜᴀɴᴛᴍᴇɴᴛꜱ"
    - "  &7ꜱʜᴀʀᴘɴᴇꜱꜱ &#FF5555➟ &7ɪɪ"
  enchantments:
    - "sharpness:1"
  flags:
    - HIDE_ATTRIBUTES
    - HIDE_ENCHANTS
    - HIDE_ADDITIONAL_TOOLTIP

# Archer Class
archer-bow:
  material: BOW
  display-name: "&#55FF55&l•&r &7ᴀʀᴄʜᴇʀ'ꜱ ʙᴏᴡ"
  lore:
    - "&r"
    - "&#55FF55ᴅᴇꜱᴄʀɪᴘᴛɪᴏɴ"
    - "  &7ᴀ ᴘʀᴇᴄɪꜱᴇ ɪɴꜱᴛʀᴜᴍᴇɴᴛ ᴏꜰ ᴡᴀʀ."
    - "&r"
    - "&#55FF55ᴇɴᴄʜᴀɴᴛᴍᴇɴᴛꜱ"
    - "  &7ᴘᴏᴡᴇʀ &#55FF55➟ &7ɪ"
  enchantments:
    - "power:1"
  flags:
    - HIDE_ATTRIBUTES
    - HIDE_ENCHANTS
    - HIDE_ADDITIONAL_TOOLTIP

# Looter Class
looter-dagger:
  material: IRON_SWORD
  display-name: "&#FFD700&l•&r &7ʟᴏᴏᴛᴇʀ'ꜱ ᴅᴀɢɢᴇʀ"
  lore:
    - "&r"
    - "&#FFD700ᴅᴇꜱᴄʀɪᴘᴛɪᴏɴ"
    - "  &7ᴘᴇʀꜰᴇᴄᴛ ꜰᴏʀ ꜰɪɴᴅɪɴɢ ᴠᴀʟᴜᴀʙʟᴇꜱ."
    - "&r"
    - "&#FFD700ᴇɴᴄʜᴀɴᴛᴍᴇɴᴛꜱ"
    - "  &7ꜱʜᴀʀᴘɴᴇꜱꜱ &#FFD700➟ &7ɪ"
    - "  &7ʟᴏᴏᴛɪɴɢ &#FFD700➟ &7ɪ"
  enchantments:
    - "sharpness:1"
    - "looting:1"
  flags:
    - HIDE_ATTRIBUTES
    - HIDE_ENCHANTS
    - HIDE_ADDITIONAL_TOOLTIP

# Trapper Class
trapper-shovel:
  material: STONE_SHOVEL
  display-name: "&#AA55FF&l•&r &7ᴛʀᴀᴘᴘᴇʀ'ꜱ ꜱʜᴏᴠᴇʟ"
  lore:
    - "&r"
    - "&#AA55FFᴅᴇꜱᴄʀɪᴘᴛɪᴏɴ"
    - "  &7ᴘᴇʀꜰᴇᴄᴛ ꜰᴏʀ ᴅɪɢɢɪɴɢ ᴛʀᴀᴘꜱ."
    - "&r"
    - "&#AA55FFᴇɴᴄʜᴀɴᴛᴍᴇɴᴛꜱ"
    - "  &7ᴇꜰꜰɪᴄɪᴇɴᴄʏ &#AA55FF➟ &7ɪᴠ"
    - "  &7ᴜɴʙʀᴇᴀᴋɪɴɢ &#AA55FF➟ &7ɪ"
  enchantments:
    - "efficiency:4"
    - "unbreaking:1"
  flags:
    - HIDE_ATTRIBUTES
    - HIDE_ENCHANTS
    - HIDE_ADDITIONAL_TOOLTIP

# Fisherman Class
fisherman-rod:
  material: FISHING_ROD
  display-name: "&#55FFFF&l•&r &7ꜰɪꜱʜᴇʀᴍᴀɴ'ꜱ ʀᴏᴅ"
  lore:
    - "&r"
    - "&#55FFFFᴅᴇꜱᴄʀɪᴘᴛɪᴏɴ"
    - "  &7ᴘᴜʟʟ ɪɴ ᴛʜᴇ ʀᴀʀᴇꜱᴛ ᴄᴀᴛᴄʜᴇꜱ."
    - "&r"
    - "&#55FFFFᴇɴᴄʜᴀɴᴛᴍᴇɴᴛꜱ"
    - "  &7ʟᴜʀᴇ &#55FFFF➟ &7ɪɪ"
    - "  &7ʟᴜᴄᴋ ᴏꜰ ᴛʜᴇ ꜱᴇᴀ &#55FFFF➟ &7ɪɪɪ"
    - "  &7ᴜɴʙʀᴇᴀᴋɪɴɢ &#55FFFF➟ &7ɪɪ"
  enchantments:
    - "lure:2"
    - "luck_of_the_sea:3"
    - "unbreaking:2"
  flags:
    - HIDE_ATTRIBUTES
    - HIDE_ENCHANTS
    - HIDE_ADDITIONAL_TOOLTIP

# Miner Class
miner-pickaxe:
  material: IRON_PICKAXE
  display-name: "&#FFAA00&l•&r &7ᴍɪɴᴇʀ'ꜱ ᴘɪᴄᴋᴀxᴇ"
  lore:
    - "&r"
    - "&#FFAA00ᴅᴇꜱᴄʀɪᴘᴛɪᴏɴ"
    - "  &7ᴛʀᴜꜱᴛ ᴄᴏᴍᴘᴀɴɪᴏɴ ᴏꜰ ᴍɪɴᴇʀꜱ."
    - "&r"
    - "&#FFAA00ᴇɴᴄʜᴀɴᴛᴍᴇɴᴛꜱ"
    - "  &7ᴇꜰꜰɪᴄɪᴇɴᴄʏ &#FFAA00➟ &7ɪ"
    - "  &7ᴜɴʙʀᴇᴀᴋɪɴɢ &#FFAA00➟ &7ɪ"
  enchantments:
    - "efficiency:1"
    - "unbreaking:1"
  flags:
    - HIDE_ATTRIBUTES
    - HIDE_ENCHANTS
    - HIDE_ADDITIONAL_TOOLTIP

# =============================================================================
# EXAMPLES (Inactive)
# =============================================================================
# Add additional custom items below.
# These can be accessed via ItemsManager.getItem("item-key").

# Example: Spectator Compass
# spectator-compass:
#   material: COMPASS
#   display-name: "&#55FF55⟳ &#AAFFAAPlayer Teleporter"
#   lore:
#     - ""
#     - "&#AAAAAA◆ Right-click to open player menu"
#     - "&#AAAAAA◆ Teleport to alive players"
#     - ""
#   custom-model-data: 0
#   slot: 0
#   glow: true
#   flags:
#     - HIDE_ATTRIBUTES