GroupeZ Docs

Introduction

Introduction to zEssentials - A comprehensive essentials plugin for Minecraft servers

Welcome to the official zEssentials documentation!

zEssentials is a comprehensive, modular essentials plugin for Paper Minecraft servers, built with modern architecture and extensive API support. It provides all the core commands and systems needed to run a Minecraft server.

Paper only

Since version 1.0.4.0, zEssentials is a Paper plugin and requires Paper (or a fork such as Purpur, Pufferfish or Folia) 1.20.6+. Spigot is no longer supported: on Spigot the plugin stays inactive and only displays a warning. See Installation for details.

Key Features

Modular Architecture

Every feature is an independent module that can be enabled or disabled individually:

  • Economy - Multi-currency system with Vault integration, payments and baltop
  • Homes - Player homes with permission-based limits, plus public homes, shared homes, categories, favorites and EssentialsX import
  • Kits - Configurable kit system with cooldowns and categories
  • Teleportation - TPA (with queue and toggle), back, top, bottom, random teleport
  • Spawn & Warps - Spawn, first spawn and warp management
  • Sanctions - Ban, mute, kick, freeze with history and configurable /seen
  • Chat - Chat formatting, interactive chat, item display, ping sound, broadcast
  • Private Messages - /msg, /reply, social spy and an ignore system (/ignore, /unignore, /ignorelist)
  • Mailbox - Offline item delivery and text mails (/mail send, /mail read...) for offline players
  • Custom Commands - Create your own commands (/discord, /map, /store...) directly from the configuration
  • Scoreboard - Dynamic per-player scoreboards with animations
  • Holograms - Text, item, and block holograms
  • Vaults - Personal player storage vaults
  • Voting - Vote tracking and vote party system
  • WorldEdit - Built-in building tools
  • Death Message - Customizable death messages per cause
  • Automatic Messages - Scheduled broadcast announcements
  • Discord - Webhook notifications and account linking
  • AFK - Away From Keyboard detection
  • Rules, Steps, Join/Quit, Items - And many more utilities

Persistent Player Settings

  • Per-player time and weather (/ptime, /pweather) are saved and re-applied on reconnection
  • Player options (vanish, god, social spy, teleport toggles, ping sound...) are stored in the database

Multiple Storage Backends

  • SQLite - Quick setup for testing
  • MySQL / MariaDB - Recommended for production
  • HikariCP - Connection pooling for high-performance
  • JSON - Flat-file storage (limited feature set)

Extensive Compatibility

  • Minecraft 1.20.6, 1.21 - 1.21.11 and 26.2 supported
  • Paper (recommended), Purpur, Pufferfish and other Paper forks
  • Folia compatible (regionised threading)
  • Java 21+ required (Java 25 for Minecraft 26.x)

Rich Integrations

Developer API

  • Clean, modular API with 250 interface and class files
  • Custom events for all major actions
  • Service-based architecture
  • Full PlaceholderAPI expansion

Data Migration

Built-in converters from:

  • EssentialsX
  • CMI
  • CoinsEngine
  • HuskHomes
  • PlayerVaultX
  • AxVaults
  • Sunlight

Requirements

RequirementVersion
ServerPaper (or fork) 1.20.6 or higher
Java21 or higher (25 for Minecraft 26.x)
zMenuLatest version
PlaceholderAPILatest version

Support

Download

Installation

How to install and configure zEssentials on your Minecraft server

On this page

Key FeaturesModular ArchitecturePersistent Player SettingsMultiple Storage BackendsExtensive CompatibilityRich IntegrationsDeveloper APIData MigrationRequirementsQuick LinksSupportDownload
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.