docs: clarify SteamCMD module workflow

This commit is contained in:
2026-09-10 11:59:41 -04:00
parent 523655a9ec
commit cee0673ae8

View File

@@ -29,19 +29,19 @@ SteamCMD mutates the installed server files.
## Stage 2: Create the game module ## Stage 2: Create the game module
1. Create `configs/nixos/modules/services/games/<game>.nix`. 1. Create `configs/nixos/modules/services/games/<game>.nix`.
2. Add the module to `configs/nixos/modules/default.nix`. 2. Define options under `modules.services.games.<game>`.
3. Define options under `modules.services.games.<game>`. 3. Expose only deployment-specific values.
4. Expose only deployment-specific values. 4. Keep host paths in the host configuration.
5. Keep host paths in the host configuration. 5. Keep secret selection in the host configuration.
6. Keep secret selection in the host configuration. 6. Keep network placement outside the game module.
7. Keep network placement outside the game module. 7. Move the Steam app ID into the game module.
8. Move the Steam app ID into the game module. 8. Move the executable path into the game module.
9. Move the executable path into the game module. 9. Move game arguments into the game module.
10. Move game arguments into the game module. 10. Move documented ports into the game module.
11. Move documented ports into the game module. 11. Wire the game module to `modules.services.steamcmd`.
12. Wire the game module to `modules.services.steamcmd`. 12. Replace the direct host `modules.services.steamcmd` config.
13. Replace the direct host `modules.services.steamcmd` config. 13. Enable `modules.services.games.<game>` on the host.
14. Enable `modules.services.games.<game>` on the host. 14. Stage the new module file.
15. Evaluate the host configuration. 15. Evaluate the host configuration.
16. Deploy the host. 16. Deploy the host.
17. Validate the service again on the host. 17. Validate the service again on the host.