Item Modifier

The unit that changes the display item.

Subsections of Item Modifier

Overview

  • Item Modifier is the property of an item. It describes what the final item should be.
  • There are a lot of built-in modifiers for items (Check the sidebar). A developer can also make his own modifier and register to the plugin.

Example

stone-button:
  slot: 1
  id: stone
  name: "&cThis is a stone button"
  lore:
  - "This is just a stone button"
  - "&uNothing special"

Material

This modifier will set the material of the item.

Format

material: <material>
id: <material>
mat: <material>

Note

  • List of Materials.
  • You can set multiple materials as a list for the plugin to check for one available material. This helps Setup Makers to support both old and new version of the material.

Example

stone-button:
  slot: 1
  id: stone
player-head:
  slot: 2
  id:
  - player_head
  - skull_item:3

Name

This modifier will set the display name of the item.

Format

name: "<name>"

Example

stone-button:
  slot: 1
  id: stone
  name: "&cThis is a stone button"

Lore

This modifier will set the lore of the item.

Format

lore: <lore>
lore:
- <lore>
- <lore>
- <lore>
...

Example

stone-button:
  slot: 1
  id: stone
  name: "&cThis is a stone button"
  lore:
  - "This is just a stone button"
  - "&uNothing special"

Amount

This modifier will set the amount of the item.

Format

amount: <amount>

Example

stone-button:
  slot: 1
  id: stone
  amount: 10
  name: "&cThis is 10 stone buttons"
  lore:
  - "This is just 10 stone buttons"
  - "&uNothing special"

Durability

This modifier will set the durability of the item.

Format

durability: <durability>
damage: <durability>

Example

durability-armor:
  NAME: '&aDamaged armor'
  LORE:
    - 'This armor is damaged.'
  ID: diamond helmet
  DAMAGE: 100
  POSITION-X: 1
  POSITION-Y: 1

Enchantment

This modifier will add the enchants to the item.

Format

enchantment:
- <enchantment>, [level]
- <enchantment>, [level]
- <enchantment>, [level]
...
enchant:
- <enchantment>, [level]
- <enchantment>, [level]
- <enchantment>, [level]
...
enc:
- <enchantment>, [level]
- <enchantment>, [level]
- <enchantment>, [level]
...

Note

Example

enchanted-sword:
  NAME: '&aEnchanted sword'
  LORE:
    - 'This sword is glowing.'
  ID: diamond_sword
  ENCHANTMENT:
    - "durability, 1"
  POSITION-X: 1
  POSITION-Y: 1

Item Flag

This modifier will add the flags to the item.

Format

flag:
- <flag>
- <flag>
- <flag>
...
item-flags:
- <flag>
- <flag>
- <flag>
...
itemflag:
- <flag>
- <flag>
- <flag>
...
itemflags:
- <flag>
- <flag>
- <flag>
...
item-flag:
- <flag>
- <flag>
- <flag>
...

Note

Example

enchanted-sword-flag:
  NAME: '&aEnchanted sword'
  LORE:
    - 'This sword is glowing. (literally)'
  ID: diamond_sword
  ENCHANTMENT:
    - "durability, 1"
  FLAG:
    - HIDE_ENCHANTS
  POSITION-X: 1
  POSITION-Y: 1

Potion Effect

This modifier will add the potion effects to the item.

Format

potion:
- <potion>, [duration], [amplifier]
- <potion>, [duration], [amplifier]
- <potion>, [duration], [amplifier]
...
effect:
- <potion>, [duration], [amplifier]
- <potion>, [duration], [amplifier]
- <potion>, [duration], [amplifier]
...

Note

Example

potion:
  position-x: 1
  position-y: 1
  name: "&bPotion"
  id: potion
  potion:
    - "SPEED"
    - "WEAKNESS, 30, 1"

Skull

This modifier will set the skull of the item.

Format

skull: <skull>
head: <skull>
skull-owner: <skull-owner>

Note

  • <skull> accepts a player name, an UUID (unique id), a Base64 value, or a texture.minecraft.net URL

Example

skull:
  position-x: 1
  position-y: 1
  name: "&bSkull"
  id: player_head
  skull: "HSGamer"
  #skull: "7acc67dc-8b84-4f8d-b7ad-ec81e758f5a1"
  #skull: "http://textures.minecraft.net/texture/ffcdae586b52403b92b1857ee4331bac636af08bab92ba5750a54a83331a6353"
  #skull: "eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvZTM1ODNkNTNlOWNhZjE3MGUwNWI1MTYxN2E2N2QxMzEwZDJkODExYTUxNTg4NjI5ODZjMTVlMjg2NzhhNTA1ZiJ9fX0="

per-player-skull:
  position-x: 2
  position-y: 1
  name: "&bPer Player Skulls"
  id: player_head
  skull: "{player}"

NBT

This modifier will apply the NBT data to the item.

Warning

This modifier will reset all item settings. Therefore, It’s recommended to order the settings in the following pattern: ID (Material), NBT, other item settings.

Format

nbt: <nbt>
nbt-data: <nbt>

Example

custom-model-chestplate:
  id: leather_chestplate
  nbt:
    CustomModelData: 104230
  #nbt: "{CustomModelData:104230}"
  name: "&aCustom Model Chestplate"
  lore:
    - "This is a custom model chestplate"
  position-x: 1
  position-y: 1

colored-leather-chestplate:
  id: leather_chestplate
  nbt:
    display:
      color: 16175144
  #nbt: "{display:{color:16175144}}"
  name: "&aColored Leather Chestplate"
  lore:
    - "This is a colored leather chestplate"
  position-x: 2
  position-y: 1

Item Component

In 1.20.5 and above, Mojang decided to replace NBT with their new Item Component. To use Item Component, you can use its square-bracket format [] as the value to the modifier.

For example, for a typical /give command like this:

/give @s leather_helmet[dyed_color={rgb:456345,show_in_tooltip:false}]

You can take this part [dyed_color={rgb:456345,show_in_tooltip:false}] and use it in the modifier like this:

nbt: "[dyed_color={rgb:456345,show_in_tooltip:false}]"