Skip to content

Updates

Jump to bottom
Oliver Martin edited this page Apr 29, 2020 · 27 revisions

This page provides instructions for updating MultiChat from one version to another. Please read and follow these instructions very carefully to prevent data loss or corruption.

Updating to v1.9 from v1.8.1

MultiChat 1.9 features a complete re-code of the Spigot and Sponge parts of the plugin. This update acts as a "stepping stone" on the way to version 2.0 which will feature a full re-code for Bungeecord and feature SQL support across the whole of MultiChat. As this version adds several new features, if you do not follow these steps to update carefully then you may corrupt your server files!

Backup

Firstly, as with all MultiChat updates... BACKUP ALL YOUR SERVER FILES! Just in case.

Sponge

If you use Sponge servers, follow these next instructions very carefully!

You might have noticed in the past that MultiChat placed its config file "multichatsponge.yml" in a strange place. It was in your server's root folder, rather than in the separate config folder dedicated to MultiChat.

This has now been ammended. HOWEVER, you need to MANUALLY move the file here before starting your server, otherwise MultiChat will just see the config folder is empty and generate you a blank file.

To do this, follow these simple steps:

  1. Shut down your Sponge server
  2. Locate the root folder of your Sponge server (contains your spongevanilla.jar or spongeforge.jar file)
  3. Copy the file "multichatsponge.yml"
  4. Navigate to your "config" folder in your Sponge root folder
  5. If a subfolder called "multichat" already exists then go into this subfolder, otherwise you will need to create it.
  6. Paste the "multichatsponge.yml" file into this folder. (There may already be a multichatsponge.db file there already. This is just your SQLite database used for nicknames.)
  7. Return to the root folder of your Sponge server
  8. Copy the file "multichat_namedata" (This is your file based nickname storage if you are not using SQL)
  9. Go back to the "config" folder, then the "multichat" subfolder.
  10. Paste the "multichat_namedata" file.

You should now be ready to move on to the next instructions for updating to v1.9.

Spigot

If you use a Spigot server, then you need to re-name the config folder generated by multichat from "MultiChatSpigot" to "MultiChat".

If you do not do this then MultiChat will just generate new config files in the new "MultiChat" folder.

This is part of the effort to combine the spigot and sponge codebase. And to provide consistency across platforms.

Configs

For BOTH Spigot AND Sponge, you need to re-name your config files to "localconfig.yml". The files you need to re-name are shown below:

SPONGE: "multichatsponge.yml" --> "localconfig.yml" SPIGOT: "spigotconfig.yml" --> "localconfig.yml"

For BOTH Spigot AND Sponge you also need to rename your SQLite database file (if using SQL for nicknames and NOT using MySQL).

SPONGE: "multichatsponge.db" --> "multichatlocal.db" SPIGOT: "multichatspigot.db" --> "multichatlocal.db"

For Sponge you need to rename the nickname data file called "multichat_namedata" to "namedata.dat" (in line with Spigot.)

SPONGE: "multichat_namedata" --> "namedata.dat"

Many of the config files now have new options. There are 3 courses of action you can take.

  1. BACKUP all your config files from multichat, then delete the original copies from the multichat folders and the newest versions will be automatically generated by the plugin. You can then manually re-enter all your config options from the backups you took.

  2. Look at the wiki pages for each of the multichat config files and manually add any new options to your existing files. If you are 100% confident you have done this correctly then you can change the version number at the top of the file to 1.8 (Yes... The one that says DO NOT EDIT!) But be warned, if you do this incorrectly then you could run into lots of issues!

  3. Leave your config files as they are (not recommended)... They should still work just fine, but you will obviously not have access to all the new options and this way of running your server is not supported.

If you wish to take option (2) then here is a brief summary of all the new changes to config files to help you with your manual updating process:

  • In config.yml, added globalcommand and localcommand options for aliases in the "Chat Channels" section. Added privacy_settings option to the end of the file in the "Other" section.
  • In joinmessages.yml, added private_welcome and private_welcome_message option to the end of the file.
  • In spigotconfig.yml, added nickname_length_min option in the "Nicknames" section, and also added nickname_sql, and various MySQL options at the bottom.
  • In multichatsponge.yml, added nickname_length_limit, nickname_length_min and nickname_length_limit_formatting options in the "Nicknames" section, and also added nickname_sql, and various MySQL options at the bottom.

SQL

