Documentation
DisplayComplete

Menus

Build your own graphical menus slot by slot in the web editor, with click actions, animations, custom backgrounds and their own commands.

The menus module lets you build chest menus for your players without touching a file. You place items slot by slot in a visual editor, give them click actions, and open the menu with its own command, from another menu or from a hologram. With the resource pack module, menus can have a custom background and invisible buttons, so the whole screen looks like your own interface.

Note

This module requires the complete edition. See editions.

Features

  • Visual editor. Click a slot to edit it, drag items to move them, select several slots at once, copy, paste, duplicate, fill a row or column, undo and redo.
  • Its own command. Each menu can have a command and aliases, for example /menu or /warps, and an optional permission.
  • Click actions. Each item runs a list of actions in order when clicked, with a different list for right click if you want.
  • Item looks: any Minecraft item, an item image from your pack, an invisible button, or a player head (the viewer, a player name or a texture).
  • Placeholders. Names, lore and commands accept {player} and PlaceholderAPI placeholders. Names accept colors and pack images.
  • Live refresh. Texts and placeholders can refresh every few seconds while the menu is open.
  • Opening animations: cascade, row by row, column by column, spiral, from the center or random, with an optional rising sound.
  • Item animations: glowing pulse, rainbow name, item cycle, blink or bouncing amount.
  • Custom backgrounds. Create a background in the editor (panel, edges, slot style, title band) or import an image. It is added to the resource pack automatically.
  • Hide the inventory. The player's inventory disappears while the menu is open and comes back when it closes. Items are kept safe even if the server stops while the menu is open.
  • Per item permission. Show an item only to players with a permission.
  • Automatic content. Some slots can be filled by other modules: the daily reward of rewards, level, quests and achievements of progress, and places of a leaderboard. Their look adapts to each player.
  • Test in game. While you are connected to the server, open the menu you are editing in game in one click.
  • Network wide. Menus are shared by every server of your network.

A sample menu named main is created the first time, opened with /menu. Edit it or delete it.

Setting it up

Open Menus in the web editor and click New menu. Give it an identifier made of lowercase letters, digits and _.

Setting What it does
Title Title shown at the top of the menu. Colors and placeholders allowed.
Rows From 1 to 6.
Background Pack image shown behind the slots. Classic background keeps the normal chest look.
Command Without the /. Add aliases separated by commas. Empty: the menu only opens from another menu or a hologram.
Permission Permission needed to open the menu. Empty: everyone can open it.
Open sound Sound played when the menu opens.
Refresh Refreshes texts and placeholders while the menu is open, every few seconds. Never by default.
Hide the inventory Hides the player's inventory while the menu is open. With a background, the whole menu screen is yours.
Opening animation Items appear one by one when the menu opens. Choose the style, the speed and whether a rising sound plays at each step.

Items

Field What it does
Look Item, Pack item, Invisible or Head.
Material, Pack item or Head What the item looks like. For a head: the viewer, a player name, a textures.minecraft.net link or a texture value.
Amount Number shown on the item.
Glowing Adds the enchantment glow.
Name Colors, pack images and placeholders allowed. For an invisible button, it is the text shown on hover.
Lore One line per lore line.
Visible with permission Only players with this permission see the item. Empty: visible to everyone.
Custom model Model number from another resource pack. Leave empty otherwise.
Animation None, Glowing pulse, Rainbow name, Item cycle (loops through a list of items), Blink or Bouncing amount.
Automatic content Lets a module fill this slot.
Click actions Actions run in order on click. Without actions, the item is decorative.
Different right click Actions here replace the others on right click.

Click actions

Action What it does
Close the menu Closes the menu.
Open a menu Opens another menu by its identifier. Previous menu can then bring the player back.
Previous menu Goes back to the menu opened before. Closes the menu if there is none.
Player command The player runs the command, for example spawn.
Console command The console runs the command, for example eco give {player} 100.
Message Sends a message to the player.
Sound Plays a sound, for example entity.player.levelup.
Send to a server Sends the player to another server of your network.
Refresh the menu Redraws the menu with fresh values.

General settings

Setting What it does Default
Click sound Played when a button with an action is clicked. ui.button.click
Delay between clicks In ticks (20 ticks = 1 second). Prevents double clicks. 4

Commands

Command What it does Permission
/menus Lists all menus. inglis.menus.admin (operators)
/menus open <menu> [player] Opens a menu for you or for another online player. inglis.menus.admin
Your menu commands Open the menu. The permission set on the menu, or everyone if empty

Tips

  • /menus open <menu> <player> works from the console, so other plugins, NPCs and command blocks can open your menus.
  • Use Invisible buttons on top of a custom background to make clickable areas that match your drawing.
  • A background must be as tall as the menu. If you change the number of rows, the editor tells you to recreate it or import a new image.
  • Holograms can open a menu when clicked, see holograms.