Item Format

Mojang very like change material (item type), enchantment, potion and many other things's ID (or namespace key). For example, they changed sweeping enchantment ID to sweeping_edge in 1.21. So, before you update your server version, you need carefully check that whether new versions have changed something, otherwise it will break your shop or menu configs.

Legacy (If you are using 2.2.0- version)

This page is telling you new Item Format which start use at version 2.2.0. Before that version, you should use legacy version of Item Format at this page.

Hook Item

Hook Plugin

Possible Value: EcoItems, EcoArmor, MMOItems, ItemsAdder, Oraxen, MythicMobs, eco, NeigeItems, ExecutableItems.

hook-plugin: MMOItems

Hook Item

For EcoItems, Oraxen, MythicMobs, you should write item id.

For ItemsAdder, eco, you should write namespace:item id.

Eco's namespace id plugin name, like talismans.

• Talisman: Just type talisman ID here.

• EcoArmor:

  • Armor: set_<setID>_<slotID>

  • Advanced Armor: set_<setID>_<slotID>_advanced

  • Upgrade Crystal: shard_<shardID>

• Reforges: stone_<reforgeID>

For EcoArmor, you should write armor set id;;armor slot. armor slot can be set to BOOTS, CHESTPLATE, ELYTRA, HELMET, LEGGINGS.

For MMOItems, you should write <itemTypeId>;;<itemId>.

hook-item: AXE;;TEST_AXE

Stop! If you are just trying to get items from custom item plugins, hook-plugin and hook-item option should be enough for you, if your custom item plugins are not supported, please use command instead, all things below is suit for vanilla items, if you set them here, we will replace the related to item attributes and this will lead to the item you get here is different from the item should be in custom item plugins.

Material

If you want to use saved item by plugin, just set this option value to saved item ID, like material: superior_sword.

If the value is empty or illegal, defaults to stone.

Do not use this option when you have hook-plugin option, it won't work if you insist on it!

material: APPLE

Amount

Support use PlaceholderAPI or math calculate. For example, %player_health% * 5.

amount: 5

Min Amount/Max Amount - Only support in price/products

Useful for dynamic prices.

min-amount: 1
max-amount: 15

Custom Name/Display Name

According to your configuration file, there are two formats, one is the old version color code used before version 1.9, or the Text Component used in later versions. The former uses a color code format we created, while the latter uses Mini Message format, as detailed here. Mini Message format require your server core is Paper.

name: '&fA smart sword'

Item Name (1.20.5+)

Item Name is a new item attribute added in 1.20.5, different from display name, item name can not be changed in anvil.

According to your configuration file, there are two formats, one is the old version color code used before version 1.9, or the Text Component used in later versions. The former uses a color code format we created, while the latter uses Mini Message format, as detailed here. Mini Message format require your server core is Paper.

item-name: '&bRare Sword'

Lore

You can use \n to represent line breaks.

According to your configuration file, there are two formats, one is the old version color code used before version 1.9, or the Text Component used in later versions. The former uses a color code format we created, while the latter uses Mini Message format, as detailed here. Mini Message format require your server core is Paper.

lore:
  - '&fLine 1'
  - '&fLine 2'

Max Stack (1.20.5+)

max-stack: 99

Food (1.20.5+)

Effects format: Potion Type ID, Duration, Amplifier, Ambient, Particles, Icon, Chance.

For Ambient, Particles, Icon is boolean type arg, and for Chance is a number from 0 to 1.

For convert is Item Format that the item will return to player after eaten this food (Require 1.21+, and this is optional).

food:
  eat-seconds: 0.25
  can-always-eat: true
  nutrition: 5
  saturation: 0.5
  convert:
    material: BREAD
  effects:
    - 'SPEED, 100, 1, true, true, false, 0.5'

Tool (1.21+)

tool:
  mining-speed: 1
  damage-per-block: 1
  rules:
    - 'stone, coal_ore, 1, true'

Jukebox Playable (1.21+)

For song possible value: THIRTEEN, BLOCKS, CHIRP, FAR, MALL, MELLOHI , STAL, STRAD, WARD, ELEVEN, WAIT, PIGSTEP, OTHERSIDE, FIVE, RELIC, PRECIPICE, CREATOR, CREATOR_MUSIC_BOX.

song: CAT
show-song: false

