QuickShop v5 migrate guide

NOTICE: If you migrating from any version before 4.0.9.10, please update to 4.0.9.10 first.

Backup your files

Before taking any action, you must create a FULL data backup, including a database and worlds.
QuickShop won't help you backup anything, you must do it by yourself.

Understood what will happen

• 1.13, 1.14 support has been removed.
• PlotSquaredV4 and PlotSquaredV5 support has been removed, we now only support PlotSquaredV6.
• Your database structure will be upgraded and cannot be read by older versions.
  • That means if you don't have a backup of your files, you will cannot back to older QuickShop versions anymore.
• QuickShop now uses an adaptive translation system, the display language will follow the player client language setting.
  • messages.json has been deprecated, migrate to new override translation system or still use static language system.
  • Recommend installing NBTAPI to make sure the sign display is correct.
    • When you update your server to new builds/versions, you also need to update the NBTAPI.
• All APIs have been rewritten.
  • This will break all outdated QuickShop addons/mods, ask the addons/mods developer to make sure addons and mods are ready to go before you upgrade.

Here we go

1. Shut down your server, backup everything.
2. Delete the old QuickShop jar and put the new one (optional to install NBT API and ProtocolLib).
3. Delete config.yml if possible (or you can still keep it, but we don't recommend it).
4. Startup your server, waiting for data upgrading (this may take a while).
5. Shut down your server, re-configure the configuration with the new configuration file.
6. Check if everything works.
7. You're done.

Extra steps

If you have heavily customized translation file (messages.json) before, it should automatically be renamed to messages.json.outdated.

Open that file, Ctrl+A, Ctrl+C to copy the content inside.

Following override translation system guide or static language system guide to setup translation files. If you're really lazy, you can choose to directly paste everything into the new override file. But may cause some problems.