Merge pull request #1014 from bbassie/feature/patched-scenario

Add create-scenario command to clusteriohost
This commit is contained in:
Cooldude2606 authored and GitHub committed 2026-10-06 16:37:16 +01:00
commit b07c25aa7e
11 files changed
+496 -36

No files matched your search

+25
View File
@@ -99,6 +99,31 @@ See docs/configuration.md in the main repositiory for the available configuratio
Shows the value for a single config entry.
### `create-scenario <output>`
Create a scenario with the Clusterio modules patched into it and write it to `output`.
This is the same patching that is applied to saves when an instance starts, see docs/how-it-works.md in the main repository.
The result can be used as a regular scenario outside of Clusterio by copying it to the `scenarios` folder of Factorio or into a mod.
The IPC between the game and the host is not available outside of Clusterio, so modules that depend on it will not work as expected.
By default the freeplay scenario from the latest Factorio install in `host.factorio_directory` is patched with the modules from all plugins that are enabled in the host config.
* `--scenario <path>` Scenario directory, zipped scenario or save to patch instead of freeplay.
This has the same restrictions as save patching, the scenario must either use the event_handler library and have been seen by Clusterio before, or already have been patched by Clusterio.
* `--factorio-version <version>` Factorio version to take the freeplay scenario from.
Defaults to `latest`.
* `--plugins <name>...` Only patch in modules from the given plugins.
* `--zip` Write the scenario as a zip file instead of a directory.
Factorio does not load zipped scenarios, extract it before use.
For example, creating a scenario with only the inventory_sync module:
npx clusteriohost create-scenario ~/.factorio/scenarios/inventory_sync --plugins inventory_sync
#### `config list`
Lists up all configuration entries with their currently configured values.