Plugin Settings

Plugin Settings (config.yml)

On this page, you can find details about the main configuration file and what each setting does, along with the possible values for each setting. The default config.yml file can be found here. Make sure your YAML file is formatted properly by running it through this site.

---

Special Settings

Key	Description	Values
version	This is the current version of the plugin. It should not be manually changed and will update on each new version that is installed.	N/A (Current version)
stats	This determines whether server statistics are sent to bStats. This doesn't affect your server and all statistics are anonymous.	true or false
default	The server's current default colour can be found here, along with a code. It is recommended that you do not change this manually as it can cause undesired side effects, namely resetting everyone's colour to the default colour. You can change this in-game (see [insert command link here]).	N/A (Change from in-game)
placeholders	Placeholders define parts of a message that won't be colored. For example, with the [item] placeholder, in "Look at my [item]," the text "Look at my" will be colored, while "[item]" stays white. Similarly, with the word "gold," in "I found gold," "I found" would be colored, but "gold" remains unchanged. This ensures compatibility with other plugins that replace placeholders.	List your placeholders under the placeholders: section like this: - '[item]'. Each placeholder should start with a dash (-) and a space on a new line.

Database Settings

Key	Description	Values
storage.type	The type of storage to use for player data.	yaml or sql
database.type	The type of database to connect to.	mysql or mariadb
database.address	The IP address or resolvable host name your database is running on. Defaults to localhost.	Any valid IP address or host name
database.port	The port your database is open to. Defaults to 3306.	Any valid port number
database.name	The name of the database you want the plugin to use. If it doesn't exist, the plugin will try to create a new database with the given name.	Database name, whether it exists or not
database.user	The username to log in to the database with.	Valid username
database.password	The password for the user to log in with.	Valid password

Plugin Settings

Key	Description	Values
event-priority	This controls the priority the chat listener is set to when the server launches. If you are experiencing incompatibilities with other plugins, it is recommended that you try changing this value until the plugins work as intended - often, plugins can clash with each other when accessing the same events.	HIGHEST, HIGH, NORMAL, LOW, LOWEST
auto-save	If enabled, will automatically save player data every X minutes as per the save-interval setting.	true or false
save-interval	The number of minutes between each auto-save.	A number of minutes
color-override	If enabled, this will override any colour codes present in a message with the player's set chat colour. For example, if a player sent the message &cHello, but had the chat colour &a, the colour would be overridden and the message would become &aHello.	true or false
notify-others	If enabled, other players will be notified through chat when their chat colour is changed by another player.	true or false
join-message	If enabled, other players will be given a join message telling them what their current chat colour is.	true or false
confirm-timeout	This is the number of seconds a player has to confirm a setting change from in-game, before having to run the command again. This is a safety measure to protect against accidental setting changes.	A number of seconds
default-color	This is the current default colour of the server. It is recommended that you change this setting from in-game, as changing it manually can cause undesired side effects.	Any valid colour
command-name	This allows you to add an alternative command name to use for /chatcolor. Please note that if you change this manually, ensure that it doesn't clash with any other plugins' commands.	Any valid command name
force-group-colors	If enabled, players will be forced to use their group chat colour, if they have been set one. In other words, they will not be able to change their chat colour, at all, if this is enabled and they are in a CC2 group. Use this if you want group-specific chat colours.	true or false
default-color-enabled	If enabled, then the current default color will be active (new players will be set to the default color). Otherwise, any new players will not have any colour set. The default colour can be changed from in-game (please see [insert page link]).	true or false
command-opens-gui	If enabled, /chatcolor will open the GUI instead of displaying your current colour.	true or false
ignore-symbol-prefixes	If enabled, any messages starting with symbols will not be coloured.	true or false
remove-inaccessible-colors	If enabled, players will have colours/modifiers removed if they do not have permission for them.	true or false