Remigio07

English

Italiano

English

Italiano

Appearance

Installation ​

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

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 also 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.

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.

If you have the free version and want to run ChatPlugin on a network, you have two options:

  • buy the premium version (recommended); it also includes extra modules
  • use the same storage for every server (read the following paragraph)

If you have the premium version, jump to Premium version.

Free version ​

The free version of ChatPlugin cannot be installed on a proxy (BungeeCord/Velocity): to do it you need the premium version.

WARNING

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 every Bukkit server's plugins folder (or mods for Sponge servers) and (re)start the servers.

DANGER

Reloads are also 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.

If the plugin loads without errors, jump to Storage connection.

Premium version ​

Put the plugin's JAR in the following folders:

  • plugins of every Bukkit server
  • mods of every Sponge server
  • plugins of the BungeeCord or Velocity proxy

...and (re)start all the servers, including the proxy.

DANGER

Reloads are also 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 all servers have started, open every server's (excluding the proxy's) ChatPlugin/config.yml file, find the multi-instance-mode section and set:

  • 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

You may want to configure their storage connection before saving.

Storage connection ​

ChatPlugin requires a dedicated storage to handle players' data. The plugin currently supports 5 storage connectors 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 edit manually edit .yml or .json storage files when using one of those connectors.

Multi instance storage ​

Follow this only if you have a multiple instance setup.

MySQL ​

If you wish to use MySQL as storage method, simply specify the same connection settings at storage.database in every server's ChatPlugin/config.yml file, including the proxy.

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 ​

Set storage.folder in the ChatPlugin/config.yml of every server (including the proxy) to the same path. It is recommended to use the proxy's ChatPlugin/files folder, but any path will do.

INFO

A plugin reload is necessary to make effective any change made to the storage settings.

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

Plugin update ​

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

  • stop the server - do not reload if you have to update!
  • upload the new JAR to the plugins or mods folder
  • delete the old JAR file
  • start the server again

The plugin will print some information and may update its libraries and the default configurations if it is required. Don't worry: you will not lose your previous settings, but it is recommended to configure new modules added with the update.

ChatPlugin - A complete yet lightweight plugin which handles just too many features!
© 2024  Remigio07
This wiki is currently updated to version 1.9.10.
Please report any mistakes and misspellings as described at Home/Reporting issues.

Remigio07.me - built w/ VitePress

© 2024  Remigio07