Installation tutorial

Follow these steps to install EasyMenu and open a working menu.

1. Install the JAR

1. Download EasyMenu-6.0.0.jar from the Modrinth distribution page.
2. Put the JAR in the server's plugins folder.
3. Start or restart the server.

EasyMenu creates these files on its first startup.

plugins/EasyMenu/
├── config.yml
├── main.yml
├── lang/
│   ├── en_us.yml
│   ├── ja_jp.yml
│   └── ru_ru.yml
└── sub/
    └── shop.yml

2. Choose a language

Open plugins/EasyMenu/config.yml and change language if needed.

language: "en_us"

Save the file and run this command from the server console.

menu reload

Use /menu reload in the game.

3. Create the first button

Replace plugins/EasyMenu/main.yml with this example.

menu-title: "&6My First Menu"
menu-background-item: "GRAY_STAINED_GLASS_PANE"
menu-size: 27

menu-items:
  - location: "5,2"
    material: "DIAMOND"
    name: "&bGo to Spawn"
    lore:
      - "&7Click to run /spawn"
    command: "/spawn"
    sound: "UI_BUTTON_CLICK"
    close-menu: true

note

Another plugin must provide the /spawn command.

4. Reload and open the menu

Save main.yml, then run these commands in the game.

/menu reload
/menu

The installation is complete when a diamond appears in a 27-slot menu.

If the new files contain an error, reload fails and EasyMenu keeps the last working menu.

Commands

Command	Description
/menu	Open the main menu
/menu reload	Reload settings and every menu
/submenu <ID>	Open a submenu by ID

Permissions

Permission	Description	Default
easymenu.command.reload	Use /menu reload	OP
easymenu.admin	EasyMenu administrator permission	OP

Regular /menu and /submenu use does not require a permission.

Continue with creating menus to change the size and item positions.