🪁Items

Before you start configuring the plugin itemstack, make sure you are using the correct material for your version of the game. Each button must be accompanied by an itemstack (except in certain specific cases).

`material`

material: <material>

Type

Format / Example

Material (Bukkit)

material: STONE

PlaceholderAPI

material: %your_placeholder_material%

Armor (slot)

material: "armor:<slot>" (e.g. HEAD, CHEST, LEGS, FEET)

zHead (FREE)

material: "zhd:<id>"

MagicCosmetics (PAID)

material: "magic_cosmetics:<HAT/BAG/WALKING_STICK/BALLOON/SPRAY>"

Hmccosmetics (PAID)

material: "hmc_cosmetics:<type>" or material: "hmc_cosmetics:<type>-<player name>"

zItems (PAID)

material: "zitems:<id>"

HeadDatabase (PAID)

material: "hdb:<id>"

Oraxen (PAID)

material: "oraxen:<item name>"

ItemsAdder (PAID)

material: "itemsadder:<item name>"

SlimeFun (FREE)

material: "slimefun:<item name>"

Nova (FREE)

material: "nova:<item/block name>"

Base64

material: "base64:<item in base64>"

PlayerHead

material: "playerHead:<player name>" or material: "playerHead:%player%"

CraftEngine

material: "craftengine:<item id>"

Executable Items

material: "ei:<item id>"

Executable Blocks

material: "eb:<block id>"

`amount`

amount: <amount>

The amount of the itemstack. You can use a placeholder to have a dynamic amount.

`data`

data: <data, only avaible between 1.8 and 1.12>

The material data. By default, it's 0.

Only available for versions between 1.8 and 1.12

`durability`

durability: <durability>

The durability of the item, by default, is 0.

`url`

url: <player skin in base64>

Allows you to display a head with a URL in base64. You can find the values of the heads on the site minecraft-head.com.

You must take the content in the "Value" field under the "Other" category.

Example

url: "eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvNjM3YjhhMzk4MzdiYzNkNThmMDljOGM2ZTUzOTYyZDMzZjlmYTBiNjUzOThhNzc5MzUzYWRlMWUxNDcxM2VmZiJ9fX0="

`name`

name: <display name>

The name that will be displayed on the item. You can use PlaceholderAPI to make the name dynamic.

If your server has Kyori Adventure, you can use the mini message format.

`lore`

lore:
  - <line1>
  - <line2>
  - <line3>
  - ...

Allows you to display the lore of the item. You can use PlaceholderAPI to make the lore dynamic.

`lore-type`

lore-type: REPLACE

Defines how the lore is used. REPLACE, by default, replaces the item's lore. APPEND, adds the new lore after the existing lore. PREPEND, adds the new lore before the existing lore.

`potion`

  potion: <potion effect type>
  level: <potion level, 1 or 2> # 1 by default
  splash: <potion splash true or false>
  extended: <potion extended true of flase>
  arrow: <potion arrow true or false> # false by default, true for arrow with potion effect

Allows you to create a potion. Check potion effect types here for more details.

Warning: A potion cannot be extended and have a level 2 at the same time.

# For potions in 1.8 up to 1.12 you have to do like this:
material: POTION
durability: 16454

`glow`

glow: <true of false>

Allows the item to shine. Add random enchant and HIDE_ENCHANT itemflag.

`model-id`

model-id: <custom model id>

Allows you to put a custom model id on the item.

`enchantments`

enchants:
  - <enchantment name>,<enchantment level>

Allows you to add enchantments. You need to specify the name of the enchantment followed by the level of the enchantment, in the format: ENCHANT,ENCHANT_LEVEL.

List of enchantments

Enchantment

Aliases

damage_all

alldamage, alldmg, sharpness, sharp, dal

damage_arthropods

ardmg, baneofarthropods, baneofarthropod, arthropod, dar

damage_undead

undeaddamage, smite, du

dig_speed

digspeed, efficiency, minespeed, cutspeed, ds, eff

durability

durability, dura, unbreaking, d

thorns

thorns, highcrit, thorn, highercrit, t

fire_aspect

fireaspect, fire, meleefire, meleeflame, fa

knockback

knockback, kback, kb, k

loot_bonus_blocks

blockslootbonus, fortune, fort, lbb

loot_bonus_mobs

mobslootbonus, mobloot, looting, lbm

oxygen

oxygen, respiration, breathing, breath, o

protection_environmental

protection, prot, protect, p

protection_explosions

explosionsprotection, explosionprotection, expprot, blastprotection, bprotection, bprotect, blastprotect, pe

protection_fall

fallprotection, fallprot, featherfall, featherfalling, pfa

protection_fire

fireprotection, flameprotection, fireprotect, flameprotect, fireprot, flameprot, pf

protection_projectile

projectileprotection, projprot, pp

silk_touch

