nixos/steam: add protontricks submodule

[diniamo]

Description of changes

The title is self-explanatory, as for the reason: other programs also rely on this variable to find proton versions, for example protontricks.

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:
  • NixOS test(s) (look inside nixos/tests)
  • and/or package tests
  • or, for functions and "core" functionality, tests in lib/tests or pkgs/test
  • made sure NixOS tests are linked to the relevant packages
• 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.05 Release Notes (or backporting 23.05 and 23.11 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.

[Shawn8901]

FYI in the PR adding that it was explicitly asked to not expose that globally: see #189398 (comment)

[diniamo]

I see. @Atemu what do you think now that it has become an issue? Creating a module for everything that relies on it would be tedious both for me and the user, I think a global variable is the way.

[Atemu]

I don't think there's all that many tools which require steam-specific things. I'd be in favour of adding options for the one or two tools which actually need this. I honestly can't think of much else than protontricks.

As a general rule, one should never pollute the global namespace with env vars that only concern a handful of programs.

As an escape hatch, you can also always run the tool inside steam-run.

[diniamo]

In that case, should I create a submodule like programs.steam.protontricks.{enable,package}?

[diniamo]

Tested, how is this?

Also, please point out formatting mistakes, not sure about this one.

[diniamo]

There we go, tested too, I'm still unsure about formatting however.

[Atemu]

I'll take a closer look later but I don't see any obvious formatting issues. Unless you're doing something utterly weird that doesn't fit into the rest of Nixpkgs, there aren't any strict rules yet until NixOS/rfcs#166 is implemented.

[Shawn8901]

lgtm

[diniamo]

What is that ofborg error and where is the request change that's blocking the merge?

[Atemu]

It's an internal error that someone who maintains ofBorg will have to take a look at and manually remove at some point. It doesn't block the merge though, that's just my review. It'll stop blocking it as soon as I approve after I've taken a proper look or another committer comes around and dismisses it.

[diniamo]

Resolved conflicts, tested.

[diniamo]

@Atemu have you had a chance to look? It would be great if we could get this in before the next unstable merge.

[Atemu]

Two minor things, otherwise LGTM.

[Atemu]

Please consider users who may not know what protontricks is. The option to enable it should offer at least a little information on it.

We could also pull it from the package's meta like this:

Suggested change

	enable = lib.mkEnableOption "Protontricks";
	enable = lib.mkEnableOption "protontricks, ${cfg.protontricks.package.meta.description}";

[diniamo]

Looks like your suggestion fails the documentation CI (and not just the CI, my system config errors too), apparently option descriptions can't rely on config/pkgs.

[diniamo]

Welp, adding it manually is the best I can come up with.

[Atemu]

Looks like your suggestion fails the documentation CI (and not just the CI, my system config errors too), apparently option descriptions can't rely on config/pkgs.

Ah, indeed it makes sense; we don't have access to config when defining options. You could probably dig it out of options..package.default but hard-coding like this is fine.

[Atemu]

Diff LGTM and the NixOS part appears to be working but I'm not sure protontricks is as it's giving me:

protontricks (ERROR): Could not find configured Proton installation!
protontricks (ERROR): Active Proton installation could not be found automatically.
Proton installation could not be found!

Though I'm also getting the same error when I steam-run it which worked before?

Is it working on your end @diniamo?

[Atemu]

Ah, wait I had to select a compat tool for the game once it seems; now it works flawlessly.

[Atemu]

Thanks!

[diniamo]

Nice, thanks