diff --git a/README.md b/README.md index 7861698c..eb060514 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,58 @@ -# [![HuskSync Banner](images/banner-graphic.png)](https://github.com/WiIIiam278/HuskSync) -[![GitHub CI](https://img.shields.io/github/workflow/status/WiIIiam278/HuskSync/Java%20CI?logo=github)](https://github.com/WiIIiam278/HuskSync/actions/workflows/java_ci.yml) -[![JitPack API](https://img.shields.io/jitpack/version/net.william278/HuskSync?color=%2300fb9a&label=api&logo=gradle)](https://jitpack.io/#net.william278/HuskSync) -[![Support Discord](https://img.shields.io/discord/818135932103557162.svg?label=&logo=discord&logoColor=fff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/tVYhJfyDWG) - -[Documentation, Guides & API](https://william278.net/docs/husksync) · [Resource Page](https://www.spigotmc.org/resources/husksync.97144/) · [Bug Reports](https://github.com/WiIIiam278/HuskSync/issues) - +

+ 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 -![Data snapshot viewer](images/data-snapshot-viewer.png) +**⭐ 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](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. -- Synchronise inventories, ender chests, advancements, statistics, experience points, health, max health, hunger, saturation, potion effects, persistent data container tags, game mode, location and more across multiple proxied servers. -- Create and manage "snapshot" backups of user data and roll back users to previous states on-the-fly. (`/userdata`) -- Preview, list, delete, restore & pin user data snapshots in-game with an intuitive menu. -- Examine the contents of player's inventories and ender chests on-the-fly. (`/inventory`, `/enderchest`) -- Hooks with your [Player Analytics](https://github.com/plan-player-analytics/Plan) web panel to provide an overview of user data. -- Supports segregating synchronisation across multiple distinct clusters on one network. +**⭐ Extensible API & open-source** — Need more? Extend the plugin with the Developer API. Or, submit a pull request through our code bounty system! -## Requirements -* A MySQL Database (v8.0+). -* A Redis Database (v5.0+) -* Any number of proxied Spigot servers (Minecraft v1.16.5+) +**Ready?** [Let's head down town!](https://william278.net/docs/husksync/setup) ## Setup -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. +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. +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: -``` + +```bash ./gradlew clean build ``` @@ -40,25 +62,20 @@ HuskSync is a premium resource. This source code is provided as reference only f - [License](https://github.com/WiIIiam278/HuskSync/blob/master/LICENSE) ## 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. +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. -## Translation +## 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) - -## bStats -This plugin uses bStats to provide me with metrics about its usage: -- [bStats Metrics](https://bstats.org/plugin/bukkit/HuskSync%20-%20Bukkit/13140) - -You can turn metric collection off by navigating to `~/plugins/bStats/config.yml` and editing the config to disable plugin metrics. +- [Locales Directory](https://github.com/WiIIiam278/HuskSync/tree/master/common/src/main/resources/languages) +- [English Locales](https://github.com/WiIIiam278/HuskSync/tree/master/common/src/main/resources/languages/en-gb.yml) ## Links -- [Documentation, Guides & API](https://william278.net/docs/husksync) -- [Resource Page](https://www.spigotmc.org/resources/husksync.97144/) -- [Bug Reports](https://github.com/WiIIiam278/HuskSync/issues) -- [Discord Support](https://discord.gg/tVYhJfyDWG) (Proof of purchase required) +- [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), [Songoda](https://marketplace.songoda.com/marketplace/product/husksync-a-modern-cross-server-player-data-synchronization-system.758)) +- [Issues](https://github.com/WiIIiam278/HuskSync/issues) — View plugin metrics +- [Discord](https://discord.gg/tVYhJfyDWG) — View plugin metrics +- [bStats](https://bstats.org/plugin/bukkit/HuskSync%20-%20Bukkit/13140) — View plugin metrics --- -© [William278](https://william278.net/), 2022. All rights reserved. +© [William278](https://william278.net/), 2023. All rights reserved. \ No newline at end of file diff --git a/images/banner-graphic.png b/images/banner-graphic.png deleted file mode 100644 index b9166c69..00000000 Binary files a/images/banner-graphic.png and /dev/null differ diff --git a/images/banner.png b/images/banner.png new file mode 100644 index 00000000..dbb7a119 Binary files /dev/null and b/images/banner.png differ