Installation (premium) - ThatzRemix/ChatPlugin Wiki

Follow this guide to properly install ChatPlugin (premium version) in your server(s).

Download

Buy and download the plugin's latest jar from MC-Market, Polymart or my website if you haven't already.

Multi instance setup

ChatPlugin can be installed on your BungeeCord proxy for synchronization between the Spigot instances under the network. To use this mode put the plugin in every Spigot server's plugins folder and in the Bungee's plugins folder and (re)start all the servers. Please note that reloads are supported (except on BungeeCord, obviously), but you cannot overwrite a JAR (if there was one already) while the server is running: doing so will cause lots of errors and no support will be given. Once the server has started correctly all configurations files should have been created and loaded and you are ready to validate your license. Note: make sure to check the Database connection section to enable this mode.

Single instance setup

You can also choose to install ChatPlugin on a Spigot server only, without synchronization. To do it, simply put the downloaded JAR in your server's plugins folder and (re)start the server. Please note that reloads are supported, but you cannot overwrite a JAR (if there was one already) while the server is running: doing so will cause lots of errors and no support will be given. Once the server has started correctly all configurations files should have been created and loaded and you are ready to validate your license.

License system

The premium version of ChatPlugin requires a valid paid license. You have to specifiy your code (which is sent to you once you have bought the plugin) in config.yml at settings.license-id. The plugin will connect to its license server at every startup, so a working internet connection is required. Make sure the firewall allows connections through the HTTPS protocol (port 443). Once you have specified the code, (re)start the server.

Database connection

Data storage is handled by a database created by the plugin. There are currently three supported database engines: MySQL, SQLite and H2 (recommended over SQLite). You can choose which one to use editing storage.method in config.yml. You can also choose what folder to save the files in and the database name. Encryption is not supported yet for flat-file methods but it will be added soon. A plugin reload is necessary to make effective any change made to the database settings. Note that synchronization between Spigot instances requires a working MySQL database or a shared H2/SQLite local database (edit storage.flat-file.folder specified in every Spigot server's ChatPlugin's config.yml and make them point to the same folder).


Plugin update

To update the plugin to a newer version, follow these steps:

The plugin should print some info saying that the configurations' defaults values have been set; you won't lose any setting: the new default values required for the newer version to be run have been simply added to the file.