\n \u003Ca href=\"https://github.com/WiIIiam278/HuskSync/actions/workflows/ci_master.yml\">\n \u003Cimg src=\"https://img.shields.io/github/actions/workflow/status/WiIIiam278/HuskSync/ci_master.yml?branch=master&logo=github\"/>\n \u003C/a>\n \u003Ca href=\"https://repo.william278.net/#/releases/net/william278/husksync/\">\n \u003Cimg src=\"https://repo.william278.net/api/badge/latest/releases/net/william278/husksync/husksync-common?color=00fb9a&name=Maven&prefix=v\" />\n \u003C/a>\n \u003Ca href=\"https://discord.gg/tVYhJfyDWG\">\n \u003Cimg src=\"https://img.shields.io/discord/818135932103557162.svg?label=&logo=discord&logoColor=fff&color=7389D8&labelColor=6A7EC2\" />\n \u003C/a> \n \u003Cbr/>\n \u003Cb>\n \u003Ca href=\"https://www.spigotmc.org/resources/husksync.97144/\">Spigot\u003C/a>\n \u003C/b> —\n \u003Cb>\n \u003Ca href=\"https://william278.net/docs/husksync/setup\">Setup\u003C/a>\n \u003C/b> — \n \u003Cb>\n \u003Ca href=\"https://william278.net/docs/husksync/\">Docs\u003C/a>\n \u003C/b> — \n \u003Cb>\n \u003Ca href=\"https://github.com/WiIIiam278/HuskSync/issues\">Issues\u003C/a>\n \u003C/b>\n\u003C/p>\n\u003Cbr/>\n\n**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.\n\n## Features\n**⭐ Seamless synchronization** — Utilises optimised Redis caching when players change server to sync player data super quickly for a seamless experience.\n\n**⭐ 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!\n\n**⭐ Backup, restore & rotate** — Something gone wrong? Restore players back to a previous data state. Rotate and manage data snapshots in-game!\n\n**⭐ Import existing data** — Import your MySQLPlayerDataBridge data—or from your existing world data! No server reset needed!\n\n**⭐ Works great with Plan** — Stay in touch with your community through HuskSync analytics on your Plan web panel.\n\n**⭐ Extensible API & open-source** — Need more? Extend the plugin with the Developer API. Or, submit a pull request through our code bounty system!\n\n**Ready?** [It's syncing time!](https://william278.net/docs/husksync/setup)\n\n## Compatibility\nHuskSync 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:\n\n| Minecraft | Latest HuskSync | Java Version | Platforms | Support Status |\n|:---------------:|:---------------:|:------------:|:--------------|:-----------------------------|\n| 1.21.4 | _latest_ | 21 | Paper, Fabric | ✅ **Active Release** |\n| 1.21.3 | 3.7.1 | 21 | Paper, Fabric | 🗃️ Archived (December 2024) |\n| 1.21.1 | _latest_ | 21 | Paper, Fabric | ✅ **November 2025** (LTS) |\n| 1.20.6 | 3.6.8 | 17 | Paper | 🗃️ Archived (October 2024) |\n| 1.20.4 | 3.6.8 | 17 | Paper | 🗃️ Archived (July 2024) |\n| 1.20.1 | _latest_ | 17 | Paper, Fabric | ✅ **November 2025** (LTS) |\n| 1.17.1 - 1.19.4 | 3.6.8 | 17 | Paper | 🗃️ Archived |\n| 1.16.5 | 3.2.1 | 16 | Paper | 🗃️ Archived |\n\nHuskSync is primarily developed against the latest release. Old Minecraft versions are allocated a support channel based on popularity, mod support, etc:\n\n* Long Term Support (LTS) – Supported for up to 12-18 months\n* Non-Long Term Support (Non-LTS) – Supported for 3-6 months\n\nVerify your purchase on Discord and [Download HuskSync](https://william278.net/project/husksync/download) for your server.\n\n## Setup\nRequires 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).\n\n1. 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.\n2. Start, then stop every server to let HuskSync generate the config file.\n3. Navigate to the HuskSync config file on each server and fill in both your database and Redis server credentials.\n4. Start every server again and synchronization will begin.\n\n## Development\nTo build HuskSync, simply run the following in the root of the repository (building requires Java 21). Builds will be output in `/target`:\n\n```bash\n./gradlew clean build\n```\n\n### License\nHuskSync is licensed under the Apache 2.0 license.\n\n- [License](https://github.com/WiIIiam278/HuskSync/blob/master/LICENSE)\n\nContributions to the project are welcome—feel free to open a pull request with new features, improvements and/or fixes!\n\n### Support\nDue 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!\n\n### Translations\nTranslations 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.\n\n- [Locales Directory](https://github.com/WiIIiam278/HuskSync/tree/master/common/src/main/resources/locales)\n- [English Locales](https://github.com/WiIIiam278/HuskSync/tree/master/common/src/main/resources/locales/en-gb.yml)\n\n## Links\n- [Docs](https://william278.net/docs/husksync/) — Read the plugin documentation!\n- [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/))\n- [Issues](https://github.com/WiIIiam278/HuskSync/issues) — File a bug report or feature request\n- [Discord](https://discord.gg/tVYhJfyDWG) — Get help, ask questions (Purchase required)\n- [bStats](https://bstats.org/plugin/bukkit/HuskSync%20-%20Bukkit/13140) — View plugin metrics\n\n---\n© [William278](https://william278.net/), 2025. Licensed under the Apache-2.0 License.\n",[21,24,27,30],{"id":22,"url":23},"spigot","https://www.spigotmc.org/resources/husksync.97144/",{"id":25,"url":26},"polymart","https://polymart.org/resource/husksync.1634",{"id":28,"url":29},"builtbybit","https://builtbybit.com/resources/husksync.34956/",{"id":31,"url":32},"bstats","https://bstats.org/plugin/bukkit/HuskSync%20-%20Bukkit/13140",[34],"William278",[22,36,37],"paper","fabric",11.99,"901578725487955978",false,[42,98,126,144],{"order":43,"name":44,"children":45},0,"Setup",[46,61,82,87],{"order":43,"url":47,"title":44,"icon":48,"children":49},"setup","fa6-solid:book",[50,55],{"order":43,"url":51,"title":52,"icon":53,"children":54},"mpdb-migration","MPDB Migration","carbon:migrate",[],{"order":56,"url":57,"title":58,"icon":59,"children":60},1,"legacy-migration","Legacy Migration","material-symbols:upgrade-rounded",[],{"order":56,"url":62,"title":63,"icon":64,"children":65},"config-file","Config","fa6-solid:file-code",[66,71,76],{"order":43,"url":67,"title":68,"icon":69,"children":70},"database","Database","fa6-solid:database",[],{"order":56,"url":72,"title":73,"icon":74,"children":75},"redis","Redis","devicon-plain:redis",[],{"order":77,"url":78,"title":79,"icon":80,"children":81},2,"translations","Locales","material-symbols:translate",[],{"order":77,"url":83,"title":84,"icon":85,"children":86},"compatibility","Compatibility","material-symbols:warning-outline-rounded",[],{"order":88,"url":89,"title":90,"icon":91,"children":92},3,"faqs","FAQs","fa6-solid:question",[93],{"order":43,"url":94,"title":95,"icon":96,"children":97},"troubleshooting","Troubleshooting","material-symbols:troubleshoot",[],{"order":56,"name":99,"children":100},"Features",[101,106,121],{"order":43,"url":102,"title":103,"icon":104,"children":105},"commands","Commands","octicon:command-palette-16",[],{"order":56,"url":107,"title":108,"icon":109,"children":110},"sync-features","Sync Features","mdi:sync",[111,116],{"order":43,"url":112,"title":113,"icon":114,"children":115},"sync-modes","Sync Modes","mdi:cog-sync",[],{"order":56,"url":117,"title":118,"icon":119,"children":120},"data-rotation","Data Rotation","icon-park-outline:rotate",[],{"order":77,"url":122,"title":123,"icon":124,"children":125},"plan-hook","Player Analytics Hook","material-symbols:analytics-outline",[],{"order":77,"name":127,"children":128},"Guides",[129,134,139],{"order":43,"url":130,"title":131,"icon":132,"children":133},"dumping-userdata","Dumping UserData","fa6-solid:file-arrow-down",[],{"order":56,"url":135,"title":136,"icon":137,"children":138},"keep-inventory","Keep Inventory","material-symbols:inventory-2-outline",[],{"order":77,"url":140,"title":141,"icon":142,"children":143},"event-priorities","Event Priorities","ic:round-low-priority",[],{"order":88,"name":145,"children":146},"Developers",[147,167,171],{"order":43,"url":148,"title":149,"icon":150,"children":151},"api","API v3","mdi:api",[152,157,162],{"order":43,"url":153,"title":154,"icon":155,"children":156},"data-snapshot-api","Data Snapshot API","carbon:ibm-cloud-vpc-block-storage-snapshots",[],{"order":56,"url":158,"title":159,"icon":160,"children":161},"custom-data-api","Custom Data API","material-symbols:inbox-customize",[],{"order":77,"url":163,"title":164,"icon":165,"children":166},"api-events","API Events","mingcute:lightning-line",[],{"order":56,"url":168,"title":169,"icon":150,"children":170},"api-v2","API v2 (legacy)",[],{"order":77,"url":18,"title":172,"icon":173,"children":174},"Source Code","fa6-solid:code",[],{"SVG":176,"PNG":177,"PNG_TRANSPARENT":178,"SVG_TRANSPARENT":179},"husksync.svg","husksync.png","husksync-transparent.png","husksync-transparent.svg",[],[],{"downloadCount":183,"averageRating":184,"numberOfRatings":185,"interactions":186,"onlinePlayers":187,"onlineServers":188},3312,4.156862558103075,51,253,2713,811,{"data":190,"body":191},{},{"type":192,"children":193},"root",[194,202,209,214,219,249,279,292,297,303,316,325,330,343,355,361,366,384,390,395],{"type":195,"tag":196,"props":197,"children":198},"element","p",{},[199],{"type":200,"value":201},"text","HuskSync provides options for backing up and automatically rotating user data. That way, if something goes wrong, you can restore a user from a previous snapshot of user data.",{"type":195,"tag":203,"props":204,"children":206},"h2",{"id":205},"snapshots",[207],{"type":200,"value":208},"Snapshots",{"type":195,"tag":196,"props":210,"children":211},{},[212],{"type":200,"value":213},"HuskSync creates what is known as \"Snapshots\" of a user's data whenever it saves data.",{"type":195,"tag":196,"props":215,"children":216},{},[217],{"type":200,"value":218},"Each user data snapshot has:",{"type":195,"tag":220,"props":221,"children":222},"ul",{},[223,229,234,239,244],{"type":195,"tag":224,"props":225,"children":226},"li",{},[227],{"type":200,"value":228},"a unique ID",{"type":195,"tag":224,"props":230,"children":231},{},[232],{"type":200,"value":233},"a timestamp (when it was created)",{"type":195,"tag":224,"props":235,"children":236},{},[237],{"type":200,"value":238},"a save cause (why it was created)",{"type":195,"tag":224,"props":240,"children":241},{},[242],{"type":200,"value":243},"a flag to indicate if the snapshot has been pinned (preventing it from being rotated)",{"type":195,"tag":224,"props":245,"children":246},{},[247],{"type":200,"value":248},"a map of saved data",{"type":195,"tag":196,"props":250,"children":251},{},[252,254,261,263,269,271,277],{"type":200,"value":253},"By default, HuskSync will automatically replace the user's current snapshot in the database if it has been less than 4 hours since the last snapshot was created. This can be changed in the ",{"type":195,"tag":255,"props":256,"children":258},"code",{"className":257},[],[259],{"type":200,"value":260},"config.yml",{"type":200,"value":262}," file by changing the ",{"type":195,"tag":255,"props":264,"children":266},{"className":265},[],[267],{"type":200,"value":268},"snapshot_backup_frequency",{"type":200,"value":270}," setting under ",{"type":195,"tag":255,"props":272,"children":274},{"className":273},[],[275],{"type":200,"value":276},"synchronization",{"type":200,"value":278},". Setting this to \"0\" will save a new snapshot each time data is saved.",{"type":195,"tag":196,"props":280,"children":281},{},[282,284,290],{"type":200,"value":283},"HuskSync will keep the 16 most recent data snapshots for each user (including their current data). After that, when a new user snapshot is set, the oldest snapshot will automatically be deleted. You can change the number of snapshots to keep by changing the ",{"type":195,"tag":255,"props":285,"children":287},{"className":286},[],[288],{"type":200,"value":289},"max_user_data_snapshots",{"type":200,"value":291}," setting (minimum 1).",{"type":195,"tag":196,"props":293,"children":294},{},[295],{"type":200,"value":296},"Pinned user data snapshots are exempt from being replaced/rotated and can only be deleted manually in-game.",{"type":195,"tag":203,"props":298,"children":300},{"id":299},"viewing-user-data",[301],{"type":200,"value":302},"Viewing user data",{"type":195,"tag":196,"props":304,"children":305},{},[306,308,314],{"type":200,"value":307},"To view a list of a user's snapshots, use ",{"type":195,"tag":255,"props":309,"children":311},{"className":310},[],[312],{"type":200,"value":313},"/userdata list [username]",{"type":200,"value":315},". Their most recent snapshots will be listed from the database, from newest to oldest. You can click the buttons to navigate through their pages.",{"type":195,"tag":196,"props":317,"children":318},{},[319],{"type":195,"tag":320,"props":321,"children":324},"img",{"alt":322,"src":323},"Data snapshot list","https://raw.githubusercontent.com/WiIIiam278/HuskSync/master/images/data-snapshot-list.png",[],{"type":195,"tag":196,"props":326,"children":327},{},[328],{"type":200,"value":329},"Snapshots marked with a star after the number have been pinned. Hover over it to view more information.",{"type":195,"tag":196,"props":331,"children":332},{},[333,335,341],{"type":200,"value":334},"You can then click on the items in the list in chat to view an overview of each snapshot. Alternatively, to view a user's most recent data snapshot, use ",{"type":195,"tag":255,"props":336,"children":338},{"className":337},[],[339],{"type":200,"value":340},"/userdata view [username]",{"type":200,"value":342},".",{"type":195,"tag":196,"props":344,"children":345},{},[346],{"type":195,"tag":347,"props":348,"children":352},"a",{"href":349,"rel":350},"https://raw.githubusercontent.com/WiIIiam278/HuskSync/master/images/data-snapshot-viewer.png",[351],"nofollow",[353],{"type":200,"value":354},"Data snapshot viewer",{"type":195,"tag":203,"props":356,"children":358},{"id":357},"managing-user-data",[359],{"type":200,"value":360},"Managing user data",{"type":195,"tag":196,"props":362,"children":363},{},[364],{"type":200,"value":365},"You can use the \"Manage\" buttons to manage user data. These buttons will only appear if you have the userdata command manage permission. (See [[Commands]])",{"type":195,"tag":220,"props":367,"children":368},{},[369,374,379],{"type":195,"tag":224,"props":370,"children":371},{},[372],{"type":200,"value":373},"Click on \"Delete\" to remove the data",{"type":195,"tag":224,"props":375,"children":376},{},[377],{"type":200,"value":378},"Click on \"Restore\" to restore the user data. If the user is online, their items and stats will be updated, otherwise their data will be set to this snapshot upon their next login.",{"type":195,"tag":224,"props":380,"children":381},{},[382],{"type":200,"value":383},"Click on \"Pin\" to pin the user data. An indicator will appear in the data viewer and list marking the snapshot as being pinned.",{"type":195,"tag":203,"props":385,"children":387},{"id":386},"save-causes",[388],{"type":200,"value":389},"Save causes",{"type":195,"tag":196,"props":391,"children":392},{},[393],{"type":200,"value":394},"Data save causes, marked with a 🚩 flag, indicate what caused the data to be saved.",{"type":195,"tag":220,"props":396,"children":397},{},[398,409,440,450,468,485,495,504,514,524,534],{"type":195,"tag":224,"props":399,"children":400},{},[401,407],{"type":195,"tag":402,"props":403,"children":404},"strong",{},[405],{"type":200,"value":406},"disconnect",{"type":200,"value":408},": Indicates data saved when a player disconnected from the server (either to change servers, or to log off)",{"type":195,"tag":224,"props":410,"children":411},{},[412,417,419,424,426,432,434,439],{"type":195,"tag":402,"props":413,"children":414},{},[415],{"type":200,"value":416},"world save",{"type":200,"value":418},": Indicates data saved when the world saved. This can be turned off in ",{"type":195,"tag":255,"props":420,"children":422},{"className":421},[],[423],{"type":200,"value":260},{"type":200,"value":425}," by setting ",{"type":195,"tag":255,"props":427,"children":429},{"className":428},[],[430],{"type":200,"value":431},"save_on_world_save",{"type":200,"value":433}," to false under ",{"type":195,"tag":255,"props":435,"children":437},{"className":436},[],[438],{"type":200,"value":276},{"type":200,"value":342},{"type":195,"tag":224,"props":441,"children":442},{},[443,448],{"type":195,"tag":402,"props":444,"children":445},{},[446],{"type":200,"value":447},"server shutdown",{"type":200,"value":449},": Indicates data saved when the server shut down",{"type":195,"tag":224,"props":451,"children":452},{},[453,458,460,466],{"type":195,"tag":402,"props":454,"children":455},{},[456],{"type":200,"value":457},"inventory command",{"type":200,"value":459},": Indicates data was saved by editing inventory contents via the ",{"type":195,"tag":255,"props":461,"children":463},{"className":462},[],[464],{"type":200,"value":465},"/inventory",{"type":200,"value":467}," command",{"type":195,"tag":224,"props":469,"children":470},{},[471,476,478,484],{"type":195,"tag":402,"props":472,"children":473},{},[474],{"type":200,"value":475},"enderchest command",{"type":200,"value":477},": Indicates data was saved by editing Ender Chest contents via the ",{"type":195,"tag":255,"props":479,"children":481},{"className":480},[],[482],{"type":200,"value":483},"/enderchest",{"type":200,"value":467},{"type":195,"tag":224,"props":486,"children":487},{},[488,493],{"type":195,"tag":402,"props":489,"children":490},{},[491],{"type":200,"value":492},"backup restore",{"type":200,"value":494},": Indicates data was saved by restoring it from a previous version",{"type":195,"tag":224,"props":496,"children":497},{},[498,502],{"type":195,"tag":402,"props":499,"children":500},{},[501],{"type":200,"value":148},{"type":200,"value":503},": Indicates data was saved by a call to the HuskSync [[API]]",{"type":195,"tag":224,"props":505,"children":506},{},[507,512],{"type":195,"tag":402,"props":508,"children":509},{},[510],{"type":200,"value":511},"mpdb migration",{"type":200,"value":513},": Indicates data was saved from being imported from MySQLPlayerDataBridge (See [[MPDB Migration]])",{"type":195,"tag":224,"props":515,"children":516},{},[517,522],{"type":195,"tag":402,"props":518,"children":519},{},[520],{"type":200,"value":521},"legacy migration",{"type":200,"value":523},": Indicates data was saved from being imported from a legacy version (v1.x - See [[Legacy Migration]])",{"type":195,"tag":224,"props":525,"children":526},{},[527,532],{"type":195,"tag":402,"props":528,"children":529},{},[530],{"type":200,"value":531},"converted from v2",{"type":200,"value":533},": Indicates data was automatically converted from HuskSync v2.0's data format",{"type":195,"tag":224,"props":535,"children":536},{},[537,542],{"type":195,"tag":402,"props":538,"children":539},{},[540],{"type":200,"value":541},"unknown",{"type":200,"value":543},": Indicates data was saved by an unknown saveCause.",["Reactive",545],{"$snuxt-i18n-meta":546,"$sauth":-1,"$sxsrf":-1},{},["Set"],["ShallowReactive",549],{"$fnBbeE-K5RgegIGNVekmBdBstWwpqH2A9eAqMmEjIo20":-1,"user":550,"mdc-w6ywpo-key":-1},["NuxtError",551],{"message":552,"statusCode":553,"statusMessage":554,"data":555},"[GET] \"https://api.william278.net/v1/users/@me\": 401 Unauthorized",401,"Unauthorized",{"error":556},"You must be logged in to perform this action.","/docs/husksync/Data-Rotation"]