There was a problem loading the comments.

Essentials Chat Formatting

Support Portal  »  Knowledgebase  »  Viewing Article

How to setup Essentials Chat Formatting

Essentials chat is what can make your MineCraft server a fun and unique one allowing you to customize the chat formatting on your server.

Essentials allows you to add the following to your chat:
-colored chat
-Factions tags
-and more!

With so much to customize, we truly understand that it can be quite confusing to set up your chat properly, this guide will help you set it up correctly.

This guide assumes that you have logged into your control panel, stopped your server. Note: Its always important to remember to stop your server before making any changes to a configuration file.

You will want to start out by using your FTP. You can use this guide in our knowledgebase to learn how to login your FTP.

Once logged into your FTP, click on your folder labeled "plugins" and then click on the folder labeled "Essentials". Next you will want to locate and edit the file called "config.yml". And editable file will appear within our FTP that will allow you to edit your config.yml right on your FTP. It looks like the image shown below step 2.

Now that you are inside of your config.yml, scroll down to the Essentials Chat section, which will appear like this:
? Now that you have located the Essentials Chat format section it is time to start setting it up how you would like it!

There are a few things to keep in mind while editing the Essentials Chat formatting is that you can use different tags in the format. Here are the tags currently:

{MESSAGE} is the text you type into chatbox.
{GROUP} is the name of the permissions group you are in. requires a permission plugin.
{DISPLAYNAME} is the name of your user with prefix/suffix added.
{WORLDNAME} is the name is the name of the world you are in.
{SHORTWORLDNAME} is the first letter of the world you are in.
{TEAMPREFIX} {TEAMSUFFIX} {TEAMNAME} are your scoreboard team variables.

Below is an example we setup of a very simple Essentials Chat format:
? In this example, the player's username would be the color yellow, the arrow symbols would be orange, and the user's message would be white. Note: For any colors you want to include in your formatting, you should use the Bukkit color codes listed here.

Another thing you can do in Essentials Chat formatting is setting up separate group chat formatting if you are using a permissions plugin.

The group-formats as they are called must be the exact name of the group in the permissions plugin.

For example, if you had a group called Moderator and you wanted the username to be pink instead of yellow from the previous example and wanted the arrows to be dark blue, you would setup the group-format like so:
? You can also add Factions tags to the Essentials Chat format and any other plugin that adds tags that work in the Essentials Chat format.

Here is an example of adding Factions tags from the latest version of Factions to your Essentials Chat formatting:
? The Faction's tags from the latest versions of Factions are:
{factions_relcolor} {factions_roleprefix} {factions_relcolor} {factions_name|rp}

Once your Essentials Chat formatting is setup to your liking, you would simply hit save, and then reload Essentials with this command:
/essentials reload

Once Essentials is reloaded, the chat formatting you setup should take effect!

IMPORTANT NOTE: Essential's config.yml does not support most special symbols and putting those into the config.yml will break the config.yml, so please be careful when adding any and take a backup of the config.yml before hand in case the config.yml does break. This knowledgebase shows you how to backup ALL of your server's files, but to just take a backup of your Essentials config.yml, you can download just that file by checking the box next to it in your FTP, then clicking the download button at the top of your FTP.

Share via
Did you find this article useful?  

Related Articles

© PloxHost