Daniel
a4a667ef06
* New method avoids all dataloss and prefectly replicates the queue * Made proper description in readme * Added packages to make lerna build happy * Added reference to main readme
Clusterio inventory sync plugin
Carry over player inventory between servers
As a player, it mostly just works. Most important to know is that factorio data transfer is slow, which means if you have "big" items (blueprints mostly) in your inventory it will take a long time to transfer when joining servers. For this reason it is recommended to keep blueprints in the blueprint library.
A note on crashing servers:
When a server crashes while you are online there won't be time to immediately upload the inventory. Instead, the inventory is uploaded as soon as the server restarts. This means if you have been playing on a different server from the one that crashed and gathered/consumed items but are offline at the time of the first server coming online again your inventory will reset to the autosave.
Installation
Run the following commands in the folder Clusterio is installed to:
npm install @clusterio/plugin-inventory_sync
npx clusteriomaster plugin add @clusterio/plugin-inventory_sync
Substitute clusteriomaster with clusterioslave or clusterioctl if this a dedicated slave or ctl installation respectively.
Method of operation
This plugin does event based synchronization of inventories. The data flow is as follows:
-
Player joins server, gets put in spectator mode
-
Lua script asks instance for inventory
-
Instance asks master for inventory
-
Master does not find inventory, and responds to instance with undefined
-
Instance sets player to survival
-
Player keeps playing, and eventually leaves. Inventory is serialized and sent to instance through stdout/file
-
Instance sends inventory to master
-
Player joins a different server. Lua sends a request to instance, puts player into spectator mode
-
Instance sends request to master
-
Master responds with json data
-
Instance calls command in scenario script using rcon
-
Once the entire command is transfered, the scenario script clears the old inventory, applies the new inventory from the scenario script and sets the player to survival mode.
Communication between the server and instance goes over stdout or rcon, depending on the size of the data. Communication between the instance and the master server goes over websockets. Overall, we are able to achieve a latency between 3 and infinite ticks from server join, depending on the size of the inventory. The major limiter is rcon transfer speeds with larger inventories, especially if they contain blueprints.