EssentialsXChat
Chat formatting module for EssentialsX. Uses Vault to read prefixes, suffixes and groups from permissions plugins such as LuckPerms.
ChatDependencies
What is EssentialsXChat?
EssentialsXChat is the chat-formatting module of the EssentialsX suite. On its own EssentialsX leaves chat plain; add this module and it formats messages with group prefixes and suffixes, supports global and local (range-limited) chat, colour permissions, chat spy and a shout override. It reads rank prefixes through Vault from a permissions plugin such as LuckPerms, which is the standard way a player's rank tag appears before their name. It is deliberately lightweight — exactly enough chat formatting for most servers, integrated with the rest of EssentialsX, without the weight of a full chat suite.
Who it's for: Servers already running EssentialsX that want rank prefixes and basic local/global chat formatting without adding a separate, heavier chat plugin. It is built and maintained by EssentialsX Team and sits in the chat category.
Key features of EssentialsXChat
- Global and local chat
- Group chat formats
- Vault prefix support
- Vault suffix support
- Color permissions
- Chat spy
- Shout override
- EssentialsX keyword support
How to install EssentialsXChat
EssentialsXChat runs on Bukkit, Spigot or Paper servers. Released alongside EssentialsX by the same team; matches EssentialsX's support for current Spigot/Paper versions.
- 1Stop your server, or have it ready to restart. Always back up your world and plugins folder before adding a new plugin.
- 2Download EssentialsXChat.jar (a build matching your server version) and place it in your server's /plugins folder.
- 3EssentialsXChat depends on EssentialsX and Vault; install those first.
- 4Start the server fully. EssentialsXChat generates its configuration files on first launch — stop the server, edit them to taste, then start again.
- 5Confirm it loaded by checking the console for EssentialsXChat on startup, or by running one of its commands in-game.
Note: EssentialsXChat requires both EssentialsX and Vault, plus a permissions plugin (LuckPerms) to supply the prefixes. Drop EssentialsXChat.jar next to EssentialsX in /plugins and restart. Configure the chat format and whether chat is global or local in the EssentialsX config; the module has no separate commands of its own.
EssentialsXChat commands and permissions
Permission nodes
essentials.chat.color- Allows using colour codes in chat messages.
essentials.chat.format- Allows using formatting codes (bold, italic) in chat.
essentials.chat.spy- Lets staff see local/private chat they would not otherwise receive.
essentials.chat.shout- Allows overriding local chat to broadcast a message server-wide.
EssentialsXChat FAQ
Why is my chat not showing rank prefixes?
EssentialsXChat reads prefixes through Vault from your permissions plugin. You need EssentialsX, EssentialsXChat, Vault and a permissions plugin (LuckPerms) all installed, with the prefix set on the group (in LuckPerms via meta setprefix). Missing any of those and the prefix will not appear.
Does EssentialsXChat add commands?
No. It is a formatting module with no commands of its own — it changes how chat is displayed and adds chat-related permissions. Configuration lives in EssentialsX's config file, where you set the chat format and local/global behaviour.
How do I set up local versus global chat?
In the EssentialsX config you enable local chat with a radius so normal messages only reach nearby players, and players use a shout prefix (or the shout permission) to broadcast globally. This is common on roleplay and large survival servers to keep chat readable.
Can I use this without the rest of EssentialsX?
No. EssentialsXChat is a module that depends on the EssentialsX core, so EssentialsX must be installed. If you want chat formatting without EssentialsX, use a standalone chat plugin such as VentureChat instead.
How do players get coloured chat?
Grant essentials.chat.color (and essentials.chat.format for bold/italic). Players with the node can then use colour codes in their messages. Withhold it from regular players if you want to keep chat colours limited to staff or donor ranks.
Features
- Global and local chat
- Group chat formats
- Vault prefix support
- Vault suffix support
- Color permissions
- Chat spy
- Shout override
- EssentialsX keyword support
Permissions
essentials.chatessentials.chat.coloressentials.chat.formatessentials.chat.spyessentials.chat.shoutessentials.msg