Remigio07

Appearance

Premium version ​

ChatPlugin comes in two packages: the free version, completely open source, and the premium version, which contains several extra features.

It will be published on the following marketplaces soon:

  • SpigotMC - they require developers to have 20 positive reviews first: leave a 5 ⭐ review for the free version!
  • BuiltByBit - I am already working on it
  • Polymart - I will start working on it after BuiltByBit

Installation ​

Follow this guide to properly install the premium version of ChatPlugin on your server(s).

Single instance setup ​

Follow this guide if you have one Bukkit or Sponge server. If you have multiple servers linked through a BungeeCord or Velocity proxy, jump to Multi instance setup.

To begin, simply put the plugin's JAR in your Bukkit server's plugins folder (or mods for Sponge servers) and (re)start the server.

DANGER

Reloads are supported, but make sure you do not overwrite the plugin's JAR while the server is running if the file already exists: doing so will cause lots of errors and no support will be given.

The setup is complete! However, you may want to customize the Storage connection.

Multi instance setup ​

Follow this guide if you have multiple Bukkit or Sponge servers linked through a BungeeCord or Velocity proxy.

Put the plugin's JAR in the following folders:

  • plugins of each Bukkit server
  • mods of each Sponge server
  • plugins of the BungeeCord/Velocity proxy

...then (re)start all the servers and the proxy and read the following paragraph.

DANGER

Reloads are supported, but make sure you do not overwrite the plugin's JAR while the server is running if the file already exists: doing so will cause lots of errors and no support will be given.

Storage connection ​

ChatPlugin requires a dedicated storage to work properly. It is possible to change the method used to store files; H2 is the default option but MYSQL is recommended if available.

The plugin supports 5 storage methods specifiable at storage.method in config.yml:

  • H2: H2 database storage method, default setting; recommended over SQLite
  • SQLITE: SQLite database storage method
  • MYSQL: MySQL database storage method
  • YAML: YAML flat-file storage method
  • JSON: JSON flat-file storage method

DANGER

Do not manually edit .yml or .json storage files when using one of those connectors.

If you have successfully changed the storage method after a reload, you may safely delete the old method's files unless other servers are still using them.

Multi instance storage ​

Follow these steps only if you want to configure multi instance mode:

  1. open the config.yml of each server, find the multi-instance-mode section and set:
    • storage.folder to the path you have just copied
    • enabled to true
    • proxy-online-mode to true if the proxy is running online mode
    • server-id to the ID of that server in the proxy's config at the servers section
    • server-display-name to the server's display name, may include colors
  2. depending on the selected storage method, follow the relevant instructions:
MySQL ​

For the MySQL storage method, open ChatPlugin/config.yml of each server (including the proxy) and specify the same connection settings at storage.database.

Connection error shows up?

It probably means that the specified user is not allowed to connect to the database.

Execute the following command in a shell. Replace username with your user's name (usually root), then enter the password when asked to.

bash
mysql -u username -p

Execute the following commands. Replace username with the user's name (usually root), address with the database's address (usually localhost) and password with the user's password.

sql
ALTER USER 'username'@'address' IDENTIFIED WITH mysql_native_password BY 'password';
FLUSH PRIVILEGES;

Restart the server(s). If errors still show up, please open a ticket on our Discord server.

Other storage methods ​

For other storage methods, open ChatPlugin/config.yml of each server and set storage.folder to the absolute (full) path of the ChatPlugin/files folder of the proxy.

  1. save each modified config.yml and perform a /chatplugin reload on all active servers
  2. check if everything works by executing /chatplugin debug Storage

Plugin update ​

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

  1. stop the server (do not reload if you have to update!)
  2. upload the new JAR to the plugins or mods folder
  3. delete the old JAR file
  4. start the server again

The plugin may update its libraries and default configurations if required, but no previous settings will be overwritten.

It is recommended to configure new modules added with the update. Changelogs can be found on the GitHub repository and the Discord server.

ChatPlugin — A feature-rich and modular chat ecosystem, lightweight and efficient by design.
© 2025  Remigio07
This wiki is currently updated to version 1.10.4.
Please report any mistakes and misspellings as described at Home/Reporting issues.

Remigio07.me - built w/ VitePress

© 2025  Remigio07