Item

All item related options & configurations

Syntax

items:
  "ItemName":
    material: TEXT
    slot: #

Note: Each item will have a name, in this example our item is called ItemName. This name should be unique, so there won't be two or more items with the same name.

Material

material: TEXT
Supported material values:
Material name (STONE).
Player head (head-extended_clip).
Placeholder head (head-%player_name%, basehead-%player_basehead_placeholder%, etc.).
Argument placeholder head (head-{target}).
BaseHead (basehead-<base64 (Value field in the head's give command)>).
Minecraft Texture (texture-<id>) - The id is what's after https://textures.minecraft.net/textures/
HeadDatabase (hdb-<ID>).
ItemsAdder material (itemsadder-namespace:name)
Oraxen material (oraxen-oraxen_item_id)
Nexo material (nexo-nexo_item_id)
MMOItems material (mmoitems-item_type:item_id)
ExecutableItems material (executableitems-item_id)
ExecutableBlocks material (executableblocks-item_id)
SimpleItemGenerator material (simpleitemgenerator-item_id)
Placeholder material (placeholder-%player_item_in_hand%).
Item in main hand (main_hand).
Item in off hand (off_hand).
Items in armor equipment slots (armor_helmet, armor_chestplate, armor_leggings and armor_boots)
Water bottle material is: water_bottle
Air material is: air

Sets the material of the item in the menu.

AIR is a valid material. The item will be an empty slot with click commands and click requirements working.

Placeholders are supported for head, basehead, texture, hdb, itemsadder, oraxen and all other custom materials!

Damage

damage: #
Supported damage values:
Number (1).
Placeholder that returns a number (placeholder-%player_item_in_hand_data%).

Sets the durability of the item (depends on the Material option).

The old data option was changed to damage. Please use the new option as the old one will be removed in the future.

Amount

amount: #

Sets the item's amount in the menu.

Dynamic Amount

dynamic_amount: '%placeholder%'

Sets the item's amount in the menu using a placeholder.

Model Data

model_data: #

Allows you to set a CustomModelData for your item. Example of usage: model_data: 14

DEPRECATED! Starting with 1.21.4, the new model_data_component should be used!

Model Data Component

model_data_component:
  strings: ["string1", "string2"]
  floats: [1, 2, 3]
  flags: ["true", "false", "true"]
  colors: ["255, 255, 255", "0, 0, 0"]

Allows you to set custom model data component. This is the new replacement for custom model data added by Mojang.

Item Model

item_model: # Namespaced key. Example minecraft:item_model

Allows you to set a custom Item Model for your item.

This option only works on versions 1.21.2 and higher!

tooltip_style: # Namespaced key. Example minecraft:custom_tooltip

Allows you to set a custom tooltip for your item.

This option only works on versions 1.21.2 and higher!

NBT Tags

nbt_string: '<Key>:<StringValue>'
nbt_strings:
- '<Key>:<StringValue>'
- '<Key>:<StringValue>'
nbt_int: '<Key>:<IntegerValue>'
nbt_ints:
- '<Key>:<IntegerValue>'
- '<Key>:<IntegerValue>'
nbt_short: '<Key>:<ShortValue>'
nbt_shorts:
- '<Key>:<ShortValue>'
- '<Key>:<ShortValue>'
nbt_byte: '<Key>:<ByteValue>'
nbt_bytes:
- '<Key>:<ByteValue>'
- '<Key>:<ByteValue>'

Allows you to add custom NBT tags to your items like model data.

Deprecated! Should use the new model_data option instead for CustomModelData. This option no longer works on 1.21.4 and newer versions!

Banner Meta

banner_meta:
- <dyecolor>;<patterntype>
- <dyecolor>;<patterntype>
Dye colors list.
Pattern types list.

Allows you to create your custom banners and shields.

Now with support for SHIELDS! Make sure to also check the new base_color option.

Base Color

base_color: <dyecolor>
Dye colors list.

Allows you to specify base colors for shields and also for banners on 1.12.2 and lower versions.

Light Level

light_level: <lightlevel>

Allows to set light level for the new light item. The value can be a number between 1 and 15.

Trim Material

trim_material: <trimmaterial>
Trim materials list.

Allows you to specify the trim pattern for armors.

Trim Pattern

trim_pattern: <trimpattern>
Trim patterns list.

Allows you to specify the trim material for armors.

Both options (trim_material and trim_pattern) are required for the trim to work!

Item Flags

item_flags:
- <ItemFlag>
- <ItemFlag>
Item Flags list.

Allows you to set item flags.

Potion Effects

potion_effects:
- <PotionEffectType>;<duration>;<amplifier>
- <PotionEffectType>;<duration>;<amplifier>

Potion effects list.

Allows you to set effects (Used if the material is a potion, splash_potion and tipped arrows).

Potion Effects no longer require the RGB option to be set to work!

Entity Type

entity_type: <entitytype>
Entity types list.

This is mainly targeted for 1.12.2 and lower server versions and allows you to specify monster egg types and monster spawner types.

Option was removed in versions 1.14.0 and newer of the plugin due to versions 1.13.1 and lower of Minecraft no longer being supported.

RGB

rgb: #, #, #
Example:
rgb: 38, 192, 210

Sets the RGB (Red, Green, Blue) color for leather armor, potions, splash potions, tipped arrows and firework stars

For RGB option to work on potions and tipped arrows you also need to give it at least one potion_effect.

You can find a list of default potion colors HERE. You will have to use an online converter to convert the hex values to rgb.

Display Name

display_name: "TEXT"

Sets the item's display name. You can use placeholders and color/format codes.

Lore

lore:
  - "TEXT"
  - "TEXT"

Sets the item's lore (the text shown under the item's name). You can use placeholders and color/format codes and the new line character (\n) in this option.

Lore Append Mode

lore_append_mode: # STRING

Sets a lore append mode. When using custom materials such as material: mmoitems-type:id, some of the items have their own lore. This option allows you to combine that lore with the one specified by you using lore or completely override it. Default value is OVERRIDE

Valid options:

IGNORE - ignores the lore option and only uses the lore specified by the custom item
OVERRIDE - ignores the lore from the custom item and uses the one specified in lore
BOTTOM - appends the lore specified in lore option at the bottom of the one from the custom item
TOP - appends the lore specified in lore option at the top of the one from the custom item

Slot

slot: #

Multiple slots:

slots:
  - #
  - #
  - #
  
# OR
  
slots:
  - #-#
  - #-#

Sets in which slot the item should be inside the menu.

Slots start at 0.
Multiple items can be in the same slot, but you'll have to use view requirement and priority options to work properly.

Priority

priority: #

Sets the item priority. It's used if you want different items in the same slot (by using the view requirement option). The item that has the highest priority will be checked first if the player has the required view requirement. It will display the item if they have the requirements and if not, it will check the next item and so on.

The highest priority is 0.
The lowest priority is 2147483647.

View Requirement

view_requirement: 'EXPRESSION'

Sets the requirements the player should have to see the item. (Check priority option for setting up multiple items in the same slot). Check the Requirements page for more info about this option's value and how to use it.

Update

update: BOOLEAN # true or false

If set to true, it will update the placeholders in the item's display name and lore only. Check the update interval GUI option to set the update speed.

Enchantments

enchantments:
  - enchantmentid;level
  - enchantmentid;level

Enchantments list.

Enchants the item with the specified enchantments. (Check the hide enchantments option to hide the enchantments)

Some items cannot have the enchanting glow effect

hide_tooltip: BOOLEAN # true or false

If set to true, it will hide the tooltip for the item.

This option only works on versions 1.20.5 and higher!

Enchantment Glint Override

enchantment_glint_override: BOOLEAN # true or false

If set to true, it will add a glint to the item, as if the item is enchanted, even if it is not enchanted.

This option only works on versions 1.20.5 and higher!

Rarity

rarity: STRING
Rarities list

Change the item rarity. As far as we understand it, this will only affect the default name color.

This option only works on versions 1.20.5 and higher!

Hide Enchantments

hide_enchantments: BOOLEAN # true or false

If set to true, it will hide the enchantments you set for the item using the enchantments option from the item's tooltip (lore). Used to add the enchanting glow effect to the item without showing the enchantments text.

DEPRECATED! Please use the item_flags options instead! This option will be removed.

Hide Attributes

hide_attributes: BOOLEAN # true or false

If set to true, it will hide the vanilla attributes of an item/armor (e.g. 7 Attack Damage).

DEPRECATED! Please use the item_flags options instead! This option will be removed.

Hide Unbreakable

hide_unbreakable: BOOLEAN # true or false

If set to true, it will hide the unbreakable tag if the "unbreakable:" option is enabled.

DEPRECATED! Please use the item_flags options instead! This option will be removed.

Unbreakable

unbreakable: BOOLEAN # true or false

If set to true, it will show the item to be at full durability.

(Shift) Left/Middle/Right click Commands

# click_commands: or
# left_click_commands: or
# right_click_commands: or
# middle_click_commands: or
# shift_left_click_commands: or
shift_right_click_commands:
  - "[ACTIONTYPE] ACTION"
  - "[ACTIONTYPE] ACTION"

Sets the actions/commands that should be executed once the player clicks the item. they get executed in order from top to bottom. Check this for all action types and action tags.

Middle clicking was removed by Mojang in 1.18 and newer!

(Shift) Left/Middle/Right click Requirement

# click_requirement: or
# left_click_requirement: or
# right_click_requirement: or
# middle_click_requirement: or
# shift_left_click_requirement: or
shift_right_click_requirement:
  requirements: 'EXPRESSION'
  deny_commands:
    - "[ACTIONTYPE] ACTION"
    - "[ACTIONTYPE] ACTION"

Sets the requirements the player should have to click the item (Check the Requirements page for more info about the EXPRESSION value). Deny commands (optional) are the actions that are going to be executed if the player doesn't have the required requirements. But if (s)he does, it will execute the actions specified in the click commands option.

You can have deny commands per requirement. Check this page for more information.

Check this for all action types and action tags.

PreviousGUI NextActions

Last updated 1 month ago

Was this helpful?

Item

Syntax

Material

Damage

Amount

Dynamic Amount

Model Data

Model Data Component

Item Model

Tooltip Style

NBT Tags

Banner Meta

Base Color

Light Level

Trim Material

Trim Pattern

Item Flags

Potion Effects

Entity Type

RGB

Display Name

Lore

Lore Append Mode

Slot

Priority

View Requirement

Update

Enchantments

Hide Tooltip

Enchantment Glint Override

Rarity

Hide Enchantments

Hide Attributes

Hide Unbreakable

Unbreakable

(Shift) Left/Middle/Right click Commands

(Shift) Left/Middle/Right click Requirement