HuskSync is modern, cross-server player data synchronization system that allows player data (inventories, health, hunger & status effects) to be synchronized across servers through the use of Redis.
- Comprehensive: Synchronize the following player data across-server. All of them can be turned on or off:
- Inventories (& armor, off hand, selected slot)
- Ender Chests
- Experience points & levels
- Health (& Max health, health scale)
- Hunger (& Saturation, exhaustion)
- Game mode
- Advancements
- Statistics (ESC → Statistics menu)
- Location (& Flight status)
- Seamless: Data is centrally cached and distributed on demand via Redis messaging rather than constantly being queried from a database; this means the plugin is able to synchronize data seamlessly - players should have their data updated near-instantaneously.
- Offline Viewing: View and edit the contents of player inventories and ender chests while they are offline.
- Migrate from MySQLPlayerDataBridge easily.
- Open-source with an easy to use Event API.
- /husksync about
- View plugin information
- /husksync update
- Check for updates
- Permission: husksync.command.admin
- /husksync status
- View system status information
- Permission: husksync.command.admin
- /husksync reload
- Reload config & message files
- Permission: husksync.command.admin
- /husksync invsee
- View an offline player's inventory
- Permission: husksync.command.inventory
- /husksync echest
- View an offline player's ender chest
- Permission: husksync.command.ender_chest
- /husksync migrate
- Migrate data from MPDB
Requirements
- A BungeeCord (or derivative, e.g. Waterfall), or a Velocity proxy server
- A Spigot (or derivative, e.g. Paper) game server
- A Redis server
- Install HuskSync in the /plugins/ folder of both your Spigot and Proxy servers.
- Start your servers, then stop them again to allow the configuration files to generate.
- Navigate to the generated config.yml files on your Spigot server and Proxy (located in /plugins/HuskSync/) and fill in the credentials of your Redis server.
- On the Proxy server, you can additionally configure a MySQL database to save player data in, as by default the plugin will create a SQLite database.
- By default, everything except player locations are synchronized. If you would like to change what gets synchronized, you can do this by editing the config.yml files of each Spigot server.
- Once you have finished setting everything up, make sure to restart all of your servers and proxy server. Then, log in and data should be synchronized!