• Stars
    star
    159
  • Rank 235,916 (Top 5 %)
  • Language
    Java
  • License
    Apache License 2.0
  • Created about 3 years ago
  • Updated 3 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

A modern, cross-server player data synchronisation system

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/MongoDB 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+) or MongoDB 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:

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

More Repositories

1

HuskHomes

The powerful & intuitive homes, warps, and teleportation suite
Java
120
star
2

breaking-bad-ds

Breaking Bad, as a Nintendo DS game.
C++
119
star
3

Velocitab

A beautiful and versatile TAB list plugin for Velocity proxies
Java
93
star
4

HuskChat

A simple & customizable no-frills Minecraft chat system
Java
78
star
5

HuskTowns

A simple and elegant proxy-compatible Towny-style protection plugin
Java
74
star
6

PAPIProxyBridge

A bridge library plugin for using PlaceholderAPI on proxy servers
Java
36
star
7

HuskClaims

A clean, cross-server compatible grief prevention plugin
Java
30
star
8

BCSDS

Better Call Saul for the Nintendo DS.
C
25
star
9

SchematicUpload

Provide a web server interface for uploading schematics to your server
Java
13
star
10

WebSchematics

Render Minecraft schematics on the web natively in-browser
JavaScript
13
star
11

Annotaml

A library for reading/writing YAML files to/from Java classes using annotations
Java
10
star
12

HuskHomesGUI

Show your HuskHomes homes and warps in an easy-to-use GUI menu
Java
9
star
13

SignSearch

A simple and fast SpigotMC plugin that lets you search text of nearby signs
Java
6
star
14

DesertWell

A library providing about menus & update checking for Minecraft projects
Java
5
star
15

HuskTemplate

A template for multi-platform Minecraft projects, targeting Minecraft 1.16.5+ and Java 16 environments.
Java
4
star
16

PagineDown

A library for generating paginated MineDown-formatted chat menu lists
Java
3
star
17

ProfanityCheckerAPI

Java API for checking profanity via the alt-profanity-checker python library
Java
3
star
18

AndJam

API for sending Toast messages on Spigot
Java
3
star
19

Uniform

A cross-platform wrapper library for making Brigadier commands
Java
3
star
20

HuskTownsDocs

OLD REPOSITORY - SEE https://github.com/WiIIiam278/HuskTowns
2
star
21

mineget

A node wrapper for a number of Minecraft marketplaces to easily get aggregated resource statistics.
TypeScript
2
star
22

flesh

Frontend Vue.js / Nuxt.js web app for William278.net
Vue
1
star
23

MPDBDataConverter

Convert MySQLPlayerDataBridge data to Spigot API data
Java
1
star
24

HSLDataConverter

Deserialize legacy HuskSync (v1.x) data for conversion to other formats
Java
1
star
25

HuskTownsAPI

The API module of HuskTowns
Java
1
star
26

HuskConfirmDrops

Java
1
star
27

carcass

A Python CLI tool for quickly spinning up a network of proxied Minecraft servers
Python
1
star
28

YamlConfig

Bukkit-style library for config file loading & reading
Java
1
star
29

ClopLib

Minecraft server library for handling events that take place in varying positions within game worlds
Java
1
star
30

WiIIiam278

Hello, I'm William278 πŸ‘‹
1
star
31

Shulkolored

Simple Minecraft Java plugin for Dogcraft that gives Shulker enemies a 10% chance to spawn in with a random color
Java
1
star