Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

nixos/terraria: fix service restarting and refactor to use config file #314621

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

TomaSajt
Copy link
Contributor

@TomaSajt TomaSajt commented May 25, 2024

Description of changes

This PR revamps the services.terraria NixOS module.


The first commit fixes the ExecStop script of the service.
When launching the server without configuring a world to start automatically, the server will show a world selection prompt. The ExecStop script would unconditionally send the exit command to the tmux session, even if the server was still in the world selection phase (during which the exit command doesn't work).
This PR makes it so that if we're still in the world selection phase (checked using shell pattern matching), we will just send a kill-session command instead, since we've got nothing to save.

Some other small changes include factoring out tmux -S terraria.sock calls and using writeShellScript instead of writeScript.


The other commit moves the module over to using a config file, instead of passing a bunch of command line flags.
The benefit of this other than readability is that the config file has more settings than what could be configured using the flags.

The few extra options I've implemented were the autoCreatedWorldSeed and autoCreatedWorldDifficulty.
These autoCreated* options should probably be factored out into autocreate.worldType autocreate.seed and autocreate.difficulty, but I haven't done them yet.

I added all supported flags to the list, but didn't implement all of them. I'll do that in another PR.

I also removed the top-level with lib; which is an anti-pattern.


@ncfavier - the other maintainer of the terraria-server package.
Not sure how else I should ping, since this module is very outdated.

Things done

  • Built on platform(s)
    • x86_64-linux
    • aarch64-linux
    • x86_64-darwin
    • aarch64-darwin
  • For non-Linux: Is sandboxing enabled in nix.conf? (See Nix manual)
    • sandbox = relaxed
    • sandbox = true
  • Tested, as applicable:
  • Tested compilation of all packages that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD". Note: all changes have to be committed, also see nixpkgs-review usage
  • Tested basic functionality of all binary files (usually in ./result/bin/)
  • 24.11 Release Notes (or backporting 23.11 and 24.05 Release notes)
    • (Package updates) Added a release notes entry if the change is major or breaking
    • (Module updates) Added a release notes entry if the change is significant
    • (Module addition) Added a release notes entry if adding a new NixOS module
  • Fits CONTRIBUTING.md.

Add a 👍 reaction to pull requests you find important.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant