summaryrefslogtreecommitdiffstats
path: root/nixos/modules/services/games
diff options
context:
space:
mode:
authorRTUnreal <unreal@rtinf.net>2023-11-21 20:52:30 +0100
committerRTUnreal <unreal@rtinf.net>2023-11-21 20:52:30 +0100
commitdecdfde0114b12928cf1791836524cff49a60780 (patch)
tree369dff98205fff51716e8480869bd2f646052aa4 /nixos/modules/services/games
parent648ffcecaec71d992ac714b07fe4bee2e482737f (diff)
improve documentation of new options
Diffstat (limited to 'nixos/modules/services/games')
-rw-r--r--nixos/modules/services/games/factorio.nix13
1 files changed, 10 insertions, 3 deletions
diff --git a/nixos/modules/services/games/factorio.nix b/nixos/modules/services/games/factorio.nix
index c72282d78c81..e6c4522d5d1d 100644
--- a/nixos/modules/services/games/factorio.nix
+++ b/nixos/modules/services/games/factorio.nix
@@ -124,6 +124,13 @@ in
startup.
This option should be used for credentials.
+
+ For example a settings file could contain:
+ ```json
+ {
+ "game-password": "hunter1"
+ }
+ ```
'';
};
stateDirName = mkOption {
@@ -198,7 +205,7 @@ in
description = lib.mdDoc ''
Your factorio.com login credentials. Required for games with visibility public.
- This option is unsecure. Use extraSettingsFile instead.
+ This option is insecure. Use extraSettingsFile instead.
'';
};
package = mkOption {
@@ -216,7 +223,7 @@ in
description = lib.mdDoc ''
Your factorio.com login credentials. Required for games with visibility public.
- This option is unsecure. Use extraSettingsFile instead.
+ This option is insecure. Use extraSettingsFile instead.
'';
};
token = mkOption {
@@ -232,7 +239,7 @@ in
description = lib.mdDoc ''
Game password.
- This option is unsecure. Use extraSettingsFile instead.
+ This option is insecure. Use extraSettingsFile instead.
'';
};
requireUserVerification = mkOption {