GroupeZ Docs
Modules

Rules Module

Server rules display system

File: modules/rules/config.yml

The Rules module provides a configurable system for displaying server rules to players. Rules can be shown either through an interactive zMenu inventory or as chat messages, depending on your preference. The actual rules content is defined separately in messages.yml.

Source Configuration

enable: true
rule-type: INVENTORY  # INVENTORY or MESSAGE

Options

OptionTypeDefaultDescription
enableBooleantrueEnable or disable the Rules module
rule-typeStringINVENTORYHow rules are displayed to the player. Accepts INVENTORY or MESSAGE

Display Modes

  • INVENTORY -- Rules are displayed through a zMenu inventory interface. This provides a rich, interactive GUI where players can browse rules in a paginated menu.
  • MESSAGE -- Rules are sent directly as chat messages. This is simpler and works without zMenu, but offers less visual formatting.

The actual rules text and formatting are configured in messages.yml, not in this configuration file. This module only controls whether the rules system is enabled and which display mode to use.

How It Works

  1. A player executes the /rules command (or one of its aliases).
  2. The plugin checks the configured rule-type.
  3. If set to INVENTORY, the plugin opens a zMenu inventory displaying the rules in a GUI format.
  4. If set to MESSAGE, the plugin sends the rules content directly into the player's chat.
CommandAliasesPermissionDescription
/rules?, help, aideessentials.rulesDisplay the server rules to the player

For the full command list, see Commands & Permissions.

Configuration in messages.yml

To edit the actual rules content displayed to players, modify the rules section in your messages.yml file. The Rules module reads the message entries from there and presents them using the chosen rule-type format.

Example Usage

Inventory Mode

When rule-type is set to INVENTORY, running /rules opens a zMenu GUI. You can customize the inventory layout, item icons, and pagination through your zMenu configuration files.

Message Mode

When rule-type is set to MESSAGE, running /rules outputs the rules directly in chat. This is ideal for servers that want a lightweight solution without requiring players to interact with a GUI.

Messages Module

Private messaging system with reply and social spy support

Sanction Module

Complete moderation system with bans, mutes, kicks, freezes, and sanction history

On this page

Source ConfigurationOptionsHow It WorksRelated CommandsConfiguration in messages.ymlExample UsageInventory ModeMessage Mode
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.