GroupeZ Docs
Modules

Modules Overview

Overview of all zEssentials modules

zEssentials is built on a modular architecture where each feature is encapsulated in its own independent module. Every module has its own configuration file, located in the modules/ directory, and can be enabled or disabled individually. This design allows you to run only the features your server needs, reducing overhead and avoiding conflicts with other plugins.

Available Modules

The following table lists all 24 modules included in zEssentials:

ModuleConfig FileDescription
AFKmodules/afk/config.ymlAway From Keyboard detection and automatic kick system
AutoMessagemodules/automessage/config.ymlAutomatic broadcast messages at configurable intervals
Chatmodules/chat/config.ymlChat formatting, channels, and moderation tools
Custom Commandsmodules/customcommands/config.ymlCreate your own commands (/discord, /map, /store...) with messages, titles, boss bars and zMenu actions
Death Messagemodules/death_message/config.ymlCustomizable death messages with per-cause configuration
Discordmodules/discord/config.ymlDiscord integration for server-to-Discord communication
Economymodules/economy/config.ymlMulti-currency economy system with Vault integration
Hologrammodules/hologram/config.ymlHolographic text displays in the game world
Homemodules/home/config.ymlPlayer home teleportation system
Itemsmodules/items/config.ymlCustom item definitions and management
JoinQuitmodules/join_quit/config.ymlCustomizable join, quit, and first-join messages with MOTD
Kitsmodules/kits/config.ymlPredefined item kits with cooldowns and permissions
Mailboxmodules/mailbox/config.ymlOffline item delivery and text mails between players
Messagesmodules/messages/config.ymlPrivate messaging and social spy for staff
Rulesmodules/rules/config.ymlServer rules display system
Sanctionmodules/sanction/config.ymlPlayer punishment system (ban, mute, kick, freeze) and /seen
Scoreboardmodules/scoreboard/config.ymlCustomizable sidebar scoreboard display
Spawnmodules/spawn/config.ymlServer spawn point management and teleportation
Stepsmodules/steps/config.ymlStep-based progression and tracking system
Teleportationmodules/teleportation/config.ymlTeleport requests (TPA), back, and random teleport
Vaultmodules/vault/config.ymlPersonal player storage vaults
Votemodules/vote/config.ymlVote reward system for server list voting
Warpmodules/warp/config.ymlServer warp system with optional inventory display
WorldEditmodules/worldedit/config.ymlBuilt-in block manipulation tools with economy integration

Enabling and Disabling Modules

Every module configuration file contains an enable option at the top. To disable a module, set this value to false:

enable: false

To re-enable a module, set it back to true:

enable: true

After changing the enable value in any module's configuration file, you must restart the server for the change to take effect. A simple configuration reload is not sufficient to fully enable or disable a module.

Configuration File Structure

Each module stores its configuration in the following path:

plugins/zEssentials/modules/<module-name>/config.yml

For example, the Economy module configuration is located at:

plugins/zEssentials/modules/economy/config.yml

All modules follow the same general structure: an enable toggle at the top followed by module-specific options. Refer to each module's dedicated documentation page for a complete breakdown of its configuration options, commands, permissions, and placeholders.

Module Dependencies

Most modules operate independently, but some modules interact with each other:

  • The WorldEdit module uses the Economy module to charge players for block operations.
  • The Warp module can use zMenu inventories for GUI-based warp browsing.
  • The Economy module integrates with Vault for third-party plugin compatibility.
  • The JoinQuit, Rules, and AutoMessage modules read message content from messages.yml.
  • The Custom Commands module uses zMenu to run the actions of each command.
  • The Mailbox text mails respect the Sanction mutes and the /ignore list.

Disabling a module that another module depends on may cause the dependent feature to silently degrade. For example, disabling the Economy module will prevent the WorldEdit module from charging players, and operations may fail or become free depending on the implementation.

Main Configuration

Main configuration file (config.yml) for zEssentials

AFK Module

Away From Keyboard detection and kick system

On this page

Available ModulesEnabling and Disabling ModulesConfiguration File StructureModule Dependencies
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.