English
Marketplace

🪁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>

The material of the item. You can use a placeholder to display a material.

Supported material values:

  • Material - Example: material: STONE

  • Placeholder value - Example: material: %your_placeholder_material%

  • FREE - zHead RECOMMENDED (zhd:<id>) Example: material: "zhd:<id>"

  • PAID - zItems (ztems:<item name>) Example: material: "zitems:<id>"

  • PAID - HeadDatabase (hdb:<id>) Example: material: "hdb:<id>"

  • PAID - Oraxen (oraxen:<item name>) Example: material: "oraxen:<item name>"

  • PAID - ItemAdder (itemsadder:<item name>) Example: material: "itemsadder:<item name>"

  • FREE - SlimeFun (slimefun:<item name>) Example: material: "slimefun:<item name>"

  • FREE - Nova (nova:<item/block name>) Example: material: "nova:<item/block name>"

  • Base64 (base64:<item in base64) Retrieve this value in base64 with the command /zm save <item name> base64

  • PlayerHead (playerHead: <player name>) Displays the head of a player. Example: playerHead: "%player%" Displays the head of the player who opens the inventory

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, only available for versions between 1.8 and 1.12. By default, it's 0.

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.

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>

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.

ModelID

modelID: <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

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

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.
      translatedName:
        - 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.
      translatedLore:
        - 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 below

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 below

Damage

damage: 20

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

Only available for 1.21 and below

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 below

Unbreakable

unbreakable: false

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

Only available for 1.21 and below

Unbreakable Show In Tooltip

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 below

Fire Resistant

fire-resistant: false

If true, this item will not burn in fire

Only available for 1.21 and below

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 below

Hide Tooltip

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 below

Hide additional tooltip

hide-additional-tooltip: false

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

Only available for 1.21 and below

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 below

Enchantment Show In Tooltip

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 below

Attribute Show In Tooltip

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 below

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.21 and below

PreviousActionsNextPatterns

Last updated