mirror of
https://github.com/clusterio/clusterio.git
synced 2026-11-13 23:14:53 +09:00
89c51f0f74
configuration.md was missing most options added over the last few years. Add the controller, host and instance options that weren't listed, mark the internal ones, note the validation rule under each field that has one, and fix entries that had gone stale: the tls defaults, the proxy_stream_timeout name, game port assignment from host.factorio_port_range, the three sync list modes, and the player_online_autosave_slots heading. Plugin options live in the plugin READMEs, so add the missing ones for inventory_sync, player_auth and subspace_storage there. config-system.md gets the field definition properties it didn't list yet. Co-authored-by: bbassie <fqv4b97f@bastiaanbreemer.nl> Co-authored-by: Claude Fable 5.1 <noreply@anthropic.com>
43 lines
1.4 KiB
Markdown
43 lines
1.4 KiB
Markdown
# Clusterio Subspace Storage Plugin
|
|
|
|
Plugin for the Subpsace Storage mod.
|
|
|
|
|
|
## Installation
|
|
|
|
Run the following commands in the folder Clusterio is installed to:
|
|
|
|
npm install @clusterio/plugin-subspace_storage
|
|
npx clusteriocontroller plugin add @clusterio/plugin-subspace_storage
|
|
|
|
Substitute clusteriocontroller with clusteriohost or clusterioctl if this a dedicate host or ctl installation respectively.
|
|
|
|
|
|
## Controller Configuration
|
|
|
|
### subspace_storage.division_method
|
|
|
|
How to divide items between instances when there isn't enough in storage to give everyone what they ask for.
|
|
One of `simple`, `dole` or `neural_dole`.
|
|
With `simple` requests are served in full on a first come first served basis until the storage runs out.
|
|
With `dole` a per item division factor is kept that halves the amount handed out each time a request can't be met and slowly recovers when requests succeed, which spreads the remaining items between instances at the cost of draining the last of an item slowly.
|
|
`neural_dole` does the same with a small neural network estimating a fair share from the recent request history.
|
|
|
|
Defaults to `simple`.
|
|
|
|
|
|
### subspace_storage.log_item_transfers
|
|
|
|
Log every item transfer in and out of the storage to the controller console at verbose level.
|
|
|
|
Defaults to `false`.
|
|
|
|
|
|
## Instance Configuration
|
|
|
|
### subspace_storage.log_item_transfers
|
|
|
|
Log every item transfer in and out of the storage to the host console at verbose level.
|
|
|
|
Defaults to `false`.
|