The biggest feature of this new update is MySQL and SQLite functionality for Spigot and Sponge nicknames. In order to use this, PLEASE BACKUP YOUR FILES FIRST! We provide a migration command to convert from the old file based storage to SQL, but errors can occur with any process like this so it is not worth risking losing your data!

Please see the new SQL wiki page for more details on this process.

Sponge

This update includes a load of new features for Sponge. Sponge has lagged behind spigot in terms for functionality, especially for things like nicknames, but no longer! This however does mean there could be lots of new bugs introduced!

Please pay careful attention to the permissions page which features lots of new permissions for sponge!

All of the features for nicknames are now available for sponge as well as spigot.

Other Information

This update includes lots of bug fixes and smaller changes. Commands such as /local and /global can now be used to send messages directly to those channels without swapping to them. You can use /local for example. There are also now aliases for these commands in config.yml to let you use things like /g as a shortcut.

This update adds the /pexecute command that lets you execute commands on your proxy server from spigot / sponge servers. This is the opposite of the /mce (multichat execute) command that was introduced a while ago now that lets you run spigot / sponge commands from the proxy server.

Please see the changelog here for a full list of changes.

Updating to v1.8.1 from v1.8

Nothing is required, see post for more details: https://www.spigotmc.org/resources/multichat.26204/update?update=327216

Updating to v1.8 from v1.7.5

MultiChat 1.8 adds several new features and if you do not follow these steps to update carefully then you may corrupt your server files!

Backup

Firstly, as with all MultiChat updates... BACKUP ALL YOUR SERVER FILES! Just in case.

Configs

Many of the config files now have new options. There are 3 courses of action you can take.

  1. BACKUP all your config files from multichat, then delete the original copies from the multichat folders and the newest versions will be automatically generated by the plugin. You can then manually re-enter all your config options from the backups you took.

  2. Look at the wiki pages for each of the multichat config files and manually add any new options to your existing files. If you are 100% confident you have done this correctly then you can change the version number at the top of the file to 1.8 (Yes... The one that says DO NOT EDIT!) But be warned, if you do this incorrectly then you could run into lots of issues!

  3. Leave your config files as they are (not recommended)... They should still work just fine, but you will obviously not have access to all the new options and this way of running your server is not supported.

If you wish to take option (2) then here is a brief summary of all the new changes to config files to help you with your manual updating process:

  • In config.yml, added globalcommand and localcommand options for aliases in the "Chat Channels" section. Added privacy_settings option to the end of the file in the "Other" section.
  • In joinmessages.yml, added private_welcome and private_welcome_message option to the end of the file.
  • In spigotconfig.yml, added nickname_length_min option in the "Nicknames" section, and also added nickname_sql, and various MySQL options at the bottom.
  • In multichatsponge.yml, added nickname_length_limit, nickname_length_min and nickname_length_limit_formatting options in the "Nicknames" section, and also added nickname_sql, and various MySQL options at the bottom.

SQL

The biggest feature of this new update is MySQL and SQLite functionality for Spigot and Sponge nicknames. In order to use this, PLEASE BACKUP YOUR FILES FIRST! We provide a migration command to convert from the old file based storage to SQL, but errors can occur with any process like this so it is not worth risking losing your data!

Please see the new SQL wiki page for more details on this process.

Sponge

This update includes a load of new features for Sponge. Sponge has lagged behind spigot in terms for functionality, especially for things like nicknames, but no longer! This however does mean there could be lots of new bugs introduced!

Please pay careful attention to the permissions page which features lots of new permissions for sponge!

All of the features for nicknames are now available for sponge as well as spigot.

Other Information

This update includes lots of bug fixes and smaller changes. Commands such as /local and /global can now be used to send messages directly to those channels without swapping to them. You can use /local for example. There are also now aliases for these commands in config.yml to let you use things like /g as a shortcut.

This update adds the /pexecute command that lets you execute commands on your proxy server from spigot / sponge servers. This is the opposite of the /mce (multichat execute) command that was introduced a while ago now that lets you run spigot / sponge commands from the proxy server.

Please see the changelog here for a full list of changes.

Updating to v1.7.5 from v1.7.4

  • No major steps required, just backup all folders as usual in case of errors

Updating to v1.7.4 from v1.7.3

Updating to v1.7.3 from v1.7.2

Updating to v1.7.2 from v1.7.1

Updating to v1.7.1 from v1.7

MultiChat is developed by Revilo410 (Oliver Martin)
To download the latest release: Click Here

Navigation

Setup

Modules

API

Development

Clone this wiki locally