Full YAML Reference

Comprehensive reference of all configuration keys available in EasyMenu 7.

Use in-page search (Ctrl + F or Cmd + F) to instantly locate any key, its specifications, and links to detailed guides.

---

Table of Contents

1. Top-Level Menu Settings
2. Item Element Settings (menu-items)
3. Presentation Settings (presentation)
4. Action Settings (action / actions)
5. Condition Settings (open-when / visible-when / enabled-when / when)
6. Input Form Settings (inputs)
7. Item Component Settings (components)
8. Cooldown Settings (cooldown)
9. Variant Settings (variants)
10. Dynamic Open Command Settings (open-command)

---

1. Top-Level Menu Settings

Configuration keys placed directly at the root of a menu YAML file (main.yml, sub/*.yml).

Configuration Key	Type	Default	Description	Guide Link
menu-title	String	Menu ID	Title displayed at the top of the menu. Color codes and placeholders supported.	Menu Basics
menu-size	Integer	54	Inventory GUI slot count (9, 18, 27, 36, 45, 54).	Inventory GUI
menu-background-item	Material	GRAY_STAINED_GLASS_PANE	Filler material for unassigned slots. Set none to disable.	Menu Basics
menu-opensound	Sound	None	Sound played immediately after opening the menu.	Menu Basics
menu-items	List	[]	List of items (interactive elements) placed in the menu.	Item Settings
dialog	Boolean	false	Shorthand for presentation.mode: native-preferred. Opens as Native Dialog on supported servers.	Native Dialog
presentation	Section	mode: inventory	Detailed display format settings (Inventory GUI / Native Dialog).	Body & Presentation
open-command	Section	None	Registers custom server commands to open this menu (e.g. /shop).	Opening Menus
open-when	Condition	Always	Conditions that must be satisfied to open this menu.	Display & Usage Conditions
open-denied-message	String	Localized default	Message sent to players when open-when conditions fail.	Display & Usage Conditions
body	List	[]	Decorative text and item content rendered above buttons in Native Dialogs.	Body & Presentation
inputs	List	[]	Named input form fields declared for the menu.	Inputs
schema	Integer	None	Reserved for schema versioning (ignored by parser).	-

---

2. Item Element Settings (menu-items)

Configuration keys specified on elements within the menu-items: list.

Configuration Key	Type	Default	Description	Guide Link
id	String	Deterministic	Element identifier. Derived from slot or location if omitted.	Item Settings
slot	Integer	None	Zero-indexed inventory slot (0 to 53).	Item Settings
location	"col,row"	None	One-indexed column and row coordinates (e.g. "5,2").	Item Settings
material	Material	Required	Material name (e.g. DIAMOND, COMPASS).	Item Settings
name	String	Material name	Display name of the item. Color codes and placeholders supported.	Item Settings
lore	String List	[]	Lore lines (becomes button tooltip in Native Dialog mode).	Item Settings
amount	Integer	1	Stack size.	Item Settings
glint	Boolean	None	Gives the item an enchantment glint effect.	Item Settings
custom-model-data	Integer	None	CustomModelData integer for resource packs.	Item Settings
base64	String	None	Base64 skin texture string for PLAYER_HEAD.	Item Settings
components	Section	{}	Modern item components (1.20.5+).	Item Settings
sound	Sound	None	Sound effect played when clicked.	Menu, Message, Sound
close-menu	Boolean	true	Closes the menu after action execution finishes.	Menu, Message, Sound
click-policy	Enum	PRIMARY	Accepted click types (PRIMARY, LEFT, RIGHT, ANY).	Actions Overview
command	String	None	Shorthand command or navigation (sub_<id>, main_mainopen).	Executing Commands
action	Section	None	Single typed action definition.	Actions Overview
actions	List	None	List of typed actions executed sequentially.	Actions Overview
visible-when	Condition	Always	If false, element is completely omitted from the menu.	Display & Usage Conditions
enabled-when	Condition	Always	If false, element is visible but clicking is refused.	Display & Usage Conditions
disabled-message	String	Localized default	Message sent when enabled-when refuses click.	Display & Usage Conditions
cooldown	Duration / Section	None	Rate limit settings for the element.	Cooldown
variants	List	[]	Dynamic overrides based on player conditions.	Variants
input-refs	String List	[]	List of input IDs to collect before running actions.	Inputs

---

3. Presentation Settings (presentation)

Options inside the presentation: block controlling display formats.

Configuration Key	Type	Default	Description	Guide Link
mode	Enum	inventory	Display mode (inventory, native-preferred, native-required, rich-preferred, rich-required, auto).	Body & Presentation
fallback	Boolean	true	Allows falling back to chest UI on unsupported servers.	Body & Presentation
inventory.size	Integer	54	Inventory GUI slot count.	Inventory GUI
inventory.background	Material	GRAY_STAINED_GLASS_PANE	Inventory GUI background filler item.	Inventory GUI
native.columns	Integer	2	Button column count in Native Dialogs (1–3).	Native Dialog
native.button-width	Integer	150	Button width in Native Dialogs.	Native Dialog
native.can-close-with-escape	Boolean	true	Allow closing dialog with Escape key.	Native Dialog
native.pause	Boolean	false	Pause game flag in singleplayer.	Native Dialog

---

4. Action Settings (action / actions)

Properties of the 11 supported typed actions.

Action Type (type)	Parameters	Description	Guide Link
command	command, executor	Executes command as player or console.	Executing Commands
player-command	command	Executes command as the clicking player.	Executing Commands
console-command	command	Executes command with elevated console privileges.	Executing Commands
open-menu	menu	Transitions to specified menu ID (waits for render).	Menu, Message, Sound
close-menu	None	Safely closes the original UI session.	Menu, Message, Sound
message	message	Sends a formatted chat message to player.	Menu, Message, Sound
sound	sound, volume, pitch	Plays a sound effect to player.	Menu, Message, Sound
title	title, subtitle, fade-in, stay, fade-out	Shows an on-screen title banner.	Menu, Message, Sound
teleport	world, x, y, z, yaw, pitch, safe, reset-velocity, no-fall-ticks	Teleports player to world and coordinates.	Advanced Actions
delay	duration	Asynchronously delays subsequent actions without thread blocking.	Advanced Actions
potion-effect	effect, duration, amplifier, ambient, particles	Applies status effects or buffs to player.	Advanced Actions
input	prompt, input-type, min, max, timeout-seconds, command, actions	Prompts player for chat input before proceeding.	Advanced Actions

---

5. Condition Settings (open-when / visible-when / enabled-when / when)

Condition types and operators for access control and conditional branches.

Condition Key	Value Type	Description	Guide Link
permission	String	Player must have the permission node.	Conditions
world	String / List / Section	Checks current world (in / not-in supported).	Conditions
gamemode	String / List	Checks gamemode (SURVIVAL, CREATIVE, ADVENTURE, SPECTATOR).	Conditions
placeholder	Section	Evaluates PlaceholderAPI comparisons (value, operator, compare).	Conditions
all	List	True if ALL conditions in list hold (AND).	Conditions
any	List	True if AT LEAST ONE condition holds (OR).	Conditions
not	Condition	Inverts the child condition outcome (NOT).	Conditions

Comparison Operators (placeholder.operator)

==, !=, >, >=, <, <=, contains, not-contains, starts-with, ends-with

---

6. Input Form Settings (inputs)

Field properties declared in the menu-wide inputs: block.

Configuration Key	Type	Default	Description	Guide Link
id	String	Required	Field identifier (referenced via {input.<id>}).	Inputs
type	Enum	Required	Input type (text, integer, decimal, boolean, option).	Inputs
label	String	None	Prompt label displayed to player.	Inputs
min	Number	None	Minimum numeric value for integer / decimal.	Inputs
max	Number	None	Maximum numeric value for integer / decimal.	Inputs
max-length	Integer	128	Maximum string length for text.	Inputs
initial	Various	None	Initial field value (must satisfy validation constraints).	Inputs
options	List	[]	Option choices for option input (contains id and display).	Inputs
timeout-seconds	Integer	Config default	Timeout limit in seconds.	Inputs

---

7. Item Component Settings (components)

Modern Minecraft components (1.20.5+) in the components: block.

Configuration Key	Type	Description	Guide Link
unbreakable	Boolean	Sets item durability to unbreakable.	Item Settings
max-stack-size	Integer	Maximum stack size (1–99).	Item Settings
damage	Integer	Durability damage value.	Item Settings
max-damage	Integer	Maximum durability value.	Item Settings
repair-cost	Integer	Anvil repair cost.	Item Settings
rarity	Enum	Item rarity (common, uncommon, rare, epic).	Item Settings
item-model	String	1.21.6+ item model reference (e.g. minecraft:bundle).	Item Settings
hide-tooltip	Boolean	Hides item tooltip.	Item Settings
enchantment-glint-override	Boolean	Overrides enchantment glint.	Item Settings

---

8. Cooldown Settings (cooldown)

Options inside the cooldown: block for rate limiting interactions.

Configuration Key	Type	Default	Description	Guide Link
duration	Duration	Required	Cooldown duration (500ms, 5s, 1m, 1h).	Cooldown
bypass-permission	String	None	Exemption permission node.	Cooldown
message	String	Localized default	Rejection message ({remaining} expanded).	Cooldown
key	String	None	Shared group identifier across elements.	Cooldown

---

9. Variant Settings (variants)

Dynamic conditional overrides inside the variants: list.

Configuration Key	Type	Default	Description	Guide Link
id	String	Required	Variant identifier.	Variants
when	Condition	Required	Condition required to activate this variant.	Variants
override	Section	Required	Properties to override when active (name, lore, material, command, etc.).	Variants

---

10. Dynamic Open Command Settings (open-command)

Registration options inside open-command:.

Configuration Key	Type	Default	Description	Guide Link
name	String	Required	Command name (e.g. shop).	Opening Menus
aliases	String List	[]	List of alternate command labels.	Opening Menus
permission	String	None	Permission required to run command.	Opening Menus
permission-default	Boolean / String	op	Default permission target (true for all, false/op for OPs).	Opening Menus