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

steam: added documentation to nixpkgs manual #21047

Merged
merged 1 commit into from Dec 10, 2016

Conversation

xvapx
Copy link
Contributor

@xvapx xvapx commented Dec 10, 2016

Motivation for this change

Add documentation about steam to nixpkgs manual, according to issue #13237

Things done
  • Tested using sandboxing
    (nix.useSandbox on NixOS,
    or option build-use-sandbox in nix.conf
    on non-NixOS)
  • Built on platform(s)
    • NixOS
    • macOS
    • Linux
  • Tested compilation of all pkgs that depend on this change using nix-shell -p nox --run "nox-review wip"
  • Tested execution of all binary files (usually in ./result/bin/)
  • Fits CONTRIBUTING.md.

@mention-bot
Copy link

@xvapx, thanks for your PR! By analyzing the history of the files in this pull request, we identified @edolstra, @rycee and @abbradar to be potential reviewers.

@offlinehacker
Copy link
Contributor

Looks good to me, merging

@offlinehacker offlinehacker merged commit f1d9390 into NixOS:master Dec 10, 2016
@xvapx xvapx deleted the fix/steam-doc branch December 10, 2016 22:42
@abbradar
Copy link
Member

Thank you very much for this documentation!

Several nitpicks (nothing major which prevents merging this):

  1. What did you mean by "game cannot be started because it cannot be patched"? FHS environments don't patch the games, instead they try to emulate the surroundings;
  2. Java can be enabled by steam.override { withJava = true; }; probably we want to just add it to the environment unconditionally, like Mono already...

@vcunat
Copy link
Member

vcunat commented Dec 11, 2016

  1. I think it's mostly the content that was on the wiki. I suppose it meant usage of patchelf.

@xvapx xvapx restored the fix/steam-doc branch December 11, 2016 09:41
@xvapx
Copy link
Contributor Author

xvapx commented Dec 11, 2016

Yes, it is the info that was on the wiki, it means that binaries cannot be patched to not depend on a FHS environment because they are checked, i can update the doc to make it clearer and add the java override.
Thank you!

@abbradar
Copy link
Member

No problem; if you don't have enough time I can update the documentation by myself (I have been postponing it for far too long already).

Maybe we want to just drop the section about running the games with patchelf completely? This most likely won't get anyone better results than FHS. BTW, I also plan to document steam.run as a way to run stand-alone games.

@xvapx
Copy link
Contributor Author

xvapx commented Dec 11, 2016

Well, i have time today and i don't mind one way or the other, so as you prefer.

@abbradar
Copy link
Member

I won't have any till the mid-week, so if you want to go forward please! ~_^

@xvapx
Copy link
Contributor Author

xvapx commented Dec 11, 2016

Ok, i'm on it.

@xvapx
Copy link
Contributor Author

xvapx commented Dec 11, 2016

Is there any doc anywhere about the steam.run way? i'm finding nothing about it.

@vcunat
Copy link
Member

vcunat commented Dec 11, 2016

I didn't know steam-run. I wanted to run a stand-alone game recently and used buildFHSUserEnv directly. In this case just three packages were required...

@abbradar
Copy link
Member

abbradar commented Dec 11, 2016

@xvapx Nope, and that's the problem.

Quick informal introduction: steam-run lets you run applications as if they were run inside of Steam, in FHS and with its runtime (that's what games usually expect). You can install steam.run and then do steam-run ./foo.

In my personal experience, it works way better when runtime is composed of native NixOS libraries (unlike Steam, which works way better with vanilla Runtime). You get it like this:

        (steam.override {
          nativeOnly = true;
          newStdcpp = true;
        }).run

@vcunat PoE runs nicely with it ^_^.

@xvapx
Copy link
Contributor Author

xvapx commented Dec 11, 2016

Ok, thanks a lot!

@abbradar
Copy link
Member

Looking back, the only my mention of steam-run that I can find is the original pull request. I should be ashamed for not documenting that earlier D:

@xvapx
Copy link
Contributor Author

xvapx commented Dec 11, 2016

Well, it was clear enough in the PR, but i have been unable to find it until you pointed me. I just finished adding it, will PR in a moment.
Tell me if there is any other info you want there or any other change.
Thanks!

@xvapx
Copy link
Contributor Author

xvapx commented Dec 11, 2016

#21059

@abbradar
Copy link
Member

abbradar commented Dec 11, 2016 via email

@vcunat
Copy link
Member

vcunat commented Dec 11, 2016

PoE runs nicely with it ^_^.

I used to have problems with direct usage of steam* stuff, due to my unusual mounting setup of $HOME, but now I see it does work again with the current code :-)

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

6 participants