Fire Resistant (1.20.5+)

fire-resistant: true

Hide Tool Tip (1.20.5+)

hide-tool-tip: true

Unbreakable

unbreakable: true

Ratity (1.20.5+)

Possible Value: COMMON, UNCOMMON, RARE, EPIC.

rarity: COMMON

Flags

Possible Value: HIDE_ENCHANTS, HIDE_ATTRIBUTES, HIDE_UNBREAKABLE, HIDE_DESTROYS, HIDE_PLACED_ON, HIDE_ADDITIONAL_TOOLTIP, HIDE_DYE, HIDE_ARMOR_TRIM.

flags:
  - HIDE_ENCHANTS
  - HIDE_ATTRIBUTES
  - HIDE_UNBREAKABLE
  - HIDE_DESTROYS
  - HIDE_PLACED_ON
  - HIDE_ADDITIONAL_TOOLTIP
  - HIDE_DYE
  - HIDE_ARMOR_TRIM

Enchants

Config section format is: Enchant ID: Enchant Level.

For enchantment book: You maybe need use stored-enchants instead of enchants.

For custom enchantments: Some enchantments plugins are not registered their enchantment into game, so this won't work for them.

You should use Minecraft enchantment ID instead of Spigot's after 1.20.5.

enchants:
  MENDING: 1

Glow (1.20.5+)

glow: true

Custom Model Data

custom-model-data: 15

Attributes

Please note that 1.20.5 has changed attribute format, if you generated item before 1.20.5, you have to reconfig them into new format.

Config section format is Attribute ID and then has multi sub options.

For Attribute ID possible value:

• GENERIC_MAX_HEALTHGENERIC_FOLLOW_RANGE("generic.follow_range")

• GENERIC_KNOCKBACK_RESISTANCE("generic.knockback_resistance")

• GENERIC_MOVEMENT_SPEED("generic.movement_speed")

• GENERIC_FLYING_SPEED("generic.flying_speed")

• GENERIC_ATTACK_DAMAGE("generic.attack_damage")

• GENERIC_ATTACK_KNOCKBACK("generic.attack_knockback")

• GENERIC_ATTACK_SPEED("generic.attack_speed")

• GENERIC_ARMOR("generic.armor")

• GENERIC_ARMOR_TOUGHNESS("generic.armor_toughness")

• GENERIC_FALL_DAMAGE_MULTIPLIER("generic.fall_damage_multiplier")

• GENERIC_LUCK("generic.luck")

• GENERIC_MAX_ABSORPTION("generic.max_absorption")

• GENERIC_SAFE_FALL_DISTANCE("generic.safe_fall_distance")

• GENERIC_SCALE("generic.scale")

• GENERIC_STEP_HEIGHT("generic.step_height")

• GENERIC_GRAVITY("generic.gravity")

• GENERIC_JUMP_STRENGTH("generic.jump_strength")

• PLAYER_BLOCK_INTERACTION_RANGE("player.block_interaction_range")

• PLAYER_ENTITY_INTERACTION_RANGE("player.entity_interaction_range")

• PLAYER_BLOCK_BREAK_SPEED("player.block_break_speed")

• ZOMBIE_SPAWN_REINFORCEMENTS("zombie.spawn_reinforcements")

The Attribute ID is outside the parentheses, and the Attribute Name is inside.

For operation possible value: ADD_NUMBER, ADD_SCALAR, MULTIPLY_SCALAR_1.

For slot, different version has different possible value:

• For 1.20.5+: ANY, MAINHAND, OFFHAND, HAND, FEET, LEGS, CHEST, HEAD, ARMOR.

• For older 1.20.5: HAND, OFFHAND, FEET, LEGS, CHEST, HEAD, BODY.

attributes:
  GENERIC_ATTACK_DAMAGE: 
    name: generic.attack_damage 
    amount: 12
    operation: ADD_NUMBER 
    slot: HAND 

Damageable

Represents an item that has durability and can take damage.

Damage

damage: 5

Max Damage (1.20.5+)

Similar to max durability.

max-damage: 1500

Enchantment Storage

This is specific to items that can store enchantments, as opposed to being enchanted. Material.ENCHANTED_BOOK is an example of an item with enchantment storage.

Stored Enchants

Similar to Enchants.

stored-enchants:
  MENDING: 1

