Minecraft plugin EssentialsChat

🔌 About EssentialsChat

EssentialsChat — is the chat module for the EssentialsX plugin suite for Minecraft servers. It provides local vs global (shout) chat behaviour, chat formatting controls, and the chat‑related permission nodes used by EssentialsX. EssentialsChat is distributed as a module alongside the main EssentialsX core and requires the main EssentialsX plugin to function.

🎯 Purpose

EssentialsChat addresses chat formatting and message‑distance behaviour on Paper/Spigot servers. Without chat control, large servers may need extra plugins for local chat ranges, shout prefixes, or integrated formatting tied to permission groups.

EssentialsChat lets server owners:

• enforce per‑message formatting rules and color permissions
• set message distance (local chat radius) or make chat global
• allow shout/override prefixes for global messages
• integrate with permission groups for prefixes/suffixes via Vault (when configured)

⚙ Main features

• Configurable local chat distance (set distance or 0 for global). ()
• Shout/local mode with prefix (shout prefix like ! by default) and the /toggleshout convenience behavior (command introduced in the chat work). ()
• Fine‑grained chat permissions (see permissions table) and color/format permissions (essentials.chat.). ()
• Compatibility with Paper/Spigot/CraftBukkit (module requires main EssentialsX). ()

🧩 Who is this for

• Survival, RPG and roleplay servers that want local chat features.
• Servers that already use EssentialsX and want integrated chat formatting.
• Admins who prefer a lightweight chat module integrated with their essentials toolset.

🏗 Usage examples

• Set chat.distance to 50 so normal messages only travel 50 blocks (local chat) while prefixing messages with ! sends them globally.
• Allow certain groups to use RGB colors via essentials.chat.rgb (requires compatible EssentialsX version).
• Use Vault + a permissions plugin to show group prefixes/suffixes in chat formatted by EssentialsChat.

⌨️ Commands

Note: EssentialsX provides several messaging commands (like /msg, /r, /mail, /me) in the main EssentialsX module. EssentialsChat focuses on in‑chat formatting and distance; some messaging commands are part of the core EssentialsX plugin, not the chat module. ()

🔐 Permissions

Only permissions confirmed in official changelogs/docs are listed below. Additional permissions and suffix‑style permissions exist (see Color Permissions). ()

Notes:

• Permissions for color/formatting follow the pattern essentials.chat.<suffix> (for example essentials.chat.color, essentials.chat.format, essentials.chat.rgb where supported). See the EssentialsX color permissions documentation for valid suffixes. ()
• The list above includes only permissions explicitly documented in official changelogs/docs. For a full set of permissions consult the EssentialsX wiki and the module's documentation. ()

⚙ Installation

📥 Installation

• Download the EssentialsX core and the EssentialsX Chat module JAR from the official releases or supported module repository.
• Put the JAR(s) into your server plugins/ folder (EssentialsX main module is required).
• Restart the server (full restart recommended).
• Check console for successful load messages.

📦 Dependencies

• EssentialsX (main module) — required. ()
• Vault — required for group prefix/suffix integration (when you want group metadata in chat). ()
• PlaceholderAPI — optional for advanced placeholders (only if you use placeholders in chat formats).

🧾 Configuration

• Chat settings live under the chat: section of EssentialsX configuration (config.yml) when the Chat module is present. The module reads config values such as chat.distance, shout prefix and related options. ()
• The plugin generates or uses the standard EssentialsX config folder on first run.
• MySQL/SQLite: EssentialsChat itself does not require a database; any database usage is related to other EssentialsX modules (information about DB usage should be taken from the main EssentialsX docs). ()

🧠 Additional information

Known conflicts & limitations

• EssentialsChat is a module and depends on the main EssentialsX core. Do not install the chat module without EssentialsX core. ()
• Some advanced formatting features (RGB, MiniMessage) require newer EssentialsX versions; enable them only if your EssentialsX build supports them. ()
• When multiple plugins modify chat formatting, order and precedence may affect which plugin controls final message format. Test on a staging server before production.

FAQ

Q1: Is EssentialsChat standalone? A1: No — EssentialsChat is a module for the EssentialsX suite and requires the main EssentialsX plugin. ()

Q2: Can I use Vault prefixes in chat? A2: Yes — Vault integration is supported to read group prefixes/suffixes (Vault required). ()

Q3: Does EssentialsChat collect metrics (bStats)? A3: Information absent in official sources regarding chat‑module specific metrics. Check the main EssentialsX project documentation for telemetry details. ()

Q4: Does it support Proxy setups (BungeeCord/Velocity)? A4: EssentialsX is primarily built for Paper/Spigot; proxy compatibility depends on configuration and other modules — consult the main EssentialsX docs and test on staging. ()

Support & community

• Official EssentialsX website and docs, GitHub repository and the project Discord are primary support channels. ()

🤝 When to use EssentialsChat

Use EssentialsChat when you need integrated chat distance, shout/local modes and EssentialsX‑native formatting and permissions on Paper/Spigot servers. It fits servers that already rely on EssentialsX and want chat behaviour managed within the same suite. ()