diff options
Diffstat (limited to 'nixpkgs/nixos/modules/services/games/factorio.nix')
| -rw-r--r-- | nixpkgs/nixos/modules/services/games/factorio.nix | 48 |
1 files changed, 24 insertions, 24 deletions
diff --git a/nixpkgs/nixos/modules/services/games/factorio.nix b/nixpkgs/nixos/modules/services/games/factorio.nix index 14bb80c2d112..3dce60163a0e 100644 --- a/nixpkgs/nixos/modules/services/games/factorio.nix +++ b/nixpkgs/nixos/modules/services/games/factorio.nix @@ -45,11 +45,11 @@ in { options = { services.factorio = { - enable = mkEnableOption (lib.mdDoc name); + enable = mkEnableOption name; port = mkOption { type = types.port; default = 34197; - description = lib.mdDoc '' + description = '' The port to which the service should bind. ''; }; @@ -57,7 +57,7 @@ in bind = mkOption { type = types.str; default = "0.0.0.0"; - description = lib.mdDoc '' + description = '' The address to which the service should bind. ''; }; @@ -66,7 +66,7 @@ in type = types.listOf types.str; default = []; example = [ "username" ]; - description = lib.mdDoc '' + description = '' List of player names which will be admin. ''; }; @@ -74,14 +74,14 @@ in openFirewall = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Whether to automatically open the specified UDP port in the firewall. ''; }; saveName = mkOption { type = types.str; default = "default"; - description = lib.mdDoc '' + description = '' The name of the savegame that will be used by the server. When not present in /var/lib/''${config.services.factorio.stateDirName}/saves, @@ -91,7 +91,7 @@ in loadLatestSave = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' 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. @@ -108,7 +108,7 @@ in type = types.path; default = configFile; defaultText = literalExpression "configFile"; - description = lib.mdDoc '' + description = '' The server's configuration file. The default file generated by this module contains lines essential to @@ -119,7 +119,7 @@ in extraSettingsFile = mkOption { type = types.nullOr types.path; default = null; - description = lib.mdDoc '' + description = '' File, which is dynamically applied to server-settings.json before startup. @@ -136,7 +136,7 @@ in stateDirName = mkOption { type = types.str; default = "factorio"; - description = lib.mdDoc '' + description = '' Name of the directory under /var/lib holding the server's data. The configuration and map will be stored here. @@ -145,7 +145,7 @@ in mods = mkOption { type = types.listOf types.package; default = []; - description = lib.mdDoc '' + description = '' Mods the server should install and activate. The derivations in this list must "build" the mod by simply copying @@ -157,7 +157,7 @@ in mods-dat = mkOption { type = types.nullOr types.path; default = null; - description = lib.mdDoc '' + description = '' Mods settings can be changed by specifying a dat file, in the [mod settings file format](https://wiki.factorio.com/Mod_settings_file_format). @@ -166,14 +166,14 @@ in game-name = mkOption { type = types.nullOr types.str; default = "Factorio Game"; - description = lib.mdDoc '' + description = '' Name of the game as it will appear in the game listing. ''; }; description = mkOption { type = types.nullOr types.str; default = ""; - description = lib.mdDoc '' + description = '' Description of the game that will appear in the listing. ''; }; @@ -181,28 +181,28 @@ in type = types.attrs; default = {}; example = { admins = [ "username" ];}; - description = lib.mdDoc '' + description = '' Extra game configuration that will go into server-settings.json ''; }; public = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Game will be published on the official Factorio matching server. ''; }; lan = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Game will be broadcast on LAN. ''; }; username = mkOption { type = types.nullOr types.str; default = null; - description = lib.mdDoc '' + description = '' Your factorio.com login credentials. Required for games with visibility public. This option is insecure. Use extraSettingsFile instead. @@ -214,7 +214,7 @@ in password = mkOption { type = types.nullOr types.str; default = null; - description = lib.mdDoc '' + description = '' Your factorio.com login credentials. Required for games with visibility public. This option is insecure. Use extraSettingsFile instead. @@ -223,14 +223,14 @@ in token = mkOption { type = types.nullOr types.str; default = null; - description = lib.mdDoc '' + description = '' Authentication token. May be used instead of 'password' above. ''; }; game-password = mkOption { type = types.nullOr types.str; default = null; - description = lib.mdDoc '' + description = '' Game password. This option is insecure. Use extraSettingsFile instead. @@ -239,7 +239,7 @@ in requireUserVerification = mkOption { type = types.bool; default = true; - description = lib.mdDoc '' + description = '' When set to true, the server will only allow clients that have a valid factorio.com account. ''; }; @@ -247,14 +247,14 @@ in type = types.nullOr types.int; default = null; example = 10; - description = lib.mdDoc '' + description = '' Autosave interval in minutes. ''; }; nonBlockingSaving = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' 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. |