HuskLegacy
/
HuskSync
forked from public-mirrors/HuskSync
1
0
Fork 0
Code Pull Requests Activity
A modern, cross-server player data synchronisation system
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
815 Commits
7 Branches
46 Tags
11 MiB
Java 98.2%
Python 1.8%
 
 
master
dependabot/gradle/xyz.jpenilla.run-paper-2.3.1
dependabot/gradle/org.junit.jupiter-junit-jupiter-api-5.11.0
dependabot/gradle/com.google.guava-guava-33.3.0-jre
dependabot/gradle/org.junit.jupiter-junit-jupiter-params-5.11.0
dependabot/gradle/org.junit.jupiter-junit-jupiter-engine-5.11.0
feat/data-edit-commands
1.3
1.3.2
1.4
1.4-SNAPSHOT
1.4.1
2.0
2.0.1
2.0.2
2.1
2.1.1
2.1.2
2.2
2.2.1
2.2.2
2.2.3
2.2.4
2.2.5
2.2.6
2.2.7
2.2.8
3.0
3.0.1
3.0.2
3.1
3.1.1
3.1.2
3.2
3.2.1
3.3
3.3.1
3.3.2
3.3.3
3.4
3.5
3.5.1
3.5.2
3.5.3
3.6
3.6.1
3.6.2
3.6.3
3.6.4
3.6.5
3.6.6
3.6.7
3.6.8
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'eeb52ac41e'
${ noResults }
Go to file
William eeb52ac41e
deps: bump item-nbt-api to 2.13.2 
support MC 1.21.1
 		3 months ago
.github ci: add bones publishing to CI 4 months ago
bukkit deps: bump item-nbt-api to 2.13.2 3 months ago
common refactor: revert "disable attributes/potion effects by default" 3 months ago
docs docs: update config file 3 months ago
fabric feat: improve server version status text 3 months ago
gradle/wrapper build: bump gradle to 8.8, uniform to 1.1.3 5 months ago
images v3.0: New modular, more compatible data format, new API, better UX (#160) 1 year ago
paper feat: deprecate Toast notifications 3 months ago
test build(deps): bump certifi from 2023.7.22 to 2024.7.4 in /test (#337) 5 months ago
.gitignore v3.0: New modular, more compatible data format, new API, better UX (#160) 1 year ago
HEADER license: Relicense under Apache-2.0 1 year ago
LICENSE v3.0: New modular, more compatible data format, new API, better UX (#160) 1 year ago
README.md docs: update maven README badge 5 months ago
build.gradle build: correct grgit null reference in git-less environments, close #345 (#347) 4 months ago
gradle.properties deps: bump item-nbt-api to 2.13.2 3 months ago
gradlew build: bump gradle to 8.8, uniform to 1.1.3 5 months ago
gradlew.bat build: bump gradle to 8.8, uniform to 1.1.3 5 months ago
settings.gradle feat: add support for Fabric targeting Minecraft 1.20.1 (#217) 5 months ago

README.md

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—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/Mongo/PostgreSQL database, a Redis (v5.0+) server and a network of Spigot (1.17.1+) or Fabric (1.20.1) Minecraft servers, running Java 17+.

  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 17). Builds will be output in /target:

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