Configuration

This page covers ChatControl's folder and its files. We have quite a lot of files, but once you understand how they work it'll be very easy to navigate through them.

WARNING: You must use a compatible text editor to edit our configuration. See Use Right Encoding for more info.

Folder structure

Here are (almost) all files that will appear in your ChatControl folder.

Folders

• books/ folder: Stores books you can create and open for yourself or players, see Books.
• formats/ folder: Stores the different formats to display chat channels, timed, join or other messages with hover/click events. Each format contains parts, each of which can be shown or hidden depending on what permission the sender or receiver has, and more. See Formats.
• images/ folder: Place png or jpg images here and we'll show them in the game in chat, such as with "/chc announce image".
• localization/ folder: The files inside let you change or hide plugin messages. See the 'Locale' key in settings.yml for a list of languages we support, or create your own one by editing messages_en.yml directly! See Localization.
• messages/ folder: Create messages for when your players join, quit or die on this server (for network join/quit/switch, see Proxy and configure messages on the addon itself). Also stores automated broadcasts in the 'timed.rs' file. See Messages for more.
• rules/ folder: Filter any message, command, or even messages from other plugins, edit them or do anything you desire. Create new commands, replace 12 plugins with our powerful rules system. See Rules for documentation.
• variables/ folder: Create placeholders you can use in your formats such as {player_rank} or even by players in the chat such as "I hold and [item]' using JavaScript." See Variables.

Files

• Optional: error.log file: Not created unless there's a problem with our plugin. Send this to us and we'll fix it!
• Optional: log.csv file: Stores everything that happened in game if mysql is disabled, you can view this using '/chc log' command. See Logs.
• mysql.yml file: Lets you configure a database driver such as mysql, sqlite or mariadb to store data.
• proxy.yml file: Lets you configure Proxy.
• settings.yml file: Our main configuration file. Do not edit! Just kidding, you can edit it as you like :) However, any comments will reset back to defaults on restart.

To see the default contend of these files, ChatControl .jar file using WinRar or any unzipping program and you will see these files in their default states in there. Keep in mind you can't edit them there.