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.
455 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 '0fae3484a1'
${ noResults }
Go to file
William 0fae3484a1
Add workflow files, test reporting, maven publishing, docs, bump version 		2 years ago
.github Add workflow files, test reporting, maven publishing, docs, bump version 2 years ago
.scripts MPDBConverter over jitpack 2 years ago
bukkit Add workflow files, test reporting, maven publishing, docs, bump version 2 years ago
common Make case conversion operations use the English locale 2 years ago
docs Add workflow files, test reporting, maven publishing, docs, bump version 2 years ago
gradle/wrapper gradle: Update to Gradle 8.0.2, bump shadow to 8.1.0 2 years ago
images Update README and banner 2 years ago
plugin Merge API module into bukkit for simplicity 2 years ago
.gitignore Refactor package to net.william278; update dependencies & stop shading internal modules 2 years ago
HEADER Add workflow files, test reporting, maven publishing, docs, bump version 2 years ago
LICENSE [ci skip] Update license year (2023) 2 years ago
README.md Add workflow files, test reporting, maven publishing, docs, bump version 2 years ago
build.gradle Add workflow files, test reporting, maven publishing, docs, bump version 2 years ago
gradle.properties Add workflow files, test reporting, maven publishing, docs, bump version 2 years ago
gradlew gradle: Update to Gradle 8.0.2, bump shadow to 8.1.0 2 years ago
gradlew.bat gradle: Update to Gradle 8.0.2, bump shadow to 8.1.0 2 years ago
jitpack.yml MPDBConverter over jitpack 2 years ago
settings.gradle Merge API module into bukkit for simplicity 2 years ago

README.md

HuskSync
Spigot — Setup — Docs — Issues


HuskSync is a modern, cross-server player data synchronisation system that enables the comprehensive synchronisation 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 synchronisation — Utilises optimised Redis caching when players change server to sync player data super quickly for a seamless experience.

⭐ Complete player synchronisation — 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.

Building

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

./gradlew clean build

License

HuskSync is a premium resource. This source code is provided as reference only for those who have purchased the resource from an official source.

Contributing

A code bounty program is in place for HuskSync, where developers making significant code contributions to HuskSync may be entitled to a license at my discretion to use HuskSync in commercial contexts without having to purchase the resource. Please read the information for contributors in the LICENSE file before submitting a pull request.

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

  • Docs — Read the plugin documentation!
  • Spigot — View the Spigot resource page (Also: Polymart, Songoda)
  • Issues — File a bug report or feature request
  • Discord — Get help, ask questions (Proof of purchase required)
  • bStats — View plugin metrics

© William278, 2023. All rights reserved.