GroupeZ Docs
Modules

Kits Module

Configurable kit system with cooldowns and first-join kits

File: modules/kits/config.yml

The Kits module provides a full-featured kit system allowing administrators to create, manage, and distribute item kits to players. Kits support cooldowns, permission restrictions, and GUI-based display modes. Players can receive kits automatically on their first join, and administrators can manage kits entirely through in-game commands and editors.

Source Configuration

enable: true
display: IN_LINE  # IN_LINE, INVENTORY, MULTI_LINE
kits-on-first-join:
  - "tools"

Options

OptionTypeDefaultDescription
enableBooleantrueEnable or disable the Kits module
displayStringIN_LINEThe display mode used when listing available kits. IN_LINE shows kits as a single-line clickable list, INVENTORY opens a chest GUI with kit icons, MULTI_LINE displays each kit on its own line with details
kits-on-first-joinList of Strings["tools"]A list of kit names that are automatically given to players when they join the server for the first time. Leave empty or remove the list to disable first-join kits

Display Modes

The display option controls how kits are presented when a player runs the /kit command without specifying a kit name:

ModeDescription
IN_LINEKits are displayed as a compact, single-line list of clickable kit names. Best for servers with a small number of kits
INVENTORYOpens a chest-style GUI inventory where each kit is represented by its configured material icon. Players click an icon to claim the kit
MULTI_LINEEach kit is displayed on its own line with additional details such as cooldown status and availability. Best for detailed overviews

The INVENTORY display mode provides the most visually appealing experience for players. Each kit's icon material, display name, and lore are configured within the kit definition itself.

Kit Definitions

Kit definitions (items, cooldowns, permissions, display settings) are not configured in this file. Instead, kits are managed through in-game commands and stored as individual YAML files in the plugins/zEssentials/kits/ folder.

Use the following workflow to create and manage kits:

  1. Create a kit: Use /kitcreate <name> to create a new kit from your current inventory.
  2. Edit a kit: Use /kiteditor <name> to open the GUI-based kit editor where you can modify items, cooldowns, permissions, and display settings.
  3. Delete a kit: Use /kitdelete <name> to remove a kit.
  4. Preview a kit: Use /showkit <name> to preview the contents of a kit without claiming it.
  5. Give a kit: Use /kitgive <player> <name> to give a kit to another player, bypassing their cooldown.

Each kit is stored as a separate YAML file in the kits/ directory (e.g., kits/tools.yml). These files are automatically managed by the kit commands and editor. Manual editing is possible but not recommended -- use the in-game editor instead.

First-Join Kits

The kits-on-first-join list specifies which kits are automatically given to players when they join the server for the first time. This is useful for providing starter items, welcome packages, or introductory gear.

kits-on-first-join:
  - "tools"
  - "starter"

Ensure that the kits listed in kits-on-first-join actually exist. If a kit name does not match an existing kit definition, the first-join kit grant will silently fail for that entry.

CommandAliasesPermissionDescription
/kitkitsessentials.kitList available kits or claim a specific kit
/showkit-essentials.kit.showPreview the contents of a kit without claiming it
/kiteditorkeditoressentials.kit.editorOpen the GUI-based kit editor to modify an existing kit
/kitcreatekcreateessentials.kit.createCreate a new kit from your current inventory
/kitdeletekdeleteessentials.kit.deleteDelete an existing kit permanently
/kitgivekgiveessentials.kit.giveGive a kit to another player, bypassing their cooldown

For the full command list, see Commands & Permissions.

PlaceholderDescription
%zessentials_user_has_kit_{name}%Returns true if the player has permission to use the specified kit
%zessentials_user_kit_is_available_{name}%Returns true if the kit is currently available (no active cooldown)
%zessentials_user_kit_time_until_available_{name}%Returns the remaining time until the kit becomes available, in a human-readable format

Replace {name} with the actual kit name. For example, %zessentials_user_kit_is_available_starter% checks whether the starter kit is off cooldown.

For the full placeholder list, see Placeholders.

Example: Starter Kit with First-Join

A typical setup for a server that gives new players a starter kit:

Module config (modules/kits/config.yml):

enable: true
display: INVENTORY
kits-on-first-join:
  - "starter"

Then create the kit in-game:

  1. Place the desired starter items in your inventory.
  2. Run /kitcreate starter.
  3. Run /kiteditor starter to set the cooldown, permission, display name, and icon material.

JoinQuit Module

Customizable join, quit, and first-join messages with MOTD support

Mailbox Module

Offline item delivery and text mails for players, online or offline

On this page

Source ConfigurationOptionsDisplay ModesKit DefinitionsFirst-Join KitsRelated CommandsRelated PlaceholdersExample: Starter Kit with First-Join
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.