Upgrading
Unlike most plugins, we have fully automatic upgrade between each version of the same generation. That means you can update from version 10.0.0 to version 10.2.5 by just dragging and dropping the new JAR file to your plugins/ folder. Make sure to remove the old one, though. There may be edge cases, so please read the changelogs.
ChatControl will print messages regarding what we changed in your files. Major files such as settings.yml will retain comments even after updating, but anything you put into # comments will be lost. If there's an unused key, we will move it to settings_unused.yml.
We offer partial automatic migration from ChatControl 8. Simply keep your old folder in plugins/, install ChatControl Red and follow the "/chc migrate chc8" command. Below is what files and folders are migrated for you.
- localization/ folder: not migrated, because a lot of messages have changed and serve different purpose.
- logs/ folder: not migrated, we now use a single log.csv file or MySQL database to store all logs. You can view new logs with /chc log command.
- rules/ folder: migrated automatically but there are exceptions, see Rules for full operator list.
- variables/ folder: migrated automatically, but there are features now working differently, see Variables.
- channels.yml file: migrated automatically.
- data.db file: not migrated, please do not attempt to just place the file over as it will corrupt your data.
- formatting.yml file: migrated automatically we recommend learning how it works now at Formats.
- handlers.yml file: migrated automatically to our new rule group system in rules/groups.rs.
- messages.yml file: not migrated, we use a totally new system for that right now, please see Messages.
- settings.yml file: migrated automatically, but there are exceptions and some settings have changed.
- MySQL database: not migrated, format largely changed you can remove your ChatControl_Data. We now have 3 tables ChatControl, ChatControl_Mail and ChatControl_Log.
To view what's new in ChatControl Red, please see Changelog.
To migrate, use "/chc migrate chc8". Take backups. Downgrading is unsupported at the moment.
We understand how frustrating changing permissions can be, so we try to keep these changes at minimum. Unfortunately sometimes these are unavoidable, especially when systems change.
ChatControl Red has new and edited permissions, see below.
a) If you store permissions in a file, such as permissions.yml or similar, you can use a powerful text editor like Notepad++ or Sublime Text (see Use Right Encoding] to find and replace changed permissions automatically.
b) If you store permissions in a remote database, you can use phpMyAdmin portal that most database providers have to open the appropriate table, find the old permissions and simply change them with one click. Example below with LuckPerms:
Unfortunately, due to the amount of changes, you will need to regenerate your folders. If you spent months creating your rules, don't worry. Almost all of the syntax will work the same, but we still encourage a clean install due to minor changes you will face. Please see Rules and check your operators.