GroupeZ Docs
Configurations

Custom Commands

Create custom commands to open your inventories

zMenu allows you to create custom commands that open your inventories. Instead of using /zm open shop, players can simply type /shop.

Configuration File

Custom commands are defined in plugins/zMenu/commands/commands.yml.

Basic Structure

commands:
  shop:
    command: shop
    inventory: shop_menu

This creates the /shop command that opens the shop_menu inventory.

Configuration Options

Summary Table

KeyTypeRequiredDescription
commandStringYesMain command players will type
inventoryStringYesName of the inventory to open
permissionStringNoPermission required to use the command
deny-messageStringNoMessage shown when user lacks permission
aliasesListNoAlternative command names
argumentsListNoCommand arguments with validation
actionsListNoActions executed when command runs
actions-requirementsListNoRequirements checked before executing actions; blocks execution on fail
console-can-useBooleanNoDefaults to false. If true, allows the console to execute the command

command

Required. The command players will type.

command: shop

inventory

Required. The inventory to open when the command is used. You can optionally prefix with the plugin name.

inventory: "shop"  # Opens inventories/shop.yml

# Or with plugin prefix
inventory: "MyPlugin:shop"  # Opens shop inventory from MyPlugin

permission

Optional permission required to use the command.

permission: "myserver.shop"

deny-message

Custom message displayed when a player doesn't have the required permission.

deny-message: "&cYou don't have access to the shop!"

aliases

Alternative command names.

aliases:
  - store
  - market
  - buy

This allows /store, /market, and /buy to work the same as /shop.

actions

Actions to execute when the command is used (before opening the inventory).

actions:
  - type: message
    messages:
      - "&aOpening the shop..."
  - type: sound
    sound: BLOCK_CHEST_OPEN

actions-requirements

Requirements that must be satisfied before the command's actions (and inventory) are executed. If a requirement fails, its deny actions run instead.

actions-requirements:
  requirements:
    - type: permission
      permission: "server.shop"
      deny:
        - type: message
          messages:
            - "&cYou don't have access to the shop!"

See Requirements for all available requirement types.

arguments

Define command arguments with validation and auto-completion.

arguments:
  - name: "category"
    isRequired: false
    auto-completion:
      - "weapons"
      - "armor"
      - "tools"

Argument Options

KeyTypeDescription
nameStringRequired. Identifier for the argument
typeStringValidator type for the argument (see below)
isRequiredBooleanWhether the argument must be provided (default: false)
performMainActionBooleanWhether to execute main command actions when this argument is used (default: true)
auto-completionListSuggested values for tab-completion
actionsListActions to execute specific to this argument

Argument Type Validators

TypeDescription
online-playerValidates that the argument is an online player name
playerValidates that the argument is a player (online or offline)
integerValidates that the argument is a whole number
doubleValidates that the argument is a decimal number
booleanValidates that the argument is true/false
materialValidates that the argument is a valid Minecraft material
worldValidates that the argument is a valid world name
entity-typeValidates that the argument is a valid entity type
locationValidates that the argument is a valid location

Argument Example with Type Validation

arguments:
  - name: "player"
    type: online-player
    isRequired: true
    auto-completion: "@players"
  - name: "amount"
    type: integer
    isRequired: false
    auto-completion:
      - "1"
      - "10"
      - "64"

Examples

Simple Shop Command

commands:
  shop:
    command: shop
    inventory: shop
    permission: "server.shop"
    deny-message: "&cYou need to be a member to access the shop!"
    aliases:
      - store
      - market

Warps Command

commands:
  warps:
    command: warps
    inventory: warps_menu
    permission: "server.warps"
    deny-message: "&cYou don't have permission to use warps!"
    aliases:
      - warp
      - teleport
    actions:
      - type: message
        messages:
          - "&7Opening warps menu..."

Admin Menu

commands:
  adminmenu:
    command: adminmenu
    inventory: admin_panel
    permission: "server.admin.menu"
    aliases:
      - admin
      - apanel
commands:
  menu:
    command: menu
    inventory: main_menu
    aliases:
      - gui
      - m

  help:
    command: help
    inventory: help_menu
    permission: "server.help"

  rules:
    command: rules
    inventory: rules_menu

Server Information

commands:
  info:
    command: /info
    inventory: server_info
    aliases:
      - serverinfo
      - about
    actions:
      - type: sound
        sound: ENTITY_EXPERIENCE_ORB_PICKUP

Multiple Command Files

You can organize commands in multiple files:

plugins/zMenu/commands/
├── commands.yml
├── shop/
│   └── shop_commands.yml
├── admin/
│   └── admin_commands.yml
└── social/
    └── social_commands.yml

