# Item ## Syntax > ```yaml > 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 > ```yaml > material: TEXT > ``` > > > **Supported material values:** > > > > * [Material name](https://wiki.helpch.at/helpchat-plugins/deluxemenus/options-and-configurations/..#useful-links) (`STONE`). > > * Player head (`head-extended_clip`). > > * Placeholder head (`head-%player_name%`, `basehead-%player_basehead_placeholder%`, etc.). > > * Argument placeholder head (`head-{target}`). > > * [BaseHead](https://minecraft-heads.com) (`basehead-`). > > * Minecraft Texture (`texture-`)\ > > \- The `id` is what's after `https://textures.minecraft.net/textures/` > > * [HeadDatabase](https://www.spigotmc.org/resources/14280/) (`hdb-`). > > * [ItemsAdder](https://www.spigotmc.org/resources/%E2%9C%A8itemsadder%E2%AD%90emotes-mobs-items-armors-hud-gui-emojis-blocks-wings-hats-liquids.73355/) material (`itemsadder-namespace:name`) > > * [Oraxen](https://www.spigotmc.org/resources/72448/) material (`oraxen-oraxen_item_id`) > > * [Nexo](https://polymart.org/product/6901/nexo) material (`nexo-nexo_item_id`) > > * [MMOItems](https://www.spigotmc.org/resources/mmoitems.39267/) material (`mmoitems-item_type:item_id`) > > * [ExecutableItems](https://www.spigotmc.org/resources/%E2%9A%94%EF%B8%8Fexecutableitems-%E2%AD%90-customize-all-items-add-abilities-%E2%AD%90-ai-items-generation-on-the-discord-%E2%9C%85.83070/) material (`executableitems-item_id`) > > * [ExecutableBlocks](https://www.spigotmc.org/resources/%E2%AD%90-executable-blocks-%E2%AD%90-add-activators-on-your-blocks.94696/) material (`executableblocks-item_id`) > > * [SimpleItemGenerator](https://www.spigotmc.org/resources/simpleitemgenerator-1-8-1-21-4-free.121339/) material (`simpleitemgenerator-item_id`) > > * [Placeholder](https://helpch.at/placeholders) 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. {% hint style="success" %} AIR is a valid material. The item will be an empty slot with click commands and click requirements working. {% endhint %} {% hint style="success" %} Placeholders are supported for head, basehead, texture, hdb, itemsadder, oraxen and all other custom materials! {% endhint %} ## Damage > ```yaml > 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](#material) option). {% hint style="danger" %} The old `data` option was changed to `damage`. Please use the new option as the old one will be removed in the future. {% endhint %} ## Amount > ```yaml > amount: # > ``` Sets the item's amount in the menu. ### Dynamic Amount > ```yaml > dynamic_amount: '%placeholder%' > ``` Sets the item's amount in the menu using a [placeholder](https://helpch.at/placeholders). ## Model Data > ```yaml > model_data: # > ``` Allows you to set a CustomModelData for your item. Example of usage:\ `model_data: 14` {% hint style="danger" %} **DEPRECATED!**\ Starting with 1.21.4, the new model\_data\_component should be used! {% endhint %} ## Model Data Component > ```yaml > 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 > ```yaml > item_model: # Namespaced key. Example minecraft:item_model > ``` Allows you to set a custom Item Model for your item. {% hint style="success" %} This option only works on versions 1.21.2 and higher! {% endhint %} ## Tooltip Style > ```yaml > tooltip_style: # Namespaced key. Example minecraft:custom_tooltip > ``` Allows you to set a custom tooltip for your item. {% hint style="success" %} This option only works on versions 1.21.2 and higher! {% endhint %} ## NBT Tags ```yaml nbt_string: ':' nbt_strings: - ':' - ':' nbt_int: ':' nbt_ints: - ':' - ':' nbt_short: ':' nbt_shorts: - ':' - ':' nbt_byte: ':' nbt_bytes: - ':' - ':' ``` Allows you to add custom NBT tags to your items like model data. {% hint style="danger" %} Deprecated! Should use the new [model\_data](#model-data) option instead for CustomModelData.\ **This option no longer works on 1.21.4 and newer versions!** {% endhint %} ## Banner Meta > ```yaml > banner_meta: > - ; > - ; > ``` > > > * [Dye colors list](https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/DyeColor.html). > > * [Pattern types list](https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/block/banner/PatternType.html). Allows you to create your custom banners and shields. {% hint style="success" %} Now with support for SHIELDS! Make sure to also check the new [base\_color](#base-color) option. {% endhint %} ## Base Color > 
base_color: <dyecolor>
>
> > > * [Dye colors list](https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/DyeColor.html). Allows you to specify base colors for shields and also for banners on 1.12.2 and lower versions. ## Light Level > ```yaml > light_level: > ``` 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](https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/inventory/meta/trim/TrimMaterial.html). Allows you to specify the trim pattern for armors. ## Trim Pattern > 
trim_pattern: <trimpattern>
>
> > > * [Trim patterns list](https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/inventory/meta/trim/TrimPattern.html). Allows you to specify the trim material for armors. {% hint style="warning" %} Both options (trim\_material and trim\_pattern) are required for the trim to work! {% endhint %} ## Item Flags > ```yaml > item_flags: > - > - > ``` > > > * [Item Flags list.](https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/inventory/ItemFlag.html) Allows you to set item flags. ## Potion Effects > ```yaml > potion_effects: > - ;; > - ;; > ``` > > > * [Potion effects list.](https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/potion/PotionEffectType.html) Allows you to set effects (Used if the [material](#material) is a potion, splash\_potion and tipped arrows). {% hint style="success" %} Potion Effects no longer require the [RGB](#rgb) option to be set to work! {% endhint %} ## Entity Type > ```yaml > entity_type: > ``` > > > * [Entity types list.](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/entity/EntityType.html) This is mainly targeted for 1.12.2 and lower server versions and allows you to specify monster egg types and monster spawner types. {% hint style="danger" %} 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. {% endhint %} ## RGB > ```yaml > rgb: #, #, # > ``` > > > **Example:** > > > > ```yaml > > rgb: 38, 192, 210 > > ``` Sets the RGB (Red, Green, Blue) color for leather armor, potions, splash potions, tipped arrows and firework stars {% hint style="info" %} For RGB option to work on potions and tipped arrows you also need to give it at least one [potion\_effect](#potion-effects). {% endhint %} {% hint style="success" %} You can find a list of default potion colors [`HERE`](https://minecraft.fandom.com/wiki/Effect_colors/Potions_table). You will have to use an online converter to convert the hex values to rgb. {% endhint %} ## Display Name > ```yaml > display_name: "TEXT" > ``` Sets the item's display name. You can use [placeholders](https://helpch.at/placeholders) and color/format codes. ## Lore > ```yaml > lore: > - "TEXT" > - "TEXT" > ``` Sets the item's lore (the text shown under the item's name). You can use [placeholders](https://helpch.at/placeholders) and color/format codes and the new line character (`\n`) in this option. ## Lore Append Mode > ```yaml > 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 > ```yaml > slot: # > ``` > > > **Multiple slots:** > > > > ```yaml > > slots: > > - # > > - # > > - # > > > > # OR > > > > slots: > > - #-# > > - #-# > > ``` Sets in which slot the item should be inside the menu. {% hint style="info" %} * Slots start at 0. * Multiple items can be in the same slot, but you'll have to use [view requirement](#view-requirement) and [priority](#priority) options to work properly. {% endhint %} ![Slots number in a chest](https://i.imgur.com/lr41ykP.png) ## Priority > ```yaml > priority: # > ``` Sets the item priority. It's used if you want different items in the same slot (by using the [view requirement ](#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. {% hint style="info" %} * The highest priority is 0. * The lowest priority is 2147483647. {% endhint %} ## View Requirement > ```yaml > view_requirement: 'EXPRESSION' > ``` Sets the requirements the player should have to see the item. (Check [priority](#priority) option for setting up multiple items in the same slot).\ Check the [Requirements](https://wiki.helpch.at/helpchat-plugins/deluxemenus/options-and-configurations/requirements) page for more info about this option's value and how to use it. ## Update > ```yaml > update: BOOLEAN # true or false > ``` If set to true, it will update the placeholders in the item's [display name](#display-name) and [lore](#lore) **only**.\ Check the [update interval](https://wiki.helpch.at/helpchat-plugins/deluxemenus/gui#update-interval) GUI option to set the update speed. ![An example showing how the update option works in placeholders](https://i.imgur.com/iOKtT2A.gif) ## Enchantments > ```yaml > enchantments: > - enchantmentid;level > - enchantmentid;level > ``` > > > * [Enchantments list](https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/enchantments/Enchantment.html). Enchants the item with the specified enchantments. (Check the [hide enchantments](#hide-enchantments) option to hide the enchantments) {% hint style="warning" %} Some items cannot have the enchanting glow effect {% endhint %} ## Hide Tooltip > ```yaml > hide_tooltip: BOOLEAN # true or false > ``` If set to true, it will hide the tooltip for the item. {% hint style="success" %} This option only works on versions 1.20.5 and higher! {% endhint %} ## Enchantment Glint Override > ```yaml > 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. {% hint style="success" %} This option only works on versions 1.20.5 and higher! {% endhint %} ## Rarity > ```yaml > rarity: STRING > ``` > > > * [Rarities list](https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/inventory/ItemRarity.html) Change the item rarity. As far as we understand it, this will only affect the default name color. {% hint style="success" %} This option only works on versions 1.20.5 and higher! {% endhint %} ## Hide Enchantments > ```yaml > hide_enchantments: BOOLEAN # true or false > ``` If set to true, it will hide the enchantments you set for the item using the [enchantments](#enchantments) option from the item's tooltip (lore).\ Used to add the enchanting glow effect to the item without showing the enchantments text. {% hint style="danger" %} **DEPRECATED!**\ **Please use the item\_flags options instead! This option will be removed.** {% endhint %} ## Hide Attributes > ```yaml > 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**). {% hint style="danger" %} **DEPRECATED!**\ **Please use the item\_flags options instead! This option will be removed.** {% endhint %} ## Hide Unbreakable > ```yaml > hide_unbreakable: BOOLEAN # true or false > ``` If set to true, it will hide the unbreakable tag if the "unbreakable:" option is enabled. {% hint style="danger" %} **DEPRECATED!**\ **Please use the item\_flags options instead! This option will be removed.** {% endhint %} ## Unbreakable > ```yaml > 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 > ```yaml > # 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](https://wiki.helpch.at/helpchat-plugins/deluxemenus/options-and-configurations/..#action-types) for all action types and action tags. {% hint style="danger" %} Middle clicking was removed by Mojang in 1.18 and newer! {% endhint %} ## (Shift) Left/Middle/Right click Requirement > ```yaml > # 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](https://wiki.helpch.at/helpchat-plugins/deluxemenus/options-and-configurations/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](#shift-left-middle-right-click-commands) option. {% hint style="info" %} You can have deny commands per requirement. Check [this page](https://wiki.helpch.at/helpchat-plugins/deluxemenus/requirements#syntax) for more information. {% endhint %} Check [this](https://wiki.helpch.at/helpchat-plugins/deluxemenus/options-and-configurations/..#action-types) for all action types and action tags.