GroupeZ Docs
ConfigurationsButtonsButton Types

HOME Button

Button that returns to the first inventory in history

The HOME button type returns the player to the very first inventory they opened in their navigation history. This is useful for deep menu hierarchies where players want to return to the start.

Usage

items:
  home:
    type: HOME
    slot: 49
    item:
      material: NETHER_STAR
      name: "&e&lHome"
      lore:
        - "&7Return to the main menu"

How It Works

Unlike the BACK button which goes one step back, HOME clears the entire history and returns to the first inventory:

  1. Player opens Menu A (root)
  2. Player navigates: A → B → C → D
  3. Player clicks HOME → Returns directly to Menu A
  4. History is cleared

Difference from BACK and MAIN_MENU

ButtonBehavior
BACKGoes to the previous inventory (one step)
HOMEGoes to the first inventory in history
MAIN_MENUOpens the configured main menu (may be different)

Examples

Basic Home Button

items:
  home:
    type: HOME
    slot: 49
    item:
      material: NETHER_STAR
      name: "&e&lHome"
    sound: ENTITY_ENDERMAN_TELEPORT

Styled Home Button

items:
  home:
    type: HOME
    slot: 49
    item:
      material: PLAYER_HEAD
      url: "eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvYzVhMzFjNjQ1MzNlNTRhZmFjZjA0YzNhMTY3YzM4YjBhYjIzMjI3NjdmYjE2MWVmMTU5MjI5YTI4ZmJiN2EifX0="
      name: "&6&l⌂ Home"
      lore:
        - "&7Return to the main menu"
        - ""
        - "&e▸ Click to go home"
    sound: BLOCK_NOTE_BLOCK_CHIME
items:
  back:
    type: BACK
    slot: 45
    is-permanent: true
    item:
      material: ARROW
      name: "&c&l← Back"
    sound: UI_BUTTON_CLICK

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

  home:
    type: HOME
    slot: 49
    is-permanent: true
    item:
      material: NETHER_STAR
      name: "&e&lHome"
    sound: UI_BUTTON_CLICK

  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"

Conditional Home Button

Only show when not at the root menu:

items:
  home:
    type: HOME
    slot: 49
    view-requirement:
      requirements:
        - type: placeholder
          placeholder: "%zmenu_player_previous_inventories%"
          action: SUPERIOR
          value: 0
    item:
      material: NETHER_STAR
      name: "&e&lHome"
    else:
      item:
        material: GRAY_STAINED_GLASS_PANE
        name: "&8"

When to Use

Use HOME buttons when:

  • You have deep menu hierarchies (3+ levels)
  • Users need a quick way to restart navigation
  • Your menus branch into multiple categories

Best Practices

  1. Place centrally - Middle of the navigation bar (slot 49)
  2. Use distinctive icon - Nether star or house-shaped head
  3. Add to all sub-menus - Include in every non-root menu
  4. Combine with BACK - Give users both options
  5. Use is-permanent: true - Always visible on paginated menus

Next Steps

PREVIOUS Button

Button that navigates to the previous page

JUMP Button

Button that jumps to a specific page

On this page

UsageHow It WorksDifference from BACK and MAIN_MENUExamplesBasic Home ButtonStyled Home ButtonNavigation Bar with HomeConditional Home ButtonWhen to UseBest PracticesRelated 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.