Banner

Patterns

Config section format is: Pattern ID: Pattern Color.

For Pattern ID possible value: BASE, SQUARE_BOTTOM_LEFT, SQUARE_BOTTOM_RIGHT, SQUARE_TOP_LEFT, SQUARE_TOP_RIGHT, STRIPE_BOTTOM, STRIPE_TOP, STRIPE_LEFT, STRIPE_RIGHT, STRIPE_CENTER, STRIPE_MIDDLE, STRIPE_DOWNRIGHT, STRIPE_DOWNLEFT, SMALL_STRIPES, CROSS, STRAIGHT_CROSS, TRIANGLE_BOTTOM, TRIANGLE_TOP, TRIANGLES_BOTTOM, TRIANGLES_TOP, DIAGONAL_LEFT, DIAGONAL_UP_RIGHT, DIAGONAL_UP_LEFT, DIAGONAL_RIGHT, CIRCLE, RHOMBUS, HALF_VERTICAL, HALF_HORIZONTAL, HALF_VERTICAL_RIGHT, HALF_HORIZONTAL_BOTTOM, BORDER, CURLY_BORDER, CREEPER, GRADIENT, GRADIENT_UP, BRICKS, SKULL, FLOWER, MOJANG, GLOBE, PIGLIN, FLOW, GUSTER.

For Pattern Color possible value: WHITE, ORANGE, MAGENTA, LIGHT_BLUE, YELLOW, LIME, PINK, GRAY, LIGHT_GRAY, CYAN, PURPLE, BLUE, BROWN, GREEN, RED, BLACK.

patterns:
  BASE: WHITE

Potion

Represents a potion or item that can have custom effects.

Base Effect (1.20.5+)

Possible value: WATER, MUNDANE, THICK, AWKWARD, NIGHT_VISION, LONG_NIGHT_VISION, INVISIBILITY, LONG_INVISIBILITY, LEAPING, LONG_LEAPING, STRONG_LEAPING, FIRE_RESISTANCE, LONG_FIRE_RESISTANCE, SWIFTNESS, LONG_SWIFTNESS, STRONG_SWIFTNESS, SLOWNESS, LONG_SLOWNESS, STRONG_SLOWNESS, WATER_BREATHING, LONG_WATER_BREATHING, HEALING, STRONG_HEALING, HARMING, STRONG_HARMING, POISON, LONG_POISON, STRONG_POISON, REGENERATION, LONG_REGENERATION, STRONG_REGENERATION, STRENGTH, LONG_STRENGTH, STRONG_STRENGTH, WEAKNESS, LONG_WEAKNESS, LUCK, TURTLE_MASTER, LONG_TURTLE_MASTER, STRONG_TURTLE_MASTER, SLOW_FALLING, LONG_SLOW_FALLING, WIND_CHARGED, WEAVING, OOZING, INFESTED.

base-effect: 'WATER'

Base Effect (Before 1.20.5)

Possible value: AWKWARD, FIRE_RESISTANCE, INSTANT_DAMAGE, INSTANT_HEAL, INVISIBILITY, JUMP, LUCK, MUNDANE, NIGHT_VISION, POISON, REGEN, SLOW_FALLING, SLOWNESS, SPEED, STRENGTH, THICK, TURTLE_MASTER, UNCRAFTABLE, WATER, WATER_BREATHING, WEAKNESS.

Format: Potion Type ID, Extended, Upgraded.

For Extended and Upgraded arg is boolean type.

base-effect: 'WATER, true, false'

Effects / Custom Effects

Effects format: Potion Type ID, Duration, Amplifier, Ambient, Particles, Icon.

For Ambient, Particles, Icon is boolean type arg.

effects:
  - 'SPEED, 100, 1, true, true, false'

Color

Color has 2 formats:

• Red, Green, Blue

• One number (like 0xff0000)

color: '5'

Armor

Represents armor that an entity can equip.

Trim (1.20+)

Config section format is 2 sub options.

For material possible value: QUARTZ, IRON, NETHERIT, REDSTONE, COPPER, GOLD, EMERALD, DIAMOND, LAPIS, AMETHYST.

For pattern possible value: SENTRY, DUNE, COAST, WILD, WARD, EYE, VEX, TIDE, SNOUT, RIB, SPIRE, WAYFINDER, SHAPER, SILENCE, RAISER, HOST, FLOW, BOLT.

