Configuration
This page covers ChatControl's files configuration. We have quite a lot of files, but once you understand how they work it'll be very easy to navigate through them.
While editing files, use UTF-8 encoding. Notepad and Wordpad on Windows are broken. Use Notepad++ while on Windows and Sublime Text for Mac and other platforms.
Here's all the files that will appear in your ChatControl folder.
- books/ folder: ChatControl allows you to create and open books for yourself or players, and these books residue in this folder.
- formats/ folder: Your chat can have different outlook for different players or occasions. Each chat's 'style' is called a format and has its own file. Each format contains parts, each of which can be shown or hidden depending on what permission the sender or receiver has, and more.
- localization/ folder: The files inside empower you to change or hide almost all messages we use. 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!
- messages/ folder: Create messages for when your players join, quit, get kicked or die. Or create automated broadcasts in the 'timed.rs' file there. You'll find tons of examples there! To make them work, remove the # letter before them. You can edit those files completely and remove everything. 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."
- data.db file: We store player data here, such as what channels players are in, and more. Do not edit.
- error.log file: Not created unless there's a problem with our plugin. Send this to us and we'll fix it!
- log.csv file: Stores everything that happened in game, you can view this using '/chc log' command."
- mysql.yml file: Not created unless you use MySQL and instructed settings.yml to use this file for logins.
- 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.
- usermap.csv file: Used to stored player names, unique IDs and nicknames. Internal file, do not edit.
To view how these files looked like on a fresh installation, open ChatControl .jar file using WinRar or any unzipping program. You will see these files in their default states in there. Keep in mind you can't edit them because they will be reset.