⚙️Item Options

View all the configuration options Item Actions supports for Item Stacks!

Item Configuration

This page outlines all available configuration options for creating custom ItemStacks via the config.

Basic Options

Material: DIAMOND_SWORD # The Bukkit material of the item.
Amount: 1               # Stack size.
Name: "&bEpic Sword"    # Item display name.
Lore:                   # List of strings shown as item lore.
  - "&7Sharp and shiny"
  - "&eUse with care"
Glow: true              # Makes item glow (applies a hidden enchant).
Hide-Tooltip: true      # Hides item tooltip.
Max-Stack-Size: 64      # Custom max stack size.
Model-Data: 123456      # Custom model data (for resource packs).
Item-Model: mypack:katana # Custom item model via namespaced key.
Tooltip-Style: custom:glow # Custom tooltip style via namespaced key.

Material values must match those listed in the Spigot Material enum. They are case-sensitive.

Glow: true adds an UNBREAKING enchantment with a high level and hides it using item flags.


Custom Data

Custom-Data:
  - myplugin:key1:value1
  - myplugin:key2:value2

Sets PersistentDataContainer values on the item using namespaced keys.


Leather Armor Color

Dye-Color: "FF00FF"

Player Head Skins

Skull-Name: Notch
Skull-URL: "http://textures.minecraft.net/texture/..."

Potion Data

Potion-Data:
  Vanilla: true
  Type: HEAL
  Color: "FF0000"
  Duration: 200
  Amplifier: 2

Vanilla: true uses PotionType like POISON, HEAL, etc. When Vanilla is false, custom effects are added using PotionEffectType.


Tipped Arrow

Arrow-Type: POISON

Used for TIPPED_ARROW items. Accepts PotionType.


Enchantments

Enchantments:
  - sharpness:5
  - unbreaking:3

Each entry must be in the format enchant_name:level.

Refer to Enchantment enum for valid names.


Item Flags

Flags:
  - HIDE_ATTRIBUTES
  - HIDE_ENCHANTS

Flags must match the values from the ItemFlag enum.


Equippable Options

Equippable-Options:
  Slot: HEAD
  Model: custompack:helmet
  Camera-Overlay: mypack:overlay
  Equip-Sound: ITEM_ARMOR_EQUIP_LEATHER
  Allowed-Entities:
    - ZOMBIE
    - PLAYER
  Dispensable: true
  Swappable: true
  Damage-On-Hurt: false

Defines EquippableComponent behavior.

Slot uses EquipmentSlot. Equip-Sound uses Sound enum.


Food Options

Food-Options:
  Can-Always-Eat: true
  Nutrition: 5
  Saturation: 2

Modifies the FoodComponent.


Tool Options

Tool-Options:
  Damage-Per-Block: 1
  Rules:
    - STONE:1.0:true
    - DIRT:0.5:false
  Default-Mining-Speed: 2

Customizes the ToolComponent.


Glider

Glider: true

Applies Elytra-style gliding behavior to the item (uses setGlider).


Let us know if you run into any issues with a specific field!

Last updated