silktouch, softtouch, st

water_worker

waterworker, aquaaffinity, watermine, ww

arrow_fire

firearrow, flame, flamearrow, af

arrow_damage

arrowdamage, power, arrowpower, ad

arrow_knockback

arrowknockback, arrowkb, punch, arrowpunch, ak

arrow_infinite

infinitearrows, infarrows, infinity, infinite, unlimited, unlimitedarrows, ai

luck

luck, luckofsea, luckofseas, rodluck

lure

lure, rodlure

depth_strider

depthstrider, depth, strider

frost_walker

frostwalker, frost, walker

mending

binding_curse

bindingcurse, bindcurse, binding, bind

vanishing_curse

vanishingcurse, vanishcurse, vanishing, vanish

sweeping_edge

sweepingedge, sweepedge, sweeping

loyalty

loyalty, loyal, return

impaling

impaling, impale, oceandamage, oceandmg

riptide

riptide, rip, tide, launch

channeling

channelling, chanelling, channeling, chaneling, channel

multishot

multishot, tripleshot

quick_charge

quickcharge, quickdraw, fastcharge, fastdraw

piercing

soul_speed

soulspeed, soilspeed, sandspeed

swift_sneak

swiftsneak

breach

density

wind_burst

windburst, wind, burst

`flags`

flags:
  - <flag 1>
  - <flag 2>
  - ...

List of flags: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/inventory/ItemFlag.html

`color`

type: LEATHER_CHESTPLATE
color: 40,150,40 # RGB color

# Example with ARGB
color: 1,40,150,40 # ARGB color, Alpha, RED, GREEN, BLUE

Set the RGB color (Red, Green, Blue) for leather armor. The format is as follows:

<Red>,<Green>,<Blue>

For example, to set a color with 255 red, 100 green, and 50 blue, you would use:

255,100,50

color: <red>,<green>,<blue>

You can also add an alpha value in the color to have ARGB (Alpha, Red, Green, Blue). The format is as follows:

<Alpha>,<Red>,<Green>,<Blue>

For example, to set a color with 128 alpha (semi-transparent), 255 red, 100 green, and 50 blue, you would use:

128,255,100,50

color: <alpha>,<red>,<green>,blue>

The color format for fireworks, banners, and potions follows the same ARGB format:

<Alpha>,<Red>,<Green>,<Blue>

For example:

Fireworks: To set a color with 255 alpha (fully opaque), 200 red, 150 green, and 100 blue, you would use: 255,200,150,100.
Banners: To set a color with 255 alpha, 100 red, 200 green, and 50 blue, you would use: 255,100,200,50.
Potions: To set a color with 128 alpha (semi-transparent), 255 red, 50 green, and 50 blue, you would use: 128,255,50,50.

For further details, check the Javadocs for Color here.

`firework`

type: FIREWORK
firework:
  star: true
  flicker: true
  trail: true
  type: BALL_LARGE
  colors:
    - 250,10,10 # RGB and ARGB
  fadeColors:
    - 250,10,250 # RGB and ARGB

Firework type: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/FireworkEffect.Type.html

`banner`

type: BANNER
banner: PINK # Banner color
patterns: # Banner pattern: <color>:<pattern>
  - RED:SQUARE_BOTTOM_LEFT
  - GREEN:STRIPE_LEFT

Allows you to create a banner. Pattern list: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/block/banner/PatternType.html

`translated-name`

Allows to translate the name of the item in several languages

items:
  example:
    item:
      material: GRASS_BLOCK
      name: "&aThis is a very nice grass block"
      lore:
        - "" 
        - "&eMy first button with &fzMenu"
        - "&7Congratulations, you will now discover"
        - "&7all the possibilities of zMenu."

      # Translate the item name into multiple languages
      # You must define the language and the country used
      # The vanilla Minecraft client will use lowercase language / country pairs separated by an underscore, but custom resource packs may use any format they wish.
      translated-name:
        - locale: "fr_fr" # Allows to define the language in French
          name: "&aC’est un très beau bloc d’herbe !"
        - locale: "es_es" # Allows to define the language in Spanish
          name: "&a¡Es un hermoso bloque de hierba!"

`translated-lore`

Allows to translate the lore of the item in several languages

items:
  example:
    item:
      material: GRASS_BLOCK
      name: "&aThis is a very nice grass block"
      lore:
        - "" 
        - "&eMy first button with &fzMenu"
        - "&7Congratulations, you will now discover"
        - "&7all the possibilities of zMenu."

      # Translate the item lore into multiple languages
      # You must define the language and the country used
      # The vanilla Minecraft client will use lowercase language / country pairs separated by an underscore, but custom resource packs may use any format they wish.
      translated-lore:
        - locale: "fr_fr" # Allows to define the language in French
          lore:
            - "" # empty line to put space between name and lore
            - "&eMon premier bouton avec &fzMenu"
            - "&7Félicitations, vous allez maintenant découvrir"
            - "&7toutes les possibilités de zMenu."
        - locale: "es_es" # Allows to define the language in Spanish
          lore:
            - "" # empty line to put space between name and lore
            - "&eMi primer botón con &fzMenu"
            - "&7Felicidades, ahora vas a descubrir"
            - "&7todas las posibilidades de zMenu."

