🎁 Item Options

#Item Options

The plugin builds items in several places — the hotbar items, the entries of every menu, the two states of the PvP mode item and the teleport bow. They share most of their options, so what is on this page works in all of them unless a section says otherwise.

    material: DIAMOND_SWORD
    amount: 1
    custom-model-data: 0
    item-model: ''
    glow: false
    hide-attributes: false
    display-name: '&bExample'
    lore:
    - '&7An example item.'

#Where each option works

Three groups of items exist, and the last two columns are the ones to check before writing an option that does nothing.

Option	Hotbar & custom items	Music & player settings menus
material	Yes	Yes
amount	Yes	Yes
custom-model-data	Yes	Yes
item-model	Yes	Yes
glow	Yes	Yes
hide-attributes	Yes	Yes
display-name, lore	Yes	Yes
enchantments	Hotbar items only	No
hide-enchantments	Hotbar items only	No
The extras below	No	Yes

"Custom items" here means the entries of servers.yml, lobbies.yml and any menu you create.

#The two built-in items

The PvP mode item and the teleport bow are written by hand rather than as normal entries, so they differ slightly:

• The PvP mode item's two states take material, custom-model-data, item-model, display-name, lore, enchantments and hide-enchantments. They have no glow or amount.
• The teleport bow takes everything the hotbar items do. Its glow option changes nothing, because the bow always carries Infinity to fire without ammo being consumed, and that gives it the shimmer regardless.

#Material

The material is the Minecraft item name, such as DIAMOND_SWORD or LIME_DYE. A material your server version does not have leaves the slot empty, so check the name against the version you run.

Player heads have two forms of their own, covered under Player Heads.

#Amount

How many of the item are in the stack. Anything below 1 is treated as 1.

#Resource Pack Options

Two options point an item at a custom model, and which one you use depends on your server version.

Option	Description
custom-model-data	The number your resource pack predicate matches on. Leave it at 0 for none.
item-model	The model to draw, as a namespaced key such as mypack:ruby_sword

    material: DIAMOND_SWORD
    custom-model-data: 1001

    material: DIAMOND_SWORD
    item-model: 'mypack:ruby_sword'

#Enchantments

Each entry is an enchantment and a level, separated by a colon. A level left out counts as 1.

    enchantments:
    - 'SHARPNESS:5'
    - 'UNBREAKING:3'
    - 'MENDING'

An enchantment name your server does not recognise is skipped and the rest of the list still applies, so a typo costs you one enchantment rather than all of them.

#Hide Enchantments

Whether the enchantment lines are printed under the name. It is on by default, which is what keeps a decorated item looking clean in the hotbar.

#Glow

Gives the item the enchanted shimmer without an enchantment on it. It is applied by adding a hidden Unbreaking I, so an item that already carries enchantments of its own keeps those and ignores glow.

#Hide Attributes

Hides the attribute lines a weapon or a piece of armour prints, so a sword in a menu shows only the name and lore you wrote.

On a hotbar item this changes nothing, because hide-enchantments already hides those lines.

#Display Name and Lore

The name and the lines under it. Both accept the usual & colour codes, MiniMessage tags and PlaceholderAPI placeholders.

Set display-name to '' to leave the item with no name at all.

    display-name: '&aGame Menu &7(Right Click)'
    lore:
    - '&7Click here to open the quick compass.'
    - ''
    - '&d%phoenixlobby_proxy_survival% &7currently playing!'

A lore line that reads a placeholder only updates when the item is rebuilt. In a menu that means turning on refresh in its settings; in the hotbar it means the player rejoining or changing world.

#Extras

The music and player settings menus are built on the newer menu system, so their items take a few more options. These are ignored everywhere else.

Option	Description
rgb	Dyes leather armour, written as 255, 80, 0
trim-material, trim-pattern	Puts an armour trim on a piece of armour, both needed
banner-meta	Banner patterns, each written as COLOUR;PATTERN
potion-effects	Effects on a potion, each written as effect;duration;amplifier
enchantment-glint-override	Forces the shimmer on or off, whatever the enchantments say
hide-tooltip	Hides the tooltip of the item completely
tooltip-style	The tooltip style to draw, as a namespaced key

    material: LEATHER_CHESTPLATE
    rgb: '255, 80, 0'
    trim-material: REDSTONE
    trim-pattern: SENTRY

    material: WHITE_BANNER
    banner-meta:
    - 'RED;STRIPE_SMALL'
    - 'BLACK;BORDER'

    material: POTION
    potion-effects:
    - 'speed;600;1'