HelpChat Wiki
  • Welcome
  • HelpChat Plugins
    • ChatChat
      • Commands
      • Permissions
      • Formats
      • Channels
      • Mentions
      • Placeholders
      • API
        • Getting Started
        • ChatChatAPI
        • Events
      • Files
    • DeluxeMenus
      • Commands & Permissions
      • Options & Configurations
        • GUI
        • Item
        • Requirements
        • Command Registration
      • Meta (Metadata)
      • External menus
      • Example GUI menus
      • Plugin's files
    • DeluxeTags
      • Commands & Permissions
      • Placeholders
      • Plugin's files
    • PlaceholderAPI
  • Clip's Plugins
    • AutoSell
      • Commands & Permissions
      • Placeholders
      • Plugin's files
    • ActionAnnouncer
      • Commands & Permissions
      • Plugin's files
      • API
    • ChatReaction
      • Commands & Permissions
      • Plugin's files
    • DeluxeChat
      • Installation
      • Commands & Permissions
      • Placeholders
      • Config options
      • Plugin's files
    • DeluxeCommands
      • Commands & Permissions
      • Plugin's files
    • DeluxeJoin
      • Commands & Permissions
      • Plugin's files
    • EzRanksPro
      • Commands & Permissions
      • Configuration
    • EzPrestige
      • Commands & Permissions
      • Configuration
    • InventoryFull
      • Commands & Permissions
      • Configuration
    • MessageAnnouncer
      • Commands & Permissions
      • Configuration
    • MineCrates
      • Commands & Permissions
      • Configuration
    • NoFlyZone
      • Commands & Permissions
      • Configuration
  • Funnycube's Plugins
    • CowPunch
      • Commands & Permissions
    • Firework Chests
      • Commands & Permissions
      • Configuration
    • Fish Slapper
      • Commands & Permissions
      • Configuration
    • RawMsg
      • Commands & Permissions
    • Spit
      • Commands & Permissions
    • Temp MOTD
      • Commands & Permissions
      • Configuration
  • Glare's Plugins
    • Guilds [W.I.P Migration]
      • Installation
      • Configuration
        • Buffs
        • Config
        • Roles
        • Tiers
      • Commands & Permissions
      • Placeholders
      • Developer API
    • VoteParty
      • Commands & Permissions
      • Placeholders
      • Configuration
      • API
      • Changelogs
        • v2.30
        • v2.29
        • v2.28
        • v2.27
        • v2.26
        • v2.25
        • v2.24
        • v2.23
        • v2.22
        • v2.21
        • v2.20
        • v2.19
        • v2.18
        • v2.17
        • v2.16
        • v2.15
        • v2.14
        • v2.13
        • v2.12
        • v2.11
        • v2.10
        • v2.9
        • v2.8
        • v2.7
        • v2.6
        • v2.5
        • v2.4
        • v2.3
        • v2.2
        • v2.1
  • piggy's barn
    • Java
      • Gradle
        • Argument
        • Tutorial
      • How to run your minecraft server(s) in IntelliJ
      • How to run your program in IntelliJ
      • Hot Swapping
      • Cheat Sheet
  • ADDITIONAL RESOURCES
    • Discord
    • Paste
    • YAML Parser
    • Java Docs
Powered by GitBook
On this page
  • Syntax
  • Material
  • Data
  • Amount
  • Dynamic Amount
  • Model Data
  • NBT Tags
  • Banner Meta
  • Base Color
  • Item Flags
  • Potion Effects
  • Entity Type
  • RGB
  • Display Name
  • Lore
  • Slot
  • Priority
  • View Requirement
  • Update
  • Enchantments
  • Hide Enchantments
  • Hide Attributes
  • Hide Effects
  • Hide Unbreakable
  • Unbreakable
  • (Shift) Left/Middle/Right click Commands
  • (Shift) Left/Middle/Right click Requirement
Edit on GitHub
  1. HelpChat Plugins
  2. DeluxeMenus
  3. Options & Configurations

Item

All item related options & configurations

PreviousGUINextRequirements

Last updated 1 year ago

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:

  • (STONE).

  • Player head (head-extended_clip).

    • Placeholder head (head-%player_name%, basehead-%player_basehead_placeholder%, etc.).

  • Argument placeholder head (head-{target}).

  • (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/

  • (hdb-<ID>).

  • material (itemsadder-namespace:name)

  • material (oraxen-oraxen_item_id)

  • 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 placeholder materials!

material: WOOL
data: 5

Data

data: #

Supported data values:

  • Number (1).

  • Placeholder that returns a number (placeholder-%player_item_in_hand_data%).

Amount

amount: #

Sets the item's amount in the menu.

Dynamic Amount

dynamic_amount: '%placeholder%'

Model Data

model_data: #

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

NBT Tags

nbt_string: '<Key>:<StringValue>'
nbt_strings:
- '<Key>:<StringValue>'
- '<Key>:<StringValue>'
nbt_int: '<Key>:<IntegerValue>'
nbt_ints:
- '<Key>:<IntegerValue>'
- '<Key>:<IntegerValue>'

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

The nbt tags options support PlaceholderAPI placeholders now!

Banner Meta

banner_meta:
- <dyecolor>;<patterntype>
- <dyecolor>;<patterntype>

Allows you to create your custom banners and shields.

Base Color

base_color: <dyecolor>

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

Item Flags

item_flags:
- <ItemFlag>
- <ItemFlag>

Allows you to set item flags.

Potion Effects

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

Entity Type

entity_type: <entitytype>

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

Display Name

display_name: "TEXT"

Lore

lore:
  - "TEXT"
  - "TEXT"

Slot

slot: #

Multiple slots:

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

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

  • Slots start at 0.

Priority

priority: #
  • The highest priority is 0.

  • The lowest priority is 2147483647.

View Requirement

view_requirement: 'EXPRESSION'

Update

update: BOOLEAN # true or false

Enchantments

enchantments:
  - enchantmentid;level
  - enchantmentid;level

Some items cannot have the enchanting glow effect

Hide Enchantments

hide_enchantments: BOOLEAN # true or false

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).

Hide Effects

hide_effects: BOOLEAN # true or false

If set to true, it will hide the potion's effect text beneath the item name.

Hide Unbreakable

hide_unbreakable: BOOLEAN # true or false

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

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"

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"

For version 1.12.2 or older: Check option to specify the data of the item (the number after the colon :). e.g. Lime Wool would be

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

For version 1.12.2 or older: This option will specify the (the number after the colon :) of the item or the item's durability (depends on the option).

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

Deprecated! Should use the new option instead for CustomModelData. You can still use it for other tags tho.

.

.

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

.

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

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

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

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

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

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

Multiple items can be in the same slot, but you'll have to use and options to work properly.

Slots number in a chest

Sets the item priority. It's used if you want different items in the same slot (by using the 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.

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

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

An example showing how the update option works in placeholders

.

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

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

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

Sets the requirements the player should have to click the item (Check the 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 option.

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

Check for all action types and action tags.

placeholder
Dye colors list
Pattern types list
Dye colors list
Item Flags list.
Potion effects list.
Entity types list.
HERE
placeholders
placeholders
Enchantments list
Data
Material
data value
Material
model_data
base_color
material
RGB
potion_effect
view requirement
priority
view requirement
Requirements
priority
hide enchantments
enchantments
Requirements
click commands
BaseHead
HeadDatabase
ItemsAdder
Oraxen
Placeholder
display name
lore
update interval
this page
Material name
this
this