Cheatsheet

Menu author

One-page reference. Names, one-line descriptions, and a link to the full doc for each entry. Ctrl-F friendly.

Activators — what opens a menu

Name	What it does	Detail
command	/menu or any other custom command	docs
chat	Player types an exact phrase in chat	docs
containsChat	Player’s chat message contains a substring	docs
join	Player joins the server	docs
regionJoin	Player enters a WorldGuard region	docs
regionLeave	Player leaves a WorldGuard region	docs
clickItem	Right-click an item in hand	docs
clickNPC	Right-click a Citizens NPC	docs
clickEntity	Right-click an entity	docs
shiftClickEntity	Shift + right-click an entity	docs
clickBlock	Click a specific block location	docs
clickBlockType	Click any block of a given type	docs
button	Press a button block	docs
lever	Flip a lever	docs
plate	Step on a pressure plate	docs
table	Click a sign with specific text	docs
swapItems	Press the swap-hand key (default F)	docs

Rules — checked before opening / before showing an item / before running an action

Name	What it checks	Detail
permission	Player has a permission node	docs
world	Player is in a named world	docs
gamemode	Player’s gamemode matches	docs
group	Player is in a LuckPerms group	docs
money	Player has at least N currency (Vault / configured provider)	docs
level	Player has at least N levels	docs
xp	Player has at least N XP points	docs
health	Player has at least N HP	docs
foodLevel	Player has at least N food	docs
chance	Random check at N percent	docs
online	At least N players online	docs
playerIsOnline	A specific named player is online	docs
inventoryItems	Player has the listed items in their inventory	docs
heldItem	Item in main hand matches	docs
freeSlot	Inventory has a free slot (or a specific slot is free)	docs
freeSlotCount	Inventory has at least N free slots	docs
existVar	A global variable exists	docs
existVarp	A per-player variable exists	docs
placedItem	A drag-and-drop slot has the expected item	docs
region	Player is inside a WorldGuard region	docs
bungeeOnline	A BungeeCord server has at least N players	docs
bungeeIsOnline	A BungeeCord server is online	docs
if	Logical comparison of placeholders / values	docs
js	Run a JavaScript expression	docs
and	All wrapped rules pass	docs
or	At least one wrapped rule passes	docs
oneof	Stops on first true	docs
playerScope	Re-evaluate rules against a different player	docs

Actions — what runs on click / open / activator fire

Name	What it does	Detail
message	Send chat / actionbar / title / json to the player	docs
broadcast	Same shape as message, but to every online player	docs
miniMessage	Send a MiniMessage string (legacy - message already supports MiniMessage)	docs
playerChat	Send a chat message on behalf of the player	docs
print	Print to console - debug helper	docs
command	Run commands as player and/or console	docs
inputChat	Capture chat input into a variable	docs
teleport	Teleport the player to a location	docs
bungeeConnect	Send the player to a BungeeCord server	docs
setGamemode	Change the player’s gamemode	docs
setHealth	Set health	docs
setFoodLevel	Set food level	docs
sound	Play a Bukkit sound	docs
customSound	Play a resource-pack sound	docs
potionEffect	Apply a potion effect	docs
removePotionEffect	Remove a potion effect	docs
openBook	Open a virtual written book	docs
addRecipe	Add a knowledge-book recipe	docs
itemAdd	Add items to the player’s inventory	docs
itemRemove	Remove items by slot or by match	docs
itemClear	Same as itemRemove, ignoring stack count	docs
inventoryClear	Wipe the player’s inventory	docs
openMenu	Open another menu	docs
openMenuCtx	Open another menu, forwarding activator context	docs
closeMenu	Close the current menu	docs
refreshMenu	Re-render the whole menu	docs
refreshItem	Re-render a single item	docs
setProperty	Add or overwrite item properties on the open menu	docs
remProperty	Remove properties from an item in the open menu	docs
setButton	Add or replace a button in the open menu	docs
removeButton	Remove a button from the open menu	docs
placeItem	Drag-and-drop helper to place an item in a draggable slot	docs
removePlaced	Remove (or partially remove) a placed item	docs
pageNext / pagePrev	Switch pages in a generated menu	docs
delay	Run wrapped actions after N ticks	docs
bulk	Run several action groups under one block	docs
randActions	Pick one block at random	docs
playerScope	Run actions for a different player	docs
takeMoney / giveMoney	Currency withdraw / deposit (economy provider)	docs
givePermission / removePermission	Grant / revoke a permission node (permissions provider)	docs
addGroup / removeGroup	Add / remove a group (permissions provider)	docs
lpMetaSet / lpMetaRemove	LuckPerms metadata mutation (LuckPerms required)	docs
giveXp / takeXp	XP credit / debit (levels provider)	docs
giveLevel / takeLevel	Level credit / debit (levels provider)	docs
setSkin / resetSkin	Apply / reset a skin (skins provider)	docs
setVar / removeVar / incVar / decVar / mulVar / divVar	Global variable ops	docs
setVarp / removeVarp / incVarp / decVarp / mulVarp / divVarp	Personal variable ops	docs

If the action is money / level / permission / placeholder / skin related, you can append provider: "vault" (or any other registered id) to pin which backend handles it. See provider handlers.

Item properties

Group	Properties
Material installer	material, texture, skullOwner, hdb, mmoitem, itemsAdder, oraxen, equipItem, serialized
Display	name, lore, nameLight, loreLight, glow, flags, color, model
Mechanics	count, damage, data, unbreakable, enchantments, enchantStore, attributeModifier, potionData, fireworkData, bookData, bannerData, shieldData, recipes, nbt
Slot	slot (number, X-Y, range, matrix)
Cooldown	clickCooldown (milliseconds)
Conditional	bindings (override properties when rules match)

Full reference with examples: item format.

nameLight / loreLight are the legacy variants of name / lore that ignore MiniMessage and only handle & color codes. Useful when a name happens to contain < characters that MiniMessage would try to parse.

Catalogs — for generated menus

Name	What it produces	Detail
iterator	Sequence of integers from start to end	docs
players	Online players	docs
entities	Entities of the viewer’s (or named) world	docs
worlds	Loaded worlds	docs
bungee_servers	BungeeCord servers (requires bungeecord: true)	docs
slice	Split a string into elements by separator	docs

Commands — operator and author

Command	Purpose	Detail
/am open <menu> [player]	Open a menu	docs
/am reload	Reload all menu files	docs
/am serve	Watch & auto-reload (dev)	docs
/am version	Print version	docs
/am addons list	List loaded addons	docs
/am addons info <name>	Addon metadata	docs
/am addons load <name>	Load an addon	docs
/am addons reload <name>	Hot-reload an addon	docs
/am addons rescan	Pick up new jars in addons/	docs
/var subcommands	Manage global variables	docs
/varp subcommands	Manage per-player variables	docs

Single permission gates everything: am.admin.