Remigio07

Appearance

Installation ​

Follow this guide to properly install ChatPlugin on your server(s).

WARNING

This guide only covers details about the free version. If you are using the premium version, head over to Getting started/Premium version/Installation.

First of all, download the plugin's latest JAR from one of the following plugin marketplaces if you haven't already:

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.

WARNING

Proxy (BungeeCord/Velocity) support is exclusive to the premium version. The following setup is not a replacement of the proxy plugin: some features (like the F3 server name module, the global Staff chat, some placeholders...) will not work and some of them, like the IP lookup, are not optimized.

If you wish to use this mode anyway, put the plugin's JAR in each Bukkit server's plugins folder (or mods for Sponge servers), (re)start the servers 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 and should be fine in most cases.

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; only available on the premium version
  • 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. choose a main server among the ones under your network (it doesn't matter which one)
  2. copy the absolute (full) path of the ChatPlugin/files folder of your main server
  3. paste it into the config.yml of each other server under the proxy at storage.folder
  4. if you have changed the storage method, make sure to use the same one on each server
  5. save each modified config.yml and perform a /chatplugin reload on all active servers
  6. 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