Factorio

`services.factorio.admins`

List of player names which will be admin.

Type: list of string

Default

[ ]

Example

["username"]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/games/factorio.nix

`services.factorio.autosave-interval`

Autosave interval in minutes.

Type: null or signed integer

Default

null

Example

10

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/games/factorio.nix

`services.factorio.bind`

The address to which the service should bind.

Type: string

Default

"0.0.0.0"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/games/factorio.nix

`services.factorio.configFile`

The server's configuration file.

The default file generated by this module contains lines essential to the server's operation. Use its contents as a basis for any customizations.

Type: path

Default

configFile

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/games/factorio.nix

`services.factorio.description`

Description of the game that will appear in the listing.

Type: null or string

Default

""

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/games/factorio.nix

`services.factorio.enable`

Whether to enable Factorio. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/games/factorio.nix

`services.factorio.extraSettings`

Extra game configuration that will go into server-settings.json

Type: attribute set

Default

{ }

Example

{admins = ["username"];}

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/games/factorio.nix

`services.factorio.extraSettingsFile`

File, which is dynamically applied to server-settings.json before startup.

This option should be used for credentials.

For example a settings file could contain:

{
  "game-password": "hunter1"
}

Type: null or path

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/games/factorio.nix

`services.factorio.game-name`

Name of the game as it will appear in the game listing.

Type: null or string

Default

"Factorio Game"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/games/factorio.nix

`services.factorio.game-password`

Game password.

This option is insecure. Use extraSettingsFile instead.

Type: null or string

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/games/factorio.nix

`services.factorio.lan`

Game will be broadcast on LAN.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/games/factorio.nix

`services.factorio.loadLatestSave`

Load the latest savegame on startup. This overrides saveName, in that the latest save will always be used even if a saved game of the given name exists. It still controls the 'canonical' name of the savegame.

Set this to true to have the server automatically reload a recent autosave after a crash or desync.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/games/factorio.nix

`services.factorio.mods`

Mods the server should install and activate.

The derivations in this list must "build" the mod by simply copying the .zip, named correctly, into the output directory. Eventually, there will be a way to pull in the most up-to-date list of derivations via nixos-channel. Until then, this is for experts only.

Type: list of package

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/games/factorio.nix

`services.factorio.mods-dat`

Mods settings can be changed by specifying a dat file, in the mod settings file format.

Type: null or path

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/games/factorio.nix

`services.factorio.nonBlockingSaving`

Highly experimental feature, enable only at your own risk of losing your saves. On UNIX systems, server will fork itself to create an autosave. Autosaving on connected Windows clients will be disabled regardless of autosave_only_on_server option.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/games/factorio.nix

`services.factorio.openFirewall`

Whether to automatically open the specified UDP port in the firewall.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/games/factorio.nix

`services.factorio.package`

The factorio-headless package to use. Type: package

Default

pkgs.factorio-headless

Example

factorio-headless-experimental

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/games/factorio.nix

`services.factorio.password`

Your factorio.com login credentials. Required for games with visibility public.

This option is insecure. Use extraSettingsFile instead.

Type: null or string

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/games/factorio.nix

`services.factorio.port`

The port to which the service should bind.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default

34197

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/games/factorio.nix

`services.factorio.public`

Game will be published on the official Factorio matching server.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/games/factorio.nix

`services.factorio.requireUserVerification`

When set to true, the server will only allow clients that have a valid factorio.com account.

Type: boolean

Default

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/games/factorio.nix

`services.factorio.saveName`

The name of the savegame that will be used by the server.

When not present in /var/lib/${config.services.factorio.stateDirName}/saves, a new map with default settings will be generated before starting the service.

Type: string

Default

"default"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/games/factorio.nix

`services.factorio.stateDirName`

Name of the directory under /var/lib holding the server's data.

The configuration and map will be stored here.

Type: string

Default

"factorio"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/games/factorio.nix

`services.factorio.token`

Authentication token. May be used instead of 'password' above.

Type: null or string

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/games/factorio.nix

`services.factorio.username`

Your factorio.com login credentials. Required for games with visibility public.

This option is insecure. Use extraSettingsFile instead.

Type: null or string

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/games/factorio.nix