Getting Started

This page will go over some basics of using CC2, so you can get straight into using the plugin. For more in-depth coverage of features, commands, and permissions, please see the respective Wiki pages.

Installation

To install and use this plugin, simply download the JAR file from either Spigot or Bukkit, and drop it into your server's plugins folder. On your next server reload or restart, the plugin should load up and be ready to go.

Note: It is recommended that you use a permissions plugin, like LuckPerms, to manage player access to the plugin. If you don't want to do this, only server operators will be able to use the plugin.

SQL Storage Setup

If you would like to connect to a MySQL database to save player data, you can do this through config.yml. Simply set the storage.type value to sql and then update your database settings below. For a description of each setting, please see the Plugin Settings wiki page.

Please note that plugin configuration files are not stored in MySQL or shared across servers - you will need to update any settings on each server. This includes custom colours. These may be supported in a future release if there is a demand for it.

Basic Command Usage

The simplest way to use the plugin is to change your colour with the command /chatcolor <color>, or by using /chatcolor gui to open the colour selection GUI.

Basic colours you can use can be found here (just the number or letter will do, i.e. 4 or c). You can also use hex colours in the format #RRGGBB - to find one you like, you can use a colour picker online, like this one.

There are also a few custom colours that come with the plugin (you can also create your own - see custom-colors.yml!). To view a list of available custom colours, run /chatcolor custom list. You can then select one of these colours with /chatcolor %custom-colour-name. Please see Custom Colours for more details on how to use them.

If at any point you want to return to the default colour, you can use /chatcolor default.

Basic Permissions

There are quite a few permissions in CC2, but the ones that you'll most commonly need can be found below:

Permission	Description
chatcolor.use	This is the base permission, allowing use of the plugin.
chatcolor.change.self	This allows a player to change their own colour.
chatcolor.gui	This allows access to the colour selection GUI.
chatcolor.color.<colour>	Each of these permissions grants access to a specific colour. Examples: chatcolor.color.a and chatcolor.color.8.
chatcolor.modifier.<modifier>	Like the colour one, except for modifiers (bold, italic, etc.). Examples: chatcolor.modifier.l and chatcolor.modifier.o.
chatcolor.custom.<name>	This allows a player access to the given custom colour. Examples: chatcolor.custom.bright-rainbow and chatcolor.custom.blue-rainbow.

In recent versions of the plugin, I've set up the permissions properly so when using a plugin like LuckPerms, you can easily see the available permissions from the web editor or by autocompleting in commands.

Configuring the Plugin

Most aspects of ChatColor can be configured in the config files. These can be found in the ChatColor2 folder in your plugins directory on your server. Here is a quick table briefly explaining what each file is for:

File	Use
config.yml	Plugin settings and database configuration.
messages.yml	You can configure almost all the messages used in ChatColor here.
gui.yml	Here you can customise the GUI, including pages, item metadata, and custom colours.
custom-colors.yml	You can add and remove custom colours in this config.
groups.yml	You can add and remove ChatColor group configurations here.

Colour Strings

Colour Strings are how colours are represented in text format in ChatColor. Please see the Colour Strings wiki page for more information on what these are and how to write and use them.