FAQs

This page addresses a number of frequently asked questions about HuskSync.

Frequently Asked Questions

 What data can be synced?

HuskSync supports synchronising a wide range of different data elements, each of which can be toggled to your liking. Please check out the Sync Features page for a full list.

 Are modded items supported?

On Fabric, modded items should usually sync as you would expect with HuskSync. Note that mods which store additional data separate from item NBT on each server may not work as expected. Mod developers — check out the Custom Data API for information on how to get your mod's data syncing!

On Spigot, if you're running HuskSync on Arclight or similar, please note we will not be able to provide you with support, but have been reported to save & sync correctly with HuskSync v3.x+.

Please note we cannot guarantee compatibility with everything — test thoroughly!

 Are MMOItems / SlimeFun / ItemsAdder items supported?

These custom item Spigot plugins should work as expected provided they inject data into item NBT in a standard way.

Please note we cannot guarantee compatibility with everything — test thoroughly!

 What versions of Minecraft does HuskSync support?

Check the Compatibility table. In addition to the latest release of Minecraft, the latest version of HuskSync will support specific older versions based on popularity and mod support.

If your server's version of Minecraft isn't supported by the latest release, there's plenty of older, stable versions of HuskSync you can download, though note support for these versions will be limited.

 What do I need to run HuskSync?

See the Requirements section under Setup.

You need a Database server, a Redis server, and compatible Minecraft servers.

 Is Redis required? What is Redis?

Yes, HuskSync requires a Redis server in addition to a Database server to operate.

Redis is an in-memory database server used for caching data at scale and sending messages across a network. You have a Redis server in a similar fashion to the way you have a MySQL database server. If you're using a Minecraft hosting company, you'll want to contact their support and ask if they offer Redis. If you're looking for a host, I have a list of some popular hosts and whether they support Redis available to view here.

For more information, check our Redis setup instructions.

 How much RAM does my Redis server need?

We recommend your Redis server has 1GB of RAM, and that your Redis server is installed locally (on the same server as your game servers, or at least on the server running your Velocity/BungeeCord/Waterfall proxy).

 Is a Database required? What Databases are supported?

Yes. HuskSync requires both a Database server and a Redis server to operate.

HuskSync supports the following database types:

• MySQL v8.0+
• MariaDB v5.0+
• PostgreSQL
• MongoDB

 How does data syncing work?

HuskSync makes use of both MySQL and Redis for optimal data synchronization. You have the option of using one of two Sync Modes, which synchronize data between servers (DELAY or LOCKSTEP)

When a user changes servers, in addition to data being saved to MySQL, it is also cached via the Redis server with a temporary expiry key. When changing servers, the receiving server detects the key and sets the user data from Redis. When a player rejoins the network, the system fetches the last-saved data snapshot from the MySQL Database.

This approach is able to dramatically improve both synchronization performance and reliability. A few other techniques are used to optimize this process, such as compressing the serialized user data json using Snappy.

 Why doesn't HuskSync sync player economy balances / support Vault?

This is a very common request, but there's a good reason why HuskSync does not support this.

Vault is a plugin that provides a common API for developers to do two things:

1. Developers can implement Vault to create economy plugins
2. Developers can target Vault to modify and check economy balances without having to write code to hook into individual economy plugins

In essence, Vault is beneficial as it allows developers to write less code. A developer only needs to write code that targets the Vault API when you need to do stuff with player economy balances.

Vault itself, however, is not an Economy plugin. The developers of Economy plugins that implement are responsible for writing the implementation code and database systems for creating player economy accounts and updating balances. By extension, this also means it is the responsibility of Economy plugin developers to implement Vault's API in a way that allows that data to be synchronized cross-server; Vault itself does not contain API for doing so.

Most Economy plugins do not support doing this, however, as cross-server support isn't (and historically hasn't) been a priority. MySQLPlayerDataBridge allows you to workaround this and synchronize Vault balances — but as detailed above, since Vault itself is not an economy plugin, the way this works is MySQLPlayerDataBridge has to provide and continually maintain a bespoke laundry list of manual, individual hooks and tweaks for both Economy plugins that implement Vault and other plugins that target Vault.

Implementing a similar system in HuskSync would considerably increase the size of the codebase, lengthen update times, and decrease overall system stability. The much better solution is to use an Economy plugin that implements Vault in a way that works cross-server.

Indeed, there exist economy plugins — such as XConomy and RedisEconomy which do just this, and this is my recommended solution. Need to move from an incompatible Economy plugin? Vault provides methods for transferring balances between Economy plugins (/vault-convert).

 Is HuskSync better than MySQLPlayerDataBridge?

I can't provide a fair answer to this question! What I can say is that your mileage will of course vary.

The performance improvements offered by HuskSync's synchronization method will depend on your network environment and the economies of scale that come with your player count. In terms of featureset, HuskSync does feature greater rollback and snapshot backup/management features if this is something you are looking for.