Each file follows the same format:

# commands/shop/shop_commands.yml
commands:
  shop:
    command: shop
    inventory: shop_main

  buyweapons:
    command: /buyweapons
    inventory: shop_weapons

Command Arguments

Basic Arguments

commands:
  give-menu:
    command: /givemenu
    inventory: give_menu
    permission: "server.admin"
    arguments:
      - name: "player"
        type: online-player
        isRequired: true
        auto-completion: "@players"  # Auto-complete with online players

Multiple Arguments

commands:
  category:
    command: /category
    inventory: category_menu
    arguments:
      - name: "type"
        isRequired: true
        auto-completion:
          - "weapons"
          - "armor"
          - "tools"
          - "food"
      - name: "page"
        type: integer
        isRequired: false
        auto-completion:
          - "1"
          - "2"
          - "3"

Arguments with performMainAction

Use performMainAction: false to create commands that process arguments without opening the main inventory.

commands:
  pay:
    command: /pay
    inventory: payment_confirm
    arguments:
      - name: "player"
        type: online-player
        isRequired: true
        auto-completion: "@players"
      - name: "amount"
        type: integer
        isRequired: true
        performMainAction: true  # Opens inventory after validation
        actions:
          - type: message
            messages:
              - "&aPreparing payment of %args_1% to %args_0%..."

Arguments with Specific Actions

Each argument can have its own actions that execute when that argument is provided.

commands:
  teleport:
    command: /tp
    permission: "server.teleport"
    arguments:
      - name: "player"
        type: online-player
        isRequired: true
        performMainAction: false  # Don't open inventory
        actions:
          - type: console_command
            commands:
              - "tp %player% %args_0%"
          - type: message
            messages:
              - "&aTeleported to %args_0%!"

Conflicting Commands

If your command conflicts with another plugin:

  1. Change the command name to something unique
  2. Use aliases as the main entry point
  3. Check plugin load order in server configuration

If a command like /shop is taken by another plugin, use a unique command like /zmshop and add /shop as an alias. zMenu will try to register the alias.

Permission Examples

With LuckPerms

# Give permission to use shop
/lp group default permission set server.shop true

# Admin menu for admins only
/lp group admin permission set server.admin.menu true

Deny Message

Players without permission see the default "no permission" message. Customize this in your messages configuration.

Reloading Commands

After modifying command files:

/zm reload command           # Reload all commands
/zm reload command shop      # Reload specific command

Complete Example

# commands/commands.yml
commands:
  # Main server menu
  menu:
    command: menu
    inventory: main_menu
    aliases:
      - gui
      - server
    actions:
      - type: sound
        sound: BLOCK_CHEST_OPEN

  # Shop with permission
  shop:
    command: shop
    inventory: shop_main
    permission: "server.shop"
    aliases:
      - store
      - market
      - buy

  # VIP shop
  vipshop:
    command: /vipshop
    inventory: vip_shop
    permission: "server.vip.shop"
    aliases:
      - vs

  # Warps menu
  warps:
    command: warps
    inventory: warps_menu
    permission: "server.warps"
    aliases:
      - warp
      - w

  # Player profile
  profile:
    command: /profile
    inventory: player_profile
    aliases:
      - stats
      - me

  # Help menu
  help:
    command: /serverhelp
    inventory: help_menu
    aliases:
      - faq
      - info

  # Admin panel
  admin:
    command: /adminpanel
    inventory: admin_menu
    permission: "server.admin"
    aliases:
      - ap
      - adminmenu

Best Practices

  1. Use intuitive names: /shop not /spm
  2. Add useful aliases: Common variations and shortcuts
  3. Set appropriate permissions: Restrict sensitive menus
  4. Keep it organized: Use subfolders for large setups
  5. Document commands: Comment your YAML files
  6. Test thoroughly: Verify commands work as expected

Next Steps

Bedrock Forms

Create native Bedrock Edition forms for players connecting via Geyser/Floodgate

Config.yml

Main configuration file reference

On this page

Configuration FileBasic StructureConfiguration OptionsSummary Tablecommandinventorypermissiondeny-messagealiasesactionsactions-requirementsargumentsArgument OptionsArgument Type ValidatorsArgument Example with Type ValidationExamplesSimple Shop CommandWarps CommandAdmin MenuMenu with CategoriesServer InformationMultiple Command FilesCommand ArgumentsBasic ArgumentsMultiple ArgumentsArguments with performMainActionArguments with Specific ActionsConflicting CommandsPermission ExamplesWith LuckPermsDeny MessageReloading CommandsComplete ExampleBest PracticesNext 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.