Easy menu plugin wiki English

日本語版は下から

Overview

EasyMenu Plugin allows custom GUI menus on Minecraft servers, enabling players to execute commands or navigate to other menus with simple clicks.

Requirements

Spigot/paper/purpur 1.16 or higher
Java 17 or higher (Java 21 or higher required when using version 1.x)

Commands & Permissions

/menu
- Description: Opens the main menu
- Target: Players
- Permission: None (Available to all players)
/menureload
- Description: Reloads the configuration files
- Target: Console/Players
- Permission: menu.reload (Default: OP only)

Menu Configuration (config.yml)

Location

plugins/EasyMenuPlugin/config.yml

Example Configuration

# Main menu title (& color codes)
menu-title: "&6Main Menu"

# Sound when opening menu (Sound enum name)
menu-opensound: "ENTITY_PLAYER_LEVELUP"

# Background item (Material enum name)
menu-background-item: "GRAY_STAINED_GLASS_PANE"

# Menu size (multiple of 9, max 54)
menu-size: 54

# Menu items definition list
menu-items:
  - location: "2,2"              # column,row (starts at 1)
    material: "EMERALD"          # item material
    name: "&aBuy Emerald"        # display name
    command: "/buy emerald"      # command to execute
    sound: "ENTITY_EXPERIENCE_ORB_PICKUP"
    close-menu: true
    lore:
      - "&7Click to purchase"
      - "&7Price: 500"
    custom-model-data: 123456
  - location: "8,3"
    material: "PAPER"
    name: "&eHelp"
    command: "sub_help"           # sub_<ID> → submenu help.yml
    close-menu: true

Key Descriptions

location: “column,row” (1-9, 1-(size/9))
material: Bukkit Material
name: Item name (optional)
command:
- /command → Execute server command
- sub_<ID> → Open submenu
sound: Sound to play on click (optional)
close-menu: Whether to close menu after execution
lore: List of description lines
custom-model-data: (1.14+)

Submenu Configuration (/sub/*.yml)

Location

plugins/EasyMenu/sub/<ID>.yml

Sample help.yml

menu-title: "&dHelp Menu"
menu-opensound: "ENTITY_VILLAGER_YES"
menu-background-item: "WHITE_STAINED_GLASS_PANE"
menu-size: 18

menu-items:
  - location: "1,1"
    material: "BOOK"
    name: "&bHow to Use"
    command: "/help shop"
    close-menu: false
    lore:
      - "&7Shop command list"
  - location: "9,2"
    material: "BARRIER"
    name: "&cBack"
    command: "main_mainopen"   # main_mainopen → Return to main menu
    close-menu: true

How to Call Menus

Main menu → command: “sub_<ID>”
Return to main menu from submenu → command: “main_mainopen”

Notes

menu-size must be a multiple of 9 between 9 and 54
Color codes use & (example: &a, &6)
Material/sound names should be in uppercase with underscores
Run /menureload after making configuration changes
Be mindful of server performance when using many items, version 1.x, or beta versions