Skip to main content

🔢 Properties

Overview​

Properties define an item's built-in metadata in Oraxen, such as its material, display name, lore, flags, enchantments, and other vanilla item data.

Configuration​

Properties are configured per item in .yml files inside the plugins/Oraxen/items directory.

  • 📁 plugins
    • 📁 Oraxen
      • 📁 items
        • 📄 weapons.yml
        • 📄 furniture.yml
my_item:
  material: PAPER
  itemname: "Cool Item"

Properties​

🪨 material

Sets the base material of the item.

myitem:
  material: PAPER

Materials
A full list of supported materials can be found here.

🏷️ itemname

Sets the item's display name using MiniMessage formatting.

myitem:
  itemname: "<red>My Cool Item"
info

itemname is the recommended property for 1.20.5+.

🏷️ displayname

Sets the legacy display name.

myitem:
  displayname: "<red>My Cool Item"
warning

displayname is deprecated. Prefer using itemname instead.

🏷️ customname

Sets the item's custom name on 1.20.5+. This sets the display name component, distinct from itemname which sets the item_name component.

myitem:
  customname: "<red>My Cool Item"
📜 lore

Sets the item's lore lines.

myitem:
  lore:
    - "<gold>My Cool Item"
    - "<gray>Some extra description"
🔨 unbreakable

Makes the item unbreakable.

myitem:
  unbreakable: true
📦 unstackable

Makes the item impossible to stack with identical copies.

myitem:
  unstackable: true
🆔 injectId

Controls whether Oraxen injects the item ID into NBT.

myitem:
  injectId: true
🎨 color

Sets an RGB color for supported items such as leather armor, potions, or maps.

myitem:
  color: "#FF8000"
myitem:
  color: "255, 128, 0"

Accepted formats
#RRGGBB or R, G, B

🛡️ trim_pattern

Sets the armor trim pattern key.

myitem:
  trim_pattern: "minecraft:coast"

Patterns
A full list of supported trim patterns can be found here.

🧬 template

Makes the item inherit from another item template.

myitem:
  template: base_sword

Defining a template
When template is the boolean true, the section becomes a reusable template and is excluded from the item registry.

base_sword:
  template: true
  material: IRON_SWORD
🙈 excludeFromInventory

Excludes the item from the /oraxen inventory menu.

myitem:
  excludeFromInventory: true
⌨️ excludeFromCommands

Excludes the item from /oraxen give autocomplete and similar command suggestions.

myitem:
  excludeFromCommands: true
🔄 no_auto_update

Disables automatic updating for the item.

myitem:
  no_auto_update: true
✨ enchantable

Controls whether the item can be enchanted. Defaults to true; set it to false to prevent enchanting.

myitem:
  enchantable: false
✨ glowing

Gives the dropped item a colored outline on Minecraft 1.21.4+.

myitem:
  material: DIAMOND
  glowing: red

Use a named color. Supported colors are black, dark_blue, dark_green, dark_aqua, dark_red, dark_purple, gold, gray, dark_gray, blue, green, aqua, red, light_purple, yellow, or white. Omit glowing to leave the outline disabled. This affects dropped items.

🛡️ invulnerable

Protects dropped items from selected damage causes.

myitem:
  material: DIAMOND
  invulnerable:
    - lava
    - fire
    - fire_tick
    - contact # Cactus
    - block_explosion # Respawn anchor
    - entity_explosion # Creeper and TNT
    - lightning
🚩 ItemFlags

Applies item flags to hide parts of the tooltip.

myitem:
  ItemFlags:
    - HIDE_ENCHANTS
    - HIDE_ATTRIBUTES
    - HIDE_UNBREAKABLE

Flags
A full list of supported flags can be found here.

✨ Enchantments

Adds enchantments directly to the item.

myitem:
  Enchantments:
    sharpness: 5
    unbreaking: 3

Enchantments
A full list of supported enchantments can be found here.

Level
Each enchantment is defined with a level. (min. 1)

📈 AttributeModifiers

Adds attribute modifiers to the item.

emerald_helmet:
  material: PAPER
  AttributeModifiers:
    armor:
      attribute: ARMOR
      amount: 3
      operation: ADD_NUMBER
      slot: HEAD
    toughness:
      attribute: ARMOR_TOUGHNESS
      amount: 2
      operation: ADD_NUMBER
      slot: HEAD
    health_boost:
      attribute: MAX_HEALTH
      amount: 4
      operation: ADD_NUMBER
      slot: HEAD
important

Only attribute and amount are required.

Attributes
A full list of supported attributes can be found here.

Operations

  • ADD_NUMBER Default
  • ADD_SCALAR
  • MULTIPLY_SCALAR_1

Slot groups

  • HAND (alias for MAINHAND)
  • MAINHAND
  • OFFHAND
  • HEAD
  • CHEST
  • LEGS
  • FEET
  • BODY
  • SADDLE
  • ARMOR
  • ANY

Unrecognized values silently fall back to ANY.

important

Requires Minecraft 1.20.5+ for "modern" format attributes.

info

The legacy list format (AttributeModifiers: [{...}]) still works. If Oraxen detects a section format, it uses the modern parser. If it finds a list, it falls back to the legacy format. Both formats can coexist across different items. In the list format, operation is numeric (0 = ADD_NUMBER, 1 = ADD_SCALAR, 2 = MULTIPLY_SCALAR_1). String operation names only work in the section format.

👁️ DisplayModes

Display modes can control how each modifier appears in item tooltips. display parses only type and text.

AttributeModifiers:
  hidden_armor:
    attribute: ARMOR
    amount: 5
    operation: ADD_NUMBER
    slot: CHEST
    display:
      type: hidden  # Completely hide from tooltip
AttributeModifiers:
  fire_damage:
    attribute: ATTACK_DAMAGE
    amount: 10
    operation: ADD_NUMBER
    slot: MAINHAND
    display:
      type: override
      text: "<red>+10 Fire Damage"  # Custom MiniMessage tooltip text

Display types

  • hidden (hide tooltip line)
  • reset or default (use vanilla tooltip line)
  • override or custom (replace tooltip line with display.text)
important

Requires Minecraft 1.21.6+.

🧪 PotionEffects

Adds potion effects to potion-like items.

myitem:
  PotionEffects:
    - type: speed
      duration: 200
      amplifier: 1
      ambient: false
      particles: true
      icon: true

Potion Effects
A full list of supported potion effects can be found here.

🏷️ PersistentData

Stores custom persistent data on the item.

myitem:
  PersistentData:
    - key: "myplugin:custom_value"
      type: STRING
      value: "hello"

Example​

myitem:
  material: DIAMOND_SWORD
  itemname: "<gradient:red:gold>Flame Blade"
  lore:
    - "<gray>A weapon forged in heat"
    - "<red>Very dangerous"
  unbreakable: true
  unstackable: true
  injectId: true
  excludeFromInventory: false
  excludeFromCommands: false
  no_auto_update: false
  enchantable: true
  ItemFlags:
    - HIDE_ATTRIBUTES
    - HIDE_UNBREAKABLE
  Enchantments:
    sharpness: 5
    fire_aspect: 2
    unbreaking: 3
  AttributeModifiers:
    - attribute: attack_damage
      amount: 7
      operation: 0 # 0 = ADD_NUMBER, 1 = ADD_SCALAR, 2 = MULTIPLY_SCALAR_1
      slot: HAND
      name: "flame_blade_damage"