Custom Item

This is a basic custom-item configuration

exclusive-armor:
  // other options...
  icon: ender_chest
  custom-item:
    material: EGG # Bukkit names (case-insensitive)
    damage: 5 # durability, default to 0
    name: "&aName" # Color and RGB support
    lore:
    - "Hello!"
    enchantments:
      durability: 1 # Bukkit names (case-insensitive)
      sharpness: 2 # Minecraft names is also allowed (case-insensitive)
    flags:
    - hide_enchants # Bukkit names (case-insensitive)
    custom-model-data: 1 # Set to 0 to unset custom model data
    unbreakable: true

Material list: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Material.html Enchantment list: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/enchantments/Enchantment.html Item flags: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/inventory/ItemFlag.html

Fallback

You can configure a certain number of options and leave the rest to inherit default values:

  • If no material is provided, the icon option will be used

  • If the name is undefined or empty, the name from the voucher will be used

  • If lore is undefined or empty, the description will be used (along with the footer defined in the config.yml)

Item Meta

Item meta defines further aspects of an item. These are currently supported meta types: potion, leather, skull, book, banner, enchanted_book, armor

You must define the meta type to utilize extra settings

enchanted-skull:
  # Other voucher settings...
  custom-item:
    material: player_head
    # Other general item settings...
    meta:
      type: skull # <===========
      # Other item meta settings...

Leather

colorful-leather:
  name: "&aColorful Leather Set"
  custom-item:
    material: leather_chestplate
    meta:
      type: leather
      leather-color: {red: 255, green: 255, blue: 125}

The leather colour has three RGB values (from 0 to 255)

Potion

acid-bottle:
  name: "&cAcid Bottle"
  custom-item:
    material: potion
    meta:
      type: potion
      potion-type: poison
      potion-extended: true
      potion-upgraded: true

Skull

burger:
  name: "&6Burger"
  custom-item:
    material: player_head
    meta:
      type: skull
      skull-texture: "6e2be91f04579a924a20a0585b8addac8ec790c97f005333a47ed983554c6ea"

The skull texture is an identifier at the tail of the skin URL pointing to Mojang's server such as https://textures.minecraft.net/texture/6e2be91f04579a924a20a0585b8addac8ec790c97f005333a47ed983554c6ea

It is possible to use the URL. However, I won't recommend it since that is too long

Book

the-art-of-becoming-god:
  name: "&aThe Art of Becoming God"
  custom-item:
    material: written_book
    meta:
      type: book
      book-author: herobrine
      book-title: "&aThe Art of Becoming God"
      book-generation: original
      book-pages:
        - "&aDonate to the server xD"

Book generation: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/inventory/meta/BookMeta.Generation.html

Enchanted_Book

mysterious-book:
  name: "&5Mysterious Book"
  custom-item:
    material: enchanted_book
    meta:
      type: enchanted_book
      stored-enchantments:
        sharpness: 5
        durability: 2

The option is the same as enchantments mentioned in Voucher Configuration You can use both Bukkit names and Minecraft names.

mojang-flag:
  name: "&cMojang"
  custom-item:
    material: white_banner
    meta:
      type: banner
      banner-patterns:
        - pattern: bricks
          color: gray
        - pattern: mojang
          color: red

Pattern type: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/block/banner/PatternType.html

Dye color: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/DyeColor.html

Armor

noob-armor:
  name: "&aCool Starter Kit"
  custom-item:
    material: diamond_chestplate
    meta:
      type: armor
      trim-material: quartz
      trim-pattern: dune

Trim pattern: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/inventory/meta/trim/TrimPattern.html

Trim material: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/inventory/meta/trim/TrimMaterial.html

Last updated