Menu Items

Single slot

Multiple fixed slots

Slots can also be quoted strings — useful when the value comes from a YAML anchor:

Placeholder slot

The placeholder is resolved at compute-time via PlaceholderAPI or internal processors and must evaluate to an integer:

Top-level fields

Basic example

Lore expansion

A lore: line whose placeholder resolves to a list is expanded into one line per element. Surrounding text on the same line is kept on the first produced line only, so such a placeholder is normally the whole line.

An empty list removes the line entirely — the lore line disappears rather than rendering as a blank line or as []. This holds for every list-valued placeholder, not just transformers and lore modifiers.

In a field that renders a single component — an item name, a menu title — there are no extra lines to produce, so a placeholder resolving to an empty list becomes the empty string, and a non-empty list resolves to its first element.

Custom item providers

When the material value contains a -, the substring before the first dash is treated as an ItemStackSupplier namespace and the rest as the provider-specific key.

Built-in namespaces:

Additional namespaces can be registered by plugins — see ItemStackSupplier.

copy-from

copy-from clones the resolved item from another ItemStack placeholder and uses it as the base. Useful for preview menus that display an item the player is interacting with:

persistent-data

persistent-data writes entries into the item's persistent data container (PDC) — hidden NBT that survives being moved between inventories and is readable from any plugin. Each map key is an Adventure Key (namespace:value; a key with no colon falls back to the minecraft namespace), and each value is a YAML scalar:

The persistent data type is inferred from the parsed YAML scalar, not declared:

Anything else (a nested map, a list) fails blueprint loading with Unsupported persistent data type: <class>. Because the type comes from the scalar, a value that looks numeric but is quoted ("3") is stored as a STRING — quote deliberately, and read it back with the matching type or PersistentDataContainer#get returns null.

Values are not placeholder-aware: unlike name, lore or amount, a %placeholder% here is stored verbatim as the literal string. Entries are applied last — after the material, meta and every component, on both the context-free get() and the parser-aware get(parser) path — so an entry overwrites a value of the same key inherited through copy-from. Other keys already on the copied item are left untouched.

armor-trim

Only takes effect on items whose meta is an ArmorMeta.

attributes

A map of Attribute → numeric value (or placeholder). Each entry becomes an AttributeModifier with the ADD_NUMBER operation, registered under the core:attributes namespaced key. Negative values are ignored.

durability

Sets the item's max damage via Damageable#setMaxDamage. Accepts an integer or a placeholder.

equippable

Configures the vanilla equippable component. All fields except slot are optional.

food

Values of 0 or below for nutrition/saturation are skipped (the vanilla defaults remain).

glow

Toggles the enchantmentGlintOverride flag.

A value of false clears any existing override. The value can be a %placeholder%.

hidden-components

Hides a specific subset of the item's data components from the tooltip via the vanilla minecraft:tooltip_display data component (Minecraft 1.21.5+). Unlike hide-tooltip, the tooltip is still shown — only the listed components are suppressed. Replaces any previously-set tooltip_display value.

Each entry is a DataComponentType resolved against Minecraft's component registry — supply the namespaced key form.

Use this to clean up tooltips on display items in menus — hide the attribute_modifiers line on weapon previews, hide enchantments on showcase pieces, etc. — without losing the rest of the tooltip the way hide-tooltip: true does.

hide-tooltip

Hides the entire vanilla tooltip when the player hovers the item.

instrument

Sets the instrument played by a goat horn. The value is a namespaced key from Minecraft's instrument registry. Only applied when the item's meta is a MusicInstrumentMeta (i.e. a GOAT_HORN) — ignored otherwise.

Valid vanilla values: minecraft:ponder_goat_horn, minecraft:sing_goat_horn, minecraft:seek_goat_horn, minecraft:feel_goat_horn, minecraft:admire_goat_horn, minecraft:call_goat_horn, minecraft:yearn_goat_horn, minecraft:dream_goat_horn.

item-model

Sets the item model component (Minecraft 1.21.4+). Accepts an Adventure key.

leather-armor-color

Sets the dye color on leather armor. Accepts any Color form recognised by Configurate (hex string, named color, or RGB map).

model-data

Sets the four lists of the CustomModelDataComponent. Any combination of the four lists is allowed.

Every list supports placeholder resolution as a whole.

potion-effect

Adds a custom PotionEffect to a PotionMeta. The serializer accepts any Configurate-recognised PotionEffect payload.

Applying this clears the base potion type so the custom effect is the only one shown.

potion-color

Sets the liquid color on a POTION/SPLASH_POTION/LINGERING_POTION.

repair-cost

Sets the anvil repair cost.

skull

Sets a SkullMeta's skin. The value can be either a player username, a %placeholder%, or a base64-encoded texture property string. A value that begins with ey and is longer than 20 characters is treated as a base64 texture; otherwise it is treated as a username.

tool

Configures the tool component: default mining speed, damage per block, and per-block / per-tag rules.

A rule must provide exactly one of blocks (list of materials), tag (a Bukkit tag — see the format below), or block (single material). correct-for-drops makes the tool count as the correct tool for the block.

tooltip

Sets the item's tooltip style key. The value must be in the form namespace:key.

tropical-fish-bucket

Only applied if all three fields are set.