`max-stack-size`

max-stack-size: 2

Overrides the default maximum stack size of this item. Choose a number between 1 and 99. max-stack-size must be 1 if max-damage is set.

Only available for 1.21 and above

`max-damage`

max-damage: 2567

Controls the maximum amount of damage an item can take. If not present, the item cannot be damaged. For this to work, you need to make this item a tool if it is not already and then set it's initial damage (usually 0). max-stack-size must be 1 if max-damage is set.

Only available for 1.21 and above

`damage`

damage: 20

The absolute amount of damage or use this item has taken.

Only available for 1.21 and above

`repair-cost`

repair-cost: 10

Number of enchantment levels to add to the base level cost when repairing, combining, or renaming this item with an Anvil.

Only available for 1.21 and above

`unbreakable`

unbreakable: false

Tools, armor and weapons set with this won't lose durability when used.

Only available for 1.21 and above

unbreakable-show-in-tooltip: false

If false, an 'Unbreakable' line will not be included in the tooltip. Default is True.

Only available for 1.21 and above

`fire-resistant`

fire-resistant: false

If true, this item will not burn in fire

Only available for 1.21 and above

`item-rarity`

item-rarity: COMMON

Determines the default color of its name. This enum is ordered from least rare to most rare.

COMMON - White item name.
EPIC - Light purple item name.
RARE - Aqua item name.
UNCOMMON - Yellow item name.

Only available for 1.21 and above

hide-tooltip: false

If present, it will completely hide whole item tooltip (that includes item name). The tooltip will be still visible and searchable in creative mode.

Only available for 1.21 and above

hide-additional-tooltip: false

If true, disables 'additional' tooltip part which comes from the item type.

Only available for 1.21 and above

`enchantment-glint`

enchantment-glint: false

If true, the item will glint, even without enchantments; if false, the item will not glint, even with enchantments. If null, the override will be cleared.

Only available for 1.21 and above

enchantment-show-in-tooltip: true

If false, no enchantments will be shown in the item tooltip. Default is true.

Only available for 1.21 and above

attribute-show-in-tooltip: true

If false. The attributes will not show on the item tooltip. Default is true.

Only available for 1.21 and above

`trim`

# Only work for armors!
trim:
  enable: false
  # QUARTZ, IRON, NETHERITE, REDSTONE, COPPER; GOLD; EMERALD, DIAMOND, LAPIS, AMETHYST
  material: QUARTZ
  # SENTRY, DUNE, COAST, WILD, WARD, EYE, VEX, TIDE, SNOUT, RIB, SPIRE, WAYFINDER, SHAPER, SILENCE, RAISER, HOST
  pattern: DUNE

Allows to define an armor trim, only usable on armor

Only available for 1.20 and above

`center-name`

center-name: true #Default: false

If true, the item name will be centered in the item tooltip. If false, the item name will be left-aligned.

`center-lore`

center-lore: true #Default: false

If true, the item lore will be centered in the item tooltip. If false, the item lore will be left-aligned.

tooltip-style: "<namespace>:<tooltip name>" #Example "minecraft:default"

Allows you to set a custom tooltip style for the item. The tooltip style must be defined in a resource pack and can be used to change the appearance of the tooltip.

Only available for 1.21 and above

`item-model`

item-model: "<namespace>:<model name>" #Example "minecraft:default"

Allows you to set a custom item model for the item. The item model must be defined in a resource pack and can be used to change the appearance of the item. Identical to model-id, but for new minecraft versions.

Only available for 1.21 and above

`equipped-model`

equipped-model: "<namespace>:<model id>"

Allows you to define the asset_id of your item

Only available for 1.21 and above

PreviousActions NextGlobal Placeholders

Last updated 12 days ago

🪁Items

`material`

`amount`

`data`

`durability`

`url`

`name`

`lore`

`lore-type`

`potion`

`glow`

`model-id`

`enchantments`

List of enchantments

`flags`

`color`

`firework`

`banner`

`translated-name`

`translated-lore`

`max-stack-size`

`max-damage`

`damage`

`repair-cost`

`unbreakable`

`unbreakable-show-in-tooltip`

`fire-resistant`

`item-rarity`

`hide-tooltip`

`hide-additional-tooltip`

`enchantment-glint`

`enchantment-show-in-tooltip`

attribute-show-in-tooltip

`trim`

`center-name`

`center-lore`

`tooltip-style`

`item-model`

`equipped-model`