Skip to main content

Items

Items are listed under the items: section in a panel YAML file. Each item can be configured to control its appearance, behavior, logic, and interaction with players. This page explains all configuration options related to items.


Adding an Item​

Items are referenced by name and assigned in the items: section of the panel. The item names assigned to each item can be used in the separate slots section of the panel.


Material​

Defines the material of the item. Using custom values on items as seen below is also supported, which behaves similar to the Minecraft /give command.

Examples:

material: 'IRON_INGOT'
material: 'diamond_axe[enchantment_glint_override=true]'
material: '[head] %player_name%'

Supported Material Tags​

TagDescription
[head]Used for player heads. Use [head] <base64> for custom heads, or [head] <playerName> to get a players head from username.
[hdb]Head Database integration. Use a head number from Head Database
[craftengine]Uses CraftEngine custom items, e.g., [craftengine] default:bench.
[nexo]Uses Nexo custom items, e.g., [nexo] crystal_shard.
[itemsadder]Uses ItemsAdder items, e.g., [itemsadder] money:coin.
[mmo]Uses MMOItems, e.g., [mmo] SWORD flame_blade.
tip

The [head] base64 method is the recommended approach to get custom textures on player heads.

Using [head] username for players that are offline will run in a queue to get and cache textures from the Mojang api, and can be unreliable if Mojang times out requests.


Item Attributes​

By default attributes are hidden, to show them add and set attributes to true

attributes: true

Item Tooltip​

By default tooltips are shown, to hide them add and set tooltip to false

tooltip: false

Item Tooltip Style​

Assign a custom tooltip style

tooltip-style: '[style]'

Item Name​

Set a custom display name for the item.
Example:

name: '&aSurvival'

Item Stack​

Defines the amount of items shown in the stack.
Example:

stack: 1

Glint Override​

Force enchantment glint on or off. This will override whether or not items actually have enchantments. Remove this value for no override, false will override by removing glint, and true will force the glint to be shown.

Example:

glint-override: true

Enchantments​

Apply enchantments which will make the item glow. Namespaces can be added to the front like the example below.

To add enchantments:

enchantments:
- 'KNOCKBACK 2'
- 'minecraft:SHARPNESS 4'

Animations​

Used for animations, see the configuration page for more information on how animations work.

Example:

animate: 'item2'

Item Model​

Sets the ItemModel of the item.
Example:

item-model: 'template:sword'

Custom Model Data​

Sets the CustomModelData of the item. Example:

custom-model-data: '60254'

Item Damage​

Sets the durability damage value. Use -1 for an unbreakable item.
Example:

damage: 10

Leather Color​

Applies RGB values to leather items.

Examples:

leather-color: 136,0,255

Armour Trim​

Adds armor trims using a pattern and material name.

Example:

armor-trim: 'EMERALD COAST'

Format:

armor-trim: '[Material] [Pattern]'

Potion Effects​

Applies potion effect visuals. Supported for potion items and tipped arrows.

Example:

potion: 'STRONG_HEALING'

Change the color (RGB):

potion-color: '4,23,54'

Item Lore​

Multiline descriptions for the item.

lore:  
- '&2Heal Yourself and'
- '&2change gamemode to survival.'

Custom Banners​

Define custom banners using material and a list of patterns.

Example:

material: 'RED_BANNER' 
banner:
- 'WHITE,STRIPE_MIDDLE'
- 'BLACK,SKULL'

Use valid PatternTypes from Paper API. Order matters — top to bottom.