https://github.com/SteamNix/SteamNix
Nix Flake for creating a SteamOS like experience on NixOS.
https://github.com/SteamNix/SteamNix
Last synced: 19 days ago
JSON representation
Nix Flake for creating a SteamOS like experience on NixOS.
- Host: GitHub
- URL: https://github.com/SteamNix/SteamNix
- Owner: SteamNix
- Created: 2025-03-31T02:27:55.000Z (29 days ago)
- Default Branch: main
- Last Pushed: 2025-04-08T11:39:50.000Z (21 days ago)
- Last Synced: 2025-04-08T12:34:51.245Z (21 days ago)
- Language: Python
- Size: 68.4 KB
- Stars: 7
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-starred - SteamNix/SteamNix - SteamOS but Nix Flavoured. (Nix)
README
# ❄️ SteamOS NixOS Edition ❄️
Nix Flake for creating a SteamOS like experience on NixOS. Clean quiet boot like on SteamDeck. Two second shutdown time. Meant for those who primarily use SSH, but would like a SteamOS experience for games. For example, you own a MacBook Pro and don't care to use linux desktop software.
# Requirements
* PC with NixOS installed and BTRFS filesystem.
* Ethernet Connection
* Desktop PC (SteamDeck will not work)
* Basic knowledge of NixOS (editing time zone, fileystem options, etc. from config file)
# Features
* Zero Desktop Bloat. Gamescope is used as window manager.
* Latest CatchyOS Kernel
* FPS improvement comapred to Stock NixOS kernel.
* Clean, textless boot. Similar to SteamDeck bootup. Minus the Splash logo.
* Read-only system files and binaries to prevent corruption or malware.
* Boot menu with previous system states, incase update breaks system, allowing you to boot to a previous good state.
* Full Control over system via Nix configuration file
# How to Build NixOS Base System from Flake
```
git clone https://github.com/leonewton253/SteamOS-NixOS-Edition.git
cp /etc/nixos/hardware-configuration.nix systemFlake/
nix-channel --add https://nixos.org/channels/nixos-unstable nixos
sudo nixos-rebuild boot --upgrade --flake systemFlake/
sudo reboot now
```
All Further changes to configuration.nix for the system need to be done through this command and configuration file!
# How to use VDF Editor (Add Non-Steam Games)
```
cd VDF-Editor
python shortcuts.py shortcuts.vdf "Super Video Game IV" "~/mount/ES-DE/EmulationStation.AppImage" ~/mount/ES-DE/ "" "" "" 0 0 1 0 0 FPS Puzzle
```
```
"Super Video Game IV" = Game Title
"~/mount/ES-DE/EmulationStation.AppImage" = location of executable or command
```
Find Folder to copy VDF file to:
```
find .local/share/Steam/ -name localconfig*
```
Copy VDF file to Remote directory :
```
scp shortcuts.vdf [email protected]:.local/share/Steam/userdata/115922529/config/
```
Restart Steam/PC
# Installing Epic Games
SSH into PC and run:
```
legendary install gameid
```
# Running Epic Games with Steam's Proton
* Create script such as godlike.sh
```
#!/usr/bin/env bash
GAME_ID=...
PROTON=$(find $HOME/.steam/steam/steamapps/common/ -maxdepth 1 -name *Experimental | sort | sed -e '$!d')
export STEAM_GAME_PATH=
export STEAM_COMPAT_DATA_PATH="$STEAM_GAME_PATH" # Or point to where your pfx folder is
export STEAM_COMPAT_CLIENT_INSTALL_PATH="$STEAM_GAME_PATH"
legendary launch $GAME_ID --no-wine --wrapper "'$PROTON/proton' run"
```
* Fill in STEAM_GAME_PATH with path to game, default ~/Games/GameFolder
* Fill in GAME_ID with gameid
* Create a shortcut and add the full script path to the target field in parentheses: "/home/steamos/godlike.sh"
# Symlinking RetroArch Cores so EmulationStation can find them (If using AppImage)
```
ln -s /run/current-system/sw/lib/retroarch/cores/ .config/retroarch/
```
NixOS uses hashes as paths and are subject to change. /run/current-system contains static paths to hashed folders.
# Future Updates
* VDF python script will be updated into a universal CLI importer for non-steam and DRM free games
* Game banners will be imported for each sortcut
* Boot time improvement
* Add dot files for preconfigured RetroArch and EmulationStation settings
* Create minimal auto installer ISO
* Create GH pages site with basic support