Those possible value are for vanilla only, data pack and so on can also register new trim material or pattern.

trim:
  material: IRON
  pattern: TIDE

Leather Armor

Color

Color has 2 formats:

• Red, Green, Blue

• One number (like 0xff0000)

color: '0xff0000'

Axolotl Bucket (1.17+)

Color

Possible value: LUCY, WILD, GOLD, CYAN, BLUE.

color: LUCY

Tropical Fish Bucket (1.14+)

Color

Possible value: WHITE, ORANGE, MAGENTA, LIGHT_BLUE, YELLOW, LIME, PINK, GRAY, LIGHT_GRAY, CYAN, PURPLE, BLUE, BROWN, GREEN, RED, BLACK.

color: WHITE

Pattern Color

Similar to Color above.

pattern-color: WHITE

Pattern

Possible value: KOB, SUNSTREAK, SNOOPER, DASHER, BRINELY, SPOTTY, FLOPPER, STRIPEY, GLITTER, BLOCKFISH, BETTY, CLAYFISH.

pattern: KOB

Skull

Support 2 formats:

• Base64: Like example below, only support 1.19+.

• Player Name: Need online mode, support all versions.

skull: eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvN2YzZmVkMTZmZDU1MTkwOWZhNWUyOWNkZDY5N2VlMzQ2ZTYzMzkwYjM4M2E0MzAwYTY2MmE4MGI2NGQ5ZWIxNyJ9fX0=

Firwork

Power

power: 1

Firework Effect

Config section format is multi sub options.

For type possible value: BALL, BALL_LARGE, STAR, BURST, CREEPER.

firework:
  1: 
    flicker: true
    trial: true
    colors:
      base:
        - 5
      fade:
        - 666666
    type: BALL

Firework Star

Firework Effect

For type possible value: BALL, BALL_LARGE, STAR, BURST, CREEPER.

firework:
  flicker: true
  trial: true
  colors:
    base:
      - 5
    fade:
      - 666666
  type: BALL

Suspicious Stew (1.14+)

Effects

Effects format: Potion Type ID, Duration, Amplifier, Ambient, Particles, Icon.

effects:
  - 'SPEED, 100, 1, true, true, false'

Bundle (1.17+)/Shulker

Contents

Config section format is slot ID and then with item format.

contents:
  1:
    material: STONE
  2:
    material: APPLE
    amount: 5

Brushable Blocks (1.20+)

Content

The loot item inside brushable blocks. Want custom brushable block? Consider buy our CustomArcheology plugin here!

content:
  material: APPLE

Spawner

Only spawner option is required if you want spawner has mobs inside. Other options are optional.

spawner: ZOMBIE
min-delay: 200
max-delay: 800
max-entities: 6
player-range: 16
spawn-range: 30

Ominous Bottle (1.20.5+)

Power

power: 3

Music Instrument (1.18+)

Music

Possible value: PONDER_GOAT_HORN, SING_GOAT_HORN, SEEK_GOAT_HORN, FEEL_GOAT_HORN, ADMIRE_GOAT_HORN, CALL_GOAT_HORN, YEARN_GOAT_HORN, DREAM_GOAT_HORN.

music: PONDER_GOAT_HORN

Plugin Enchants - UltimateShop-Premium Only

Support AdvancedEnchantments only for now.

Plugin like EcoEnchants, ExcellentEnchants are vanilla enchants like plugin, you just need to put their enchantment ID to enchants option (like above).

You can use plugin-enchants option to add plugin enchants for your item.

plugin-enchants:
  PLANTER: 5 # A AdvancedEnchantments enchantment

Change Item - Require MythicChanger

Support FlipCard, SpinToWin, UltimateShop only

Change the item by MythicChanger, if you are using premium version of MythicChanger, it will allow you use custom NBT tag by adding nbt-xxx rule here. You can also use /mc viewnbt command to view the hold item NBT info.

This feature require your server must install MythicChanger plugin, please get it here:

FREE: Click to download

PREMIUM: Click to download

For how to configure the change-item section, please read MythicChanger's wiki, . Please note that some of the change rules require PREMIUM version of MythicChanger, not PREMIUM version of UltimateShop!

change-item:
  set-name: '&fGood Diamond Sword'