Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/wiiiiam278/husksync

A modern, cross-server player data synchronisation system
https://github.com/wiiiiam278/husksync

inventories minecraft spigot syncing

Last synced: 5 days ago
JSON representation

A modern, cross-server player data synchronisation system

Host: GitHub
URL: https://github.com/wiiiiam278/husksync
Owner: WiIIiam278
License: apache-2.0
Created: 2021-10-17T12:11:44.000Z (about 3 years ago)
Default Branch: master
Last Pushed: 2024-05-01T11:42:28.000Z (8 months ago)
Last Synced: 2024-05-01T16:51:51.828Z (8 months ago)
Topics: inventories, minecraft, spigot, syncing
Language: Java
Homepage: https://william278.net/project/husksync
Size: 8.98 MB
Stars: 136
Watchers: 4
Forks: 114
Open Issues: 12
Metadata Files:
- Readme: README.md
- Funding: .github/funding.yml
- License: LICENSE

Awesome Lists containing this project

README

        


    

    

        

    

    

        

    

    

        

     

    


    

        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)

## Compatibility

HuskSync supports the following [compatible versions](https://william278.net/docs/husksync/compatibility) of Minecraft. Since v3.7, you must download the correct version of HuskSync for your server:

|    Minecraft    | Latest HuskSync | Java Version | Platforms     | Support Status               |

|:---------------:|:---------------:|:------------:|:--------------|:-----------------------------|

|     1.21.4      |    _latest_     |      21      | Paper, Fabric | ✅ **Active Release**         |

|     1.21.3      |      3.7.1      |      21      | Paper, Fabric | 🗃️ Archived (December 2024) |

|     1.21.1      |    _latest_     |      21      | Paper, Fabric | ✅ **November 2025** (LTS)    |

|     1.20.6      |      3.6.8      |      17      | Paper         | 🗃️ Archived (October 2024)  |

|     1.20.4      |      3.6.8      |      17      | Paper         | 🗃️ Archived (July 2024)     |

|     1.20.1      |    _latest_     |      17      | Paper, Fabric | ✅ **November 2025** (LTS)    |

| 1.17.1 - 1.19.4 |      3.6.8      |      17      | Paper         | 🗃️ Archived                 |

|     1.16.5      |      3.2.1      |      16      | Paper         | 🗃️ Archived                 |

HuskSync is primarily developed against the latest release. Old Minecraft versions are allocated a support channel based on popularity, mod support, etc:

* Long Term Support (LTS) – Supported for up to 12-18 months

* Non-Long Term Support (Non-LTS) – Supported for 3-6 months

Verify your purchase on Discord and [Download HuskSync](https://william278.net/project/husksync/download) for your server.

## Setup

Requires a [MySQL/MariaDB/Mongo/PostgreSQL database](https://william278.net/docs/husksync/database), a [Redis (v5.0+) server]((https://william278.net/docs/husksync/redis)) and a network of [compatible Spigot or Fabric Minecraft servers](https://william278.net/docs/husksync/compatibility).

1. Place the plugin jar file in the `/plugins` or `/mods` directory of each Spigot/Fabric 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 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 (building requires Java 21). Builds will be output in `/target`:

```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, 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.