Documentation
EssentialsFree

Chat

Format chat messages, stop spam, highlight mentions and customize join, quit and welcome messages.

The Chat module controls how messages look in chat, keeps spam under control, lets players ping each other with mentions, and replaces the default join and quit messages with your own.

Features

  • Chat format: every message follows a template you design, with the player's rank prefix, suffix, name color, clan tag, world and server.
  • Color in chat: players with the color permission can write with & color codes, hex colors and gradients.
  • Anti-spam: a minimum delay between two messages, blocking of repeated messages, and automatic lowercasing of messages written mostly in capitals.
  • Mentions: when a player writes another player's name (with or without @), the name is highlighted and the mentioned player hears a sound. Nicknames from the Identity module work too. Players the sender cannot see, such as vanished staff, are never mentioned.
  • Join and quit messages: your own broadcast when a player joins or leaves, and a special broadcast for a player's very first join, showing their player number.
  • Welcome message: a private message sent only to the player who joins, on as many lines as you like.
  • Emojis: when the Resource pack module is on, players can type pack emojis in chat with their code, for example :heart:.

Vanished staff are never counted in the online player count shown in join and quit messages.

Setting it up

Open the Chat module in the web editor. Every message field has an in-game preview and lists the variables you can use. PlaceholderAPI placeholders also work in every message.

Format

Setting What it does Default
Format the chat Applies the message format below. Turn it off if another plugin handles the chat format. On
Message format How each chat message looks. {clan}{prefix}{namecolor}{player}&8 » &7{message}
Color permission Players with this permission can chat in color. inglis.chat.color

Variables for the message format:

Variable Replaced by
{message} The message itself
{player} The player's name, or their nickname if they have one
{displayname} The player's display name
{prefix} Rank prefix
{suffix} Rank suffix
{namecolor} Rank name color
{clan} Clan tag, empty when the player has no clan
{world} The player's world
{server} The server name

Anti-spam

Setting What it does Default
Anti-spam Limits flood, repeats and caps. On
Delay between messages Minimum time between two messages from the same player. 1s
Block repeats Prevents sending the same message twice in a row. On
Max caps (%) Above this share of capital letters, the message is lowercased. 100 turns it off. 70
Minimum checked length Shorter messages are not checked for caps, so "GG" stays as is. 6
Bypass permission Players with this permission ignore anti-spam. inglis.chat.bypass

Mentions

Setting What it does Default
Mentions Highlights a mentioned player's name and plays them a sound. On
Highlight Replaces the mentioned name in the message. Use {player} for the name. &b&l@{player}
Sound Sound played to the mentioned player. Leave empty for no sound. entity.experience_orb.pickup

Join

Setting What it does Default
Join messages Replaces the default join messages. On
Join message Broadcast when a player joins. Variables: {player}, {prefix}, {online}. &8[&a+&8] &7{player}
First join Broadcast on a player's very first join. Variables: {player}, {count} (their player number). &b✦ &fPlease welcome &b{player}&f! &7(player #{count})
Welcome message Sent only to the joining player, one line per chat line. Variables: {player}, {online}, {server}. Two lines: a welcome back and the online count

Quit

Setting What it does Default
Quit messages Replaces the default quit messages. On
Quit message Broadcast when a player leaves. Variables: {player}, {prefix}, {online}. &8[&c-&8] &7{player}

Commands

The Chat module has no commands. Everything is set up from the web editor.

Permissions

Permission What it grants Default
inglis.chat.color Write in color in chat. You can change this node in the Color permission setting. Operators
inglis.chat.bypass Ignore the anti-spam. You can change this node in the Bypass permission setting. Operators

Tips

  • Mentions are part of the chat format: if you turn off Format the chat, mentions stop working too.
  • To give your VIPs colored chat, add inglis.chat.color to their rank in the Ranks module.
  • The texts players see when they are blocked by the anti-spam can be changed in the Messages page of the web editor, in every language.