GroupeZ Docs
ConfigurationsButtonsButton Types

MAIN_MENU Button

Button that opens the configured main menu

The MAIN_MENU button type opens the inventory configured as the main menu in config.yml.

Configuration

First, set the main menu in your config.yml:

# config.yml
main-menu: "main"  # Name of the main menu inventory

Usage

items:
  main-menu:
    type: MAIN_MENU
    slot: 49
    item:
      material: NETHER_STAR
      name: "&6&lMain Menu"
      lore:
        - "&7Return to the main menu"

Difference from HOME

ButtonBehavior
HOMEReturns to the first inventory the player opened in their session
MAIN_MENUAlways opens the specific inventory configured in config.yml

Example scenario:

  • Player opens Shop menu directly via /zm open shop
  • Player navigates: Shop → Swords → Diamond Sword Details
  • HOME would return to Shop (first opened)
  • MAIN_MENU would open the configured main menu (e.g., "main")

Examples

Basic Main Menu Button

items:
  main-menu:
    type: MAIN_MENU
    slot: 49
    item:
      material: NETHER_STAR
      name: "&6&lMain Menu"
    sound: UI_BUTTON_CLICK

Styled Main Menu Button

items:
  main-menu:
    type: MAIN_MENU
    slot: 49
    item:
      material: PLAYER_HEAD
      url: "eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvYzVhMzFjNjQ1MzNlNTRhZmFjZjA0YzNhMTY3YzM4YjBhYjIzMjI3NjdmYjE2MWVmMTU5MjI5YTI4ZmJiN2EifX0="
      name: "&6&l⌂ Main Menu"
      lore:
        - "&7Go to the server's main menu"
        - ""
        - "&e▸ Click to open"
    sound: BLOCK_NOTE_BLOCK_CHIME

In a Navigation Bar

items:
  back:
    type: BACK
    slot: 45
    is-permanent: true
    item:
      material: ARROW
      name: "&c&lBack"

  previous:
    type: PREVIOUS
    slot: 47
    is-permanent: true
    item:
      material: ARROW
      name: "&7Previous"

  main-menu:
    type: MAIN_MENU
    slot: 49
    is-permanent: true
    item:
      material: NETHER_STAR
      name: "&6&lMain Menu"

  next:
    type: NEXT
    slot: 51
    is-permanent: true
    item:
      material: ARROW
      name: "&7Next"

  close:
    slot: 53
    is-permanent: true
    close-inventory: true
    item:
      material: BARRIER
      name: "&c&lClose"

Permanent on All Sub-menus

items:
  main-menu:
    type: MAIN_MENU
    slot: 49
    is-permanent: true
    item:
      material: NETHER_STAR
      name: "&6&lMain Menu"
      lore:
        - "&7Return to main menu"
    sound: UI_BUTTON_CLICK

When to Use

Use MAIN_MENU buttons when:

  • You have a central hub menu players should access from anywhere
  • Players may open sub-menus directly (via commands)
  • You want consistent navigation across all menus
  • Your server has a primary menu that everything branches from

Best Practices

  1. Configure main-menu in config.yml first
  2. Use consistently across all sub-menus
  3. Place centrally - slot 49 is common
  4. Use distinctive icon - Nether star works well
  5. Add to patterns - Include in a navigation pattern for consistency

Creating a Main Menu Pattern

Create a reusable navigation bar with main menu:

# patterns/navigation.yml
name: "navigation"
size: 54

items:
  back:
    type: BACK
    slot: 45
    is-permanent: true
    item:
      material: ARROW
      name: "&c&lBack"
    sound: UI_BUTTON_CLICK

  main-menu:
    type: MAIN_MENU
    slot: 49
    is-permanent: true
    item:
      material: NETHER_STAR
      name: "&6&lMain Menu"
    sound: UI_BUTTON_CLICK

  close:
    slot: 53
    is-permanent: true
    close-inventory: true
    item:
      material: BARRIER
      name: "&c&lClose"
    sound: UI_BUTTON_CLICK

Then use it in your inventories:

# inventories/shop.yml
name: "&6Shop"
size: 54
patterns:
  - "navigation"

items:
  # Your shop items...
  • HOME - Return to first opened inventory
  • BACK - Go back one step
  • INVENTORY - Open specific inventory

Next Steps

JUMP Button

Button that jumps to a specific page

SWITCH Button

Button that displays different items based on conditions

On this page

ConfigurationUsageDifference from HOMEExamplesBasic Main Menu ButtonStyled Main Menu ButtonIn a Navigation BarPermanent on All Sub-menusWhen to UseBest PracticesCreating a Main Menu PatternRelated Button TypesNext Steps
GroupeZ MCP

Documentation in your AI

MCP lets your AI search GroupeZ documentation and read current examples to help you configure your plugins.

Read-only · No documentation API key needed

1. Copy the server URL

Transport: HTTP (Streamable HTTP). Authentication: none. Your tool uses its own model and subscription limits.

  1. Open Plugins in ChatGPT on the web, then + → Add custom MCP server.
  2. Name it ‘GroupeZ Documentation’, paste the URL above and choose ‘No authentication’. Create and install the plugin.
  3. In a conversation, type @ and select the plugin before asking. If needed, enable search, get_page and list_pages in its settings.
Official setup guide

3. Ask a question

Use GroupeZ MCP to help me create a zMenu inventory. Search relevant pages, read the examples and cite your sources.
Other clients and troubleshooting

For clients using mcpServers, adapt this example to their format:

{
  "mcpServers": {
    "groupez-docs": {
      "url": ""
    }
  }
}

Available tools are search, get_page and list_pages. Refresh the connector’s tools after updates. If your AI cannot access them, check that the connector is enabled in the conversation and your account allows custom MCP servers. Opening the URL in a browser is not an MCP test.