Export translations

Settings

Group

Language

Format

Export for off-line translation

Export in native format

Export in CSV format

<languages/>
<div lang="en" dir="ltr" class="mw-content-ltr">
[https://store.steampowered.com/ Steam] is a digital distribution platform for video games, offering a vast library for purchase, download, and management. On NixOS, Steam is generally easy to install and use, often working "out-of-the-box". It supports running many Windows games on Linux through its compatibility layer, Proton.<ref>https://store.steampowered.com/</ref>
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
== Installation ==
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
==== Shell ====
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
To temporarily use Steam-related tools like <code>steam-run</code> (for FHS environments) or <code>steamcmd</code> (for server management or tools like steam-tui setup) in a shell environment, you can run:
</div>
<syntaxhighlight lang="bash">
nix-shell -p steam-run # For FHS environment
nix-shell -p steamcmd  # For steamcmd
</syntaxhighlight>
<div lang="en" dir="ltr" class="mw-content-ltr">
This provides the tools in your current shell without adding them to your system configuration. For <code>steamcmd</code> to work correctly for some tasks (like initializing for steam-tui), you might need to run it once to generate necessary files, as shown in the `steam-tui` section.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
==== System setup ====
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
To install the [[Steam]] package and enable all the system options necessary to allow it to run, add the following to your <code>/etc/nixos/configuration.nix</code>:
</div>
<syntaxhighlight lang="nix">
# Example for /etc/nixos/configuration.nix
programs.steam = {
  enable = true;
  remotePlay.openFirewall = true; # Open ports in the firewall for Steam Remote Play
  dedicatedServer.openFirewall = true; # Open ports in the firewall for Source Dedicated Server
};

# Optional: If you encounter amdgpu issues with newer kernels (e.g., 6.10+ reported issues),
# you might consider using the LTS kernel or a known stable version.
# boot.kernelPackages = pkgs.linuxPackages_lts; # Example for LTS
</syntaxhighlight>
<div lang="en" dir="ltr" class="mw-content-ltr">
[https://news.ycombinator.com/item?id=41549030 Anecdata on kernel 6.10 issues]
</div>

{{note|Enabling [[steam]] installs several unfree packages. If you are using <code>allowUnfreePredicate</code> you will need to ensure that your configurations permit all of them.
<syntaxhighlight lang="nix">
{
  nixpkgs.config.allowUnfreePredicate = pkg: builtins.elem (lib.getName pkg) [
    "steam"
    "steam-unwrapped"
  ];
}
</syntaxhighlight>
}}

<div lang="en" dir="ltr" class="mw-content-ltr">
== Configuration ==
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
Basic Steam features can be enabled directly within the <code>programs.steam</code> attribute set:
</div>
<syntaxhighlight lang="nix">
programs.steam = {
  enable = true; # Master switch, already covered in installation
  remotePlay.openFirewall = true;  # For Steam Remote Play
  dedicatedServer.openFirewall = true; # For Source Dedicated Server hosting
  # Other general flags if available can be set here.
  # Tip: For improved gaming performance, you can also enable GameMode:
  # programs.gamemode.enable = true;
};
</syntaxhighlight>
<div lang="en" dir="ltr" class="mw-content-ltr">
If you are using a Steam Controller or a Valve Index, ensure Steam hardware support is enabled. This is typically handled by <code>programs.steam.enable = true;</code> which sets <code>hardware.steam-hardware.enable = true;</code> implicitly. You can verify or explicitly set it if needed:
</div>
<syntaxhighlight lang="nix">
hardware.steam-hardware.enable = true;
</syntaxhighlight>
<div lang="en" dir="ltr" class="mw-content-ltr">
== Tips and tricks ==
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
=== Gamescope Compositor / "Boot to Steam Deck" ===
</div>
<div lang="en" dir="ltr" class="mw-content-ltr">
Gamescope can function as a minimal desktop environment, meaning you can launch it from a TTY and have an experience very similar to the Steam Deck hardware console.
</div>
<syntaxhighlight lang="nix">
# Clean Quiet Boot
boot.kernelParams = [ "quiet" "splash" "console=/dev/null" ];
plymouth.enable = true;

programs.gamescope = {
  enable = true;
  capSysNice = true;
};
programs.steam.gamescopeSession.enable = true; # Integrates with programs.steam

# Gamescope Auto Boot from TTY (example)
services.xserver.enable = false; # Assuming no other Xserver needed
services.getty.autologinUser = "USERNAME_HERE";

services.greetd = {
  enable = true;
  settings = {
    default_session = {
      command = "${pkgs.gamescope}/bin/gamescope -W 1920 -H 1080 -f -e --xwayland-count 2 --hdr-enabled --hdr-itm-enabled -- steam -pipewire-dmabuf -gamepadui -steamos > /dev/null 2>&1";
      user = "USERNAME_HERE";
    };
  };
};
</syntaxhighlight>

<div lang="en" dir="ltr" class="mw-content-ltr">
=== steam-tui ===
</div>
<div lang="en" dir="ltr" class="mw-content-ltr">
If you want the steam-tui client, you'll have to install it. It relies on <code>steamcmd</code> being set up, so you'll need to run <code>steamcmd</code> once to generate the necessary configuration files.
First, ensure <code>steamcmd</code> is available (e.g., via <code>nix-shell -p steamcmd</code> or by adding it to <code>environment.systemPackages</code>), then run:
</div>
<syntaxhighlight lang="bash">
steamcmd +quit # This initializes steamcmd's directory structure
</syntaxhighlight>
<div lang="en" dir="ltr" class="mw-content-ltr">
Then install and run `steam-tui`. You may need to log in within `steamcmd` first if `steam-tui` has issues:
</div>
<syntaxhighlight lang="bash">
# (Inside steamcmd prompt, if needed for full login before steam-tui)
# login <username> <password> <steam_2fa_code>
# quit
</syntaxhighlight>
<div lang="en" dir="ltr" class="mw-content-ltr">
After setup, <code>steam-tui</code> (if installed e.g. via <code>home.packages</code> or <code>environment.systemPackages</code>) should start fine.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
=== FHS environment only ===
</div>
<div lang="en" dir="ltr" class="mw-content-ltr">
To run proprietary games or software downloaded from the internet that expect a typical Linux Filesystem Hierarchy Standard (FHS), you can use <code>steam-run</code>. This provides an FHS-like environment without needing to patch the software.
Note that this is not necessary for clients installed from Nixpkgs (like Minigalaxy or Itch), which already use the FHS environment as needed.
There are two options to make <code>steam-run</code> available:
1. Install <code>steam-run</code> system-wide or user-specifically:
</div>
<syntaxhighlight lang="nix">
# In /etc/nixos/configuration.nix
environment.systemPackages = with pkgs; [
  steam-run
];
</syntaxhighlight>
<div lang="en" dir="ltr" class="mw-content-ltr">
2. If you need more flexibility or want to use an overridden Steam package's FHS environment:
</div>
<syntaxhighlight lang="nix">
# In /etc/nixos/configuration.nix
environment.systemPackages = with pkgs; [
  (steam.override { /* Your overrides here */ }).run
];
</syntaxhighlight>
<div lang="en" dir="ltr" class="mw-content-ltr">
=== Proton ===
</div>
<div lang="en" dir="ltr" class="mw-content-ltr">
You should be able to play most Windows games using Proton. If a game has a native Linux version that causes issues on NixOS, you can force the use of Proton by selecting a specific Proton version in the game's compatibility settings in Steam.
</div>
<div lang="en" dir="ltr" class="mw-content-ltr">
By default, Steam also looks for custom Proton versions in <code>~/.steam/root/compatibilitytools.d</code>. The environment variable <code>STEAM_EXTRA_COMPAT_TOOLS_PATHS</code> can be set to add other search paths.
</div>
<div lang="en" dir="ltr" class="mw-content-ltr">
Declarative install of custom Proton versions (e.g. GE-Proton):
</div>
<syntaxhighlight lang="nix">
programs.steam.extraCompatPackages = with pkgs; [
  proton-ge-bin
];
</syntaxhighlight>
<div lang="en" dir="ltr" class="mw-content-ltr">
Manual management of multiple Proton versions can be done with ProtonUp-Qt:
</div>
<syntaxhighlight lang="nix">
environment.systemPackages = with pkgs; [
  protonup-qt
];
</syntaxhighlight>
<div lang="en" dir="ltr" class="mw-content-ltr">
=== Overriding the Steam package ===
</div>
<div lang="en" dir="ltr" class="mw-content-ltr">
In some cases, you may need to override the default Steam package to provide missing dependencies or modify its build. Use the <code>programs.steam.package</code> option for this. Steam on NixOS runs many games in an FHS environment, but the Steam client itself or certain tools might need extra libraries.
</div>
<div lang="en" dir="ltr" class="mw-content-ltr">
Example: Adding Bumblebee and Primus (for NVIDIA Optimus):
</div>
<syntaxhighlight lang="nix">
programs.steam.package = pkgs.steam.override {
  extraPkgs = pkgs': with pkgs'; [ bumblebee primus ];
};

# For 32-bit applications with Steam, if using steamFull:
# programs.steam.package = pkgs.steamFull.override { extraPkgs = pkgs': with pkgs'; [ bumblebee primus ]; };
</syntaxhighlight>

<div lang="en" dir="ltr" class="mw-content-ltr">
Example: Adding Xorg libraries for Gamescope (when used within Steam):
</div>
<syntaxhighlight lang="nix">
programs.steam.package = pkgs.steam.override {
  extraPkgs = pkgs': with pkgs'; [
    xorg.libXcursor
    xorg.libXi
    xorg.libXinerama
    xorg.libXScrnSaver
    libpng
    libpulseaudio
    libvorbis
    stdenv.cc.cc.lib # Provides libstdc++.so.6
    libkrb5
    keyutils
    # Add other libraries as needed
  ];
};
</syntaxhighlight>

<div lang="en" dir="ltr" class="mw-content-ltr">
== Troubleshooting ==
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
For all issues: first run <code>steam -dev -console</code> through the terminal and read the output.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
=== Steam fails to start. What do I do? ===
</div>
<div lang="en" dir="ltr" class="mw-content-ltr">
Run <code>strace steam -dev -console 2> steam.logs</code> in the terminal. If <code>strace</code> is not installed, temporarily install it using <code>nix-shell -p strace</code> or <code>nix run nixpkgs#strace -- steam -dev -console 2> steam.logs</code> (if using Flakes). After that, create a bug report. 
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
=== Steam is not updated ===
</div>
<div lang="en" dir="ltr" class="mw-content-ltr">
When you restart [[Steam]] after an update, it starts the old version. ([https://github.com/NixOS/nixpkgs/issues/181904 #181904])
A workaround is to remove the user files in <code>/home/&lt;USER&gt;/.local/share/Steam/userdata</code>. This can be done with <code>rm -rf /home/&lt;USER&gt;/.local/share/Steam/userdata</code> in the terminal or with your file manager. After that, Steam can be set up again by restarting.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
=== Game fails to start ===
</div>
<div lang="en" dir="ltr" class="mw-content-ltr">
Games may fail to start because they lack dependencies (this should be added to the script, for now), or because they cannot be patched. The steps to launch a game directly are:
* Patch the script/binary if you can
* Add a file named steam_appid.txt in the binary folder, with the appid as contents (it can be found in the stdout from steam)
* Using the LD_LIBRARY_PATH from the nix/store steam script, with some additions, launch the game binary
</div>
<syntaxhighlight lang="bash">
LD_LIBRARY_PATH=~/.steam/bin32:$LD_LIBRARY_PATH:/nix/store/pfsa... blabla ...curl-7.29.0/lib:. ./Osmos.bin32 (if you could not patchelf the game, call ld.so directly with the binary as parameter)
</syntaxhighlight>
<div lang="en" dir="ltr" class="mw-content-ltr">
Note: If a game gets stuck on Installing scripts, check for a DXSETUP.EXE process and run it manually, then restart the game launch.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
==== Changing the driver on AMD GPUs ====
</div>
{{note|This is not recommended because radv drivers tend to perform better and are generally more stable than amdvlk.}}
<div lang="en" dir="ltr" class="mw-content-ltr">
Sometimes, changing the driver on AMD GPUs helps. To try this, first, install multiple drivers such as radv and amdvlk:
</div>
<syntaxhighlight lang="nix">
hardware.graphics = {
  ## radv: an open-source Vulkan driver from freedesktop
  enable32Bit = true;

## amdvlk: an open-source Vulkan driver from AMD
  extraPackages = [ pkgs.amdvlk ];
  extraPackages32 = [ pkgs.driversi686Linux.amdvlk ];
};
</syntaxhighlight>
<div lang="en" dir="ltr" class="mw-content-ltr">
In the presence of both drivers, [[Steam]] will default to amdvlk. The amdvlk driver can be considered more correct regarding Vulkan specification implementation, but less performant than radv. However, this tradeoff between correctness and performance can sometimes make or break the gaming experience.
</div>
<div lang="en" dir="ltr" class="mw-content-ltr">
To "reset" your driver to radv when both radv and amdvlk are installed, set either <code>AMD_VULKAN_ICD = "RADV"</code> or <code>VK_ICD_FILENAMES = "/run/opengl-driver/share/vulkan/icd.d/radeon_icd.x86_64.json"</code> environment variable. For example, if you start [[Steam]] from the shell, you can enable radv for the current session by running <code>AMD_VULKAN_ICD="RADV" steam</code>. If you are unsure which driver you currently use, you can launch a game with [https://github.com/flightlessmango/MangoHud MangoHud] enabled, which has the capability to show what driver is currently in use.
</div>
<div lang="en" dir="ltr" class="mw-content-ltr">
=== SteamVR ===
</div>
<div lang="en" dir="ltr" class="mw-content-ltr">
The setcap issue at SteamVR start can be fixed with:
<code>sudo setcap CAP_SYS_NICE+ep ~/.local/share/Steam/steamapps/common/SteamVR/bin/linux64/vrcompositor-launcher</code>
</div>
<div lang="en" dir="ltr" class="mw-content-ltr">
=== Gamescope fails to launch when used within Steam ===
</div>
<div lang="en" dir="ltr" class="mw-content-ltr">
Gamescope may fail to start due to missing Xorg libraries. ([https://github.com/NixOS/nixpkgs/issues/214275 #214275]) To resolve this override the steam package to add them:
</div>
<syntaxhighlight lang="nix">
programs.steam.package = pkgs.steam.override {
  extraPkgs = pkgs': with pkgs'; [
    xorg.libXcursor
    xorg.libXi
    xorg.libXinerama
    xorg.libXScrnSaver
    libpng
    libpulseaudio
    libvorbis
    stdenv.cc.cc.lib # Provides libstdc++.so.6
    libkrb5
    keyutils
    # Add other libraries as needed
  ];
};
</syntaxhighlight>
<div lang="en" dir="ltr" class="mw-content-ltr">
=== Udev rules for additional Gamepads ===
</div>
<div lang="en" dir="ltr" class="mw-content-ltr">
In specific scenarios gamepads, might require some additional configuration in order to function properly in the form of udev rules. This can be achieved with <code>services.udev.extraRules</code>.
</div>
<div lang="en" dir="ltr" class="mw-content-ltr">
The following example is for the 8bitdo Ultimate Bluetooth controller, different controllers will require knowledge of the vendor and product ID for the device:
</div>
<syntaxhighlight lang="nix">
  services.udev.extraRules = ''
    SUBSYSTEM=="input", ATTRS{idVendor}=="2dc8", ATTRS{idProduct}=="3106", MODE="0660", GROUP="input"
  '';
</syntaxhighlight>
<div lang="en" dir="ltr" class="mw-content-ltr">
To find the vendor and product ID of a device [https://search.nixos.org/packages?channel=unstable&show=usbutils&from=0&size=50&sort=relevance&type=packages&query=usbutils usbutils] might be useful
</div>
<div lang="en" dir="ltr" class="mw-content-ltr">
=== Known issues ===
</div>
<div lang="en" dir="ltr" class="mw-content-ltr">
"Project Zomboid" may report "couldn't determine 32/64 bit of java". This is not related to java at all, it carries its own outdated java binary that refuses to start if path contains non-Latin characters. Check for errors by directly starting local java binary within <code>steam-run bash</code>.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
Resetting your password through the [[Steam]] app may fail at the CAPTCHA step repeatedly, with [[Steam]] itself reporting that the CAPTCHA was not correct, even though the CAPTCHA UI shows success. Resetting password through the [[Steam]] website should work around that.
</div>
<div lang="en" dir="ltr" class="mw-content-ltr">
== References ==
</div>

[[Category:Applications]]
[[Category:Gaming]]