Skip to content

Wirayuda5620/HuskSync

This branch is 326 commits behind WiIIiam278/HuskSync:master.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

059ee6f · Jan 13, 2024
Dec 26, 2023
Jul 12, 2022
Dec 26, 2023
Jan 13, 2024
Dec 26, 2023
Mar 10, 2023
Sep 20, 2023
Dec 19, 2023
Oct 9, 2023
Dec 10, 2023
Sep 20, 2023
Jul 1, 2023
Sep 20, 2023
Nov 10, 2023
Nov 7, 2023
Dec 26, 2023
Mar 10, 2023
Mar 10, 2023
Jul 12, 2022
Oct 9, 2023

Repository files navigation

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 MySQL 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—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!

Setup

Requires a MySQL (v8.0+) database, a Redis (v5.0+) server and any number of Spigot-based 1.16.5+ Minecraft servers, running Java 16+.

  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 the MySQL and Redis database credentials.
  4. Start every server again and synchronization will begin.

Development

To build HuskSync, simply run the following in the root of the repository:

./gradlew clean build

License

HuskSync is licensed under the Apache 2.0 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.

Links


© William278, 2023. Licensed under the Apache-2.0 License.

About

A modern, cross-server player data synchronisation system

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Java 97.3%
  • Python 2.6%
  • Shell 0.1%