Repo-Mirror/HuskSync
9
0
Fork 0
mirror of https://github.com/WiIIiam278/HuskSync.git synced 2025-12-27 02:29:10 +00:00
Code Issues Releases 1 Activity

docs: update sync features docs/faq

Browse Source
This commit is contained in:
William
2024-04-11 14:55:11 +01:00
parent 8293d767da
commit 328d4476aa
2 changed files with 10 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
docs/Sync-Features.md
View File

@@ -8,7 +8,7 @@ You can customise how much data HuskSync saves about a player by [turning each s
| Name | Description | Availability |
|---------------------------|---------------------------------------------------------------------------------------------|:------------:|
| Inventories | Items in player inventories & selected hotbar slot | ✅ |
| Ender chests | Items in ender chests* | ✅ |
| Ender chests | Items in ender chests | ✅ |
| Health | Player health points and scale | ✅ |
| Hunger | Player hunger, saturation & exhaustion | ✅ |
| Attributes | Player max health, movement speed, reach, etc. ([wiki](https://minecraft.wiki/w/Attribute)) | ✅ |
@@ -18,17 +18,16 @@ You can customise how much data HuskSync saves about a player by [turning each s
| Game modes | Player's current game mode | ✅ |
| Flight status | If the player is currently flying / can fly | ✅ |
| Statistics | Player's in-game stats (ESC -> Statistics) | ✅ |
| Location | Player's current coordinate position and world† | ✅ |
| Location | Player's current coordinate position and world (see below) | ✅ |
| Persistent Data Container | Custom plugin persistent data key map | ✅️ |
| Locked maps | Maps/treasure maps locked in a cartography table | ✅ |
| Unlocked maps | Regular, unlocked maps/treasure maps ([why?](#map-syncing)) | ❌ |
| Economy balances | Vault economy balance. ([why?](#economy-syncing)) | ❌ |
What about modded items? Or custom item plugins such as MMOItems or SlimeFun? These items are **not compatible**—check the [[FAQs]] for more information.
*Purpur's custom ender chest resizing feature is also supported.
†This is intended for servers that have mirrored worlds across instances (such as RPG servers). With this option enabled, players will be placed at the same coordinates when changing servers.
* What about modded items (Arclight, etc.)? – Though we can't provide support for these setups to work, they have been reported to save & sync correctly with HuskSync v3.x+.
* What about SlimeFun, MMOItems, etc.? – Yes, items created via these plugins should save & sync correctly, but be sure to test thoroughly first.
* What about Purpur's custom ender chest resizing feature? – Yes, this is supported (but make sure it's enabled on _all_ servers!).
* What do you mean by location syncing? – This is intended for servers that have mirrored worlds across instances (such as RPG servers). With this enabled, players will be placed at the same coordinates when changing servers.
### Map syncing
Map items are a special case, as their data is not stored in the item itself, but rather in the game world files. In addition to this, their data is dynamic and changes based on the updating of the world, something that can't be tracked across multiple instances. As a result, it's not possible to sync unlocked map items. Locked maps, however, are supported. This works by saving the pixel canvas grid to the map NBT itself, and generating virtual maps on the other servers.