Opening menus
The ways players can open a menu: a command, a hotbar item, the F key, or clicking an NPC or mob.
DraftThis page is a first draft and may change.
Players can always open any page with /pane and its address, for example /pane shop. In the
builder, the Opening panel adds more ways for each page. Pick as many as you like.
A command
Give the page its own command, without the slash. With shop, players type /shop. Command names
are lower-case letters, numbers, _ and -, up to 24 characters.
If the game or another plugin already has a command with that name, theirs runs and the menu does not open (your server's console says so once). Pick a name no other plugin uses.
A hotbar item
Players get an item in their hotbar that opens the page when they right-click it. Choose:
- Item: what the item looks like, by its id, like
compassornether_star. - Item name: what players see when they hold it.
- Hotbar slot: 1 to 9.
The menu item only looks like the item you pick. It is not a real compass or nether star, so it cannot be crafted with, placed, or sold in a shop.
The menu item stays with the player. They can move it around their own inventory, but they cannot drop it, put it in a chest or any other container, craft with it, or put it in an item frame. They keep it when they die and have it again when they respawn. Each player has one menu item per page: if a player already has something of their own in that slot, their item stays and they do not get the menu item.
The F key
The key that swaps items between hands (F on a computer) opens the page instead. This takes over item swapping on your server, so only use it if your players do not need it.
Clicking an NPC or mob
Players right-click an entity with a tag to open the page. Give an entity the tag with the game's own command, for example:
/tag @e[type=villager,limit=1,sort=nearest] add pane.shop
Then put pane.shop in Clicking an NPC or mob with a tag. This works with villagers, armour
stands and most NPC plugins that use normal entities.
When two pages want the same way in
Two pages can ask for the same command, the same hotbar slot, the F key, or the same NPC tag. The builder warns you under Good to know before you publish. Players get one page for each way in: your main menu first, and otherwise the page whose address comes first from A to Z. The other page keeps its other ways in.
The main menu
Under Menus, the main menu is the page /pane (and /menu) opens with no address.