Skip to main content

How to Configure Custom Chat

This guide explains how to set up the chat format on a Minecraft server using the EssentialsX and EssentialsX Chat plugins, and how to connect it with groups from the LuckPerms plugin.

Prerequisites​

Make sure the server already has:

  • EssentialsX plugin
  • EssentialsX Chat plugin
  • LuckPerms plugin
  • Vault plugin
  • PlaceholderAPI plugin (Optional)

All plugins must be active and located in the plugins/ folder.

Chat Format Structure​

The chat format is configured through EssentialsX's config.yml file. File location:

/plugins/Essentials/config.yml

EssentialsX provides several ways to configure the chat format:

1. Global Format​

This section configures the chat format for all players in general:

format: '<{DISPLAYNAME}> {MESSAGE}'

Alternative example (disabled by default):

#format: '{PREFIX}&r {NICKNAME}&7 »&r {MESSAGE}'
#format: '{PREFIX}&r {NICKNAME}&r {SUFFIX}&r » {MESSAGE}'

To enable it, remove the # sign in front of the line you want.

2. Format by Group​

If you want a different format for each group (for example admin, moderator, vip), use the group-format section. Example:

group-formats:
  default: '{PREFIX} {NICKNAME} »&6 {MESSAGE}'
  admin: '{PREFIX} {NICKNAME} &e»&f {MESSAGE}'
  moderator: '{PREFIX} {NICKNAME} &c»&e {MESSAGE}'
  vip: '{PREFIX} {NICKNAME} &d»&b {MESSAGE}'

Notes:

  • Group names must match the groups in LuckPerms.
  • If you use group aliases in LuckPerms, use those alias names.
  1. Format by Chat Type (Optional) EssentialsX also supports different formats for chat types such as normal, question, and shout. Example (disabled by default):
#format:
#  normal: '{WORLDNAME} {DISPLAYNAME}&7:&r {MESSAGE}'
#  question: '{WORLDNAME} &4{DISPLAYNAME}&7:&r {MESSAGE}'
#  shout: '{WORLDNAME} &c[{GROUP}]&r &4{DISPLAYNAME}&7:&c {MESSAGE}'

To enable it, remove the # sign and adjust it as needed.

Integration with LuckPerms​

To connect the chat format with LuckPerms groups. if the group doesn't exist yet:

  1. Create the group in LuckPerms:
/lp creategroup admin
/lp creategroup moderator
/lp creategroup vip
  1. Assign the group to a player:
/lp user <player_name> parent set <group_name>

Example:

/lp user Violid parent set admin
  1. Make sure the group names in group-formats match the group names in LuckPerms.

Reload Configuration​

After you finish editing, reload EssentialsX:

/essentials reload

Or restart the server to make sure all changes are applied. Troubleshooting

  • If the chat format doesn't change, make sure EssentialsX Chat is active.
  • Check whether the group names in config.yml match the groups in LuckPerms.
  • Use /lp listgroups to see the list of available groups.
  • Check the console for error messages during startup or reload.

References​