HuskLegacy
/
HuskSync
forked from public-mirrors/HuskSync
1
0
Fork 0
Code Pull Requests Activity
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.
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 '0f7a866652'
${ noResults }
HuskSync/docs/Keep-Inventory.md

2.8 KiB
Raw Blame History

If your server uses the keepInventory gamerule, where players keep the contents of their inventory after dying, HuskSync's built-in snapshot-on-death and dead-player synchronization features can saveCause a conflict leading to synchronization issues.

To solve this issue, you will need to adjust three settings in your config.yml file, as described below.

Why does this happen?

HuskSync has some special handling when players die, to account for scenarios where users change servers after death (to prevent item loss).

  • Death state saving—HuskSync has special logic to save player snapshots except their inventory when they change servers while dead. When keepInventory is enabled, though, the inventory still contains items, so the snapshot is not saved correctly. This logic is enabled by default.
  • Snapshot creation on death—HuskSync can create a special snapshot for backup purposes when a player dies, formed by taking their drops and setting this to their inventory. When keepInventory is enabled, the player drops are empty, so this creates an inaccurate snapshot. This option is disabled by default.

How can this be fixed?

You should change the items_to_save mode to ITEMS_TO_KEEP instead of drops. Also, ensure save_empty_items and sync_dead_players_changing_server are enabled.

Example in config.yml 
 synchronization:
   #...
   save_on_death:
     # Whether to create a snapshot for users when they die (containing their death drops)
     enabled: true
     # What items to save in death snapshots? (DROPS or ITEMS_TO_KEEP). Note that ITEMS_TO_KEEP (suggested for keepInventory servers) requires a Paper 1.19.4+ server
     items_to_save: ITEMS_TO_KEEP
     # Should a death snapshot still be created even if the items to save on the player's death are empty?
     save_empty_items: true
     # Whether dead players who log out and log in to a different server should have their items saved.
     sync_dead_players_changing_server: true
   #...

Troubleshooting with custom keepInventory setups

If the above doesn't work for you, you may need to do more things to get this to work properly.

If your server uses an advanced custom setup where some items are kept and others are not through custom plugin logic, you'll need to use the HuskSync API to create a custom hook to update data on the DataSaveEvent when a player changes server while dead, transforming their inventory data as appropriate.

If your server uses a permission node to control whether the user keeps their inventory on death, you should be able to follow the above instructions although your mileage may vary dependent on your setup and how you handle players when they die. Note that this option may also conflict with other plugins that make assumptions about the persistence of items on death.