HuskSync
Spigot — Setup — Docs — Issues


**HuskSync** is a modern, cross-server player data synchronization system that enables the comprehensive synchronization of your user's data across multiple proxied servers. It does this by making use of Redis and a MySQL/Mongo/PostgreSQL to optimally cache data while players change servers. ## Features **⭐ Seamless synchronization** — Utilises optimised Redis caching when players change server to sync player data super quickly for a seamless experience. **⭐ Complete player synchronization** — Sync inventories, Ender Chests, health, hunger, effects, advancements, statistics, locked maps & [more](https://william278.net/docs/husksync/sync-features)—no data left behind! **⭐ Backup, restore & rotate** — Something gone wrong? Restore players back to a previous data state. Rotate and manage data snapshots in-game! **⭐ Import existing data** — Import your MySQLPlayerDataBridge data—or from your existing world data! No server reset needed! **⭐ Works great with Plan** — Stay in touch with your community through HuskSync analytics on your Plan web panel. **⭐ Extensible API & open-source** — Need more? Extend the plugin with the Developer API. Or, submit a pull request through our code bounty system! **Ready?** [It's syncing time!](https://william278.net/docs/husksync/setup) ## Setup Requires a MySQL/Mongo/PostgreSQL database, a Redis (v5.0+) server and any number of Spigot-based 1.17.1+ Minecraft servers, running Java 17+. 1. Place the plugin jar file in the /plugins/ directory of each Spigot server. You do not need to install HuskSync as a proxy plugin. 2. Start, then stop every server to let HuskSync generate the config file. 3. Navigate to the HuskSync config file on each server (~/plugins/HuskSync/config.yml) and fill in both your database and Redis server credentials. 4. Start every server again and synchronization will begin. ## Development To build HuskSync, simply run the following in the root of the repository: ```bash ./gradlew clean build ``` ### License HuskSync is licensed under the Apache 2.0 license. - [License](https://github.com/WiIIiam278/HuskSync/blob/master/LICENSE) Contributions to the project are welcome—feel free to open a pull request with new features, improvements and/or fixes! ### Support Due to its complexity, official binaries and customer support for HuskSync is provided through a paid model. This means that support is only available to users who have purchased a license to the plugin from Spigot, Polymart, Craftaro, or BuiltByBit and have provided proof of purchase. Please join our Discord server if you have done so and need help! ### Translations Translations of the plugin locales are welcome to help make the plugin more accessible. Please submit a pull request with your translations as a `.yml` file. - [Locales Directory](https://github.com/WiIIiam278/HuskSync/tree/master/common/src/main/resources/locales) - [English Locales](https://github.com/WiIIiam278/HuskSync/tree/master/common/src/main/resources/locales/en-gb.yml) ## Links - [Docs](https://william278.net/docs/husksync/) — Read the plugin documentation! - [Spigot](https://www.spigotmc.org/resources/husksync.97144/) — View the Spigot resource page (Also: [Polymart](https://polymart.org/resource/husksync.1634), [Craftaro](https://craftaro.com/marketplace/product/husksync.758), [BuiltByBit](https://builtbybit.com/resources/husksync.34956/)) - [Issues](https://github.com/WiIIiam278/HuskSync/issues) — File a bug report or feature request - [Discord](https://discord.gg/tVYhJfyDWG) — Get help, ask questions (Purchase required) - [bStats](https://bstats.org/plugin/bukkit/HuskSync%20-%20Bukkit/13140) — View plugin metrics --- © [William278](https://william278.net/), 2023. Licensed under the Apache-2.0 License.