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).

item:
  material: <material>
  amount: <amount>
  data: <data, only available between 1.8 and 1.12>
  durability: <durability>
  url: <player skin in base64>
  name: <display name>
  lore: <list of text>
  potion: <potion effect type>
  level: <potion level>
  splash: <potion splash true or false>
  extended: <potion extended true of flase>
  glow: <add glow effect>
  modelID: <custom model id>
  enchants: <list of enchantments>
  flags: <list of itemflag>
  firework: <firework meta>
  banner: <banner color>
  patterns: <banner patterns>
  color: <leather armor color>

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 - 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 its 0


Durability

durability: <durability>

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


Url

url: <player skin in base64>

Allows 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 "Value" of the category "Other":

Example

url: "eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvNjM3YjhhMzk4MzdiYzNkNThmMDljOGM2ZTUzOTYyZDMzZjlmYTBiNjUzOThhNzc5MzUzYWRlMWUxNDcxM2VmZiJ9fX0="

Name

name: <display name>

The name that will be displayed on the item. Works with PlaceholderAPI.

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


Lore

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

Allows to display the lore of the item. Works with PlaceholderAPI.


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 type here.

Warning, a potion cannot be extended and with a level 2

# 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 have to put the name of the enchantment then the level of the enchantment, like this: ENCHANT,ENCHANT_LEVEL List of enchantments available: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/enchantments/Enchantment.html


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 armorers. The format is as follows:

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

You can also add an alpha in the color to have ARGB

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

The color format is the same for fireworks, banner and potion. 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."

Last updated