Files
factorio-clusterio/docs/how-it-works.md
T
bbassieandClaude Fable 5.1 c419f3e9b2 Add create-scenario command to clusteriohost
Creates a scenario directory with the Clusterio modules patched into it
so the modules can be used outside of Clusterio. The command reuses the
save patching by zipping the scenario, running patch() on it and
extracting the result. Defaults to the freeplay scenario from the
Factorio install in the host config and all plugins enabled there.

Module loading in Instance.prepareSave is moved to patch.loadModules so
the command and the instance share it, and findVersion is exported from
server.ts so the command can find the freeplay scenario.

Zipped scenarios were tried as an output form but Factorio does not
pick them up from the scenarios folder, so only directories are written.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
2026-09-10 00:16:29 +00:00

1.4 KiB

Save Patching

In order to efficiently get data in and out of running Factorio servers and to provide custom interfaces Clusterio uses save patching[1] to add code to the game. The save patching is based on the built in event_handler library to Factorio and requires scenarios to be coded specifically for it. Mods on the other hand work without modifications.

This can be disabled with the factorio.enable_save_patching config on a per instance basis, however disabling it means that modules are not loaded into the game and most plugins will not function. To use the modules outside of Clusterio the npx clusteriohost create-scenario command creates a scenario with the modules patched into it.

1: Before version 2.0 of Clusterio this was done at runtime with a patcher called Hotpatch, but due to the difficulty in supporting run time patching and the lack of documentation it was replace it with save patching instead.

User Accounts

The controller creates and stores accounts for all Factorio users that log into instances under its control. These accounts are used to store per player data and authorize management of the cluster. By default users accounts are assigned a Player role that gives a limited read access to the cluster resources, and admins of the cluster can be assigned a Cluster Admin role to get access to manage it.