README.md
This commit is contained in:
Gavin Nugent
GitHub
parent
358f9b2803
commit
69522cd8ab
1 changed files with 37 additions and 144 deletions
181
README.md
181
README.md
|
|
@ -1,158 +1,51 @@
|
||||||
# W.O.P.R – Steam Gaming Mode for Hyprland
|
# W.O.P.R. – Steam Gaming Mode Launcher for OMARCHY (Arch)
|
||||||
|
|
||||||
> “Shall we play a game?”
|
> *“Shall we play a game?”*
|
||||||
|
|
||||||
**W.O.P.R** is a Hyprland-centric “gaming mode” launcher for Arch-based systems (designed on **Omarchy**).
|
W.O.P.R. is an opinionated Steam “gaming mode” launcher for Arch-based systems running **Hyprland**.
|
||||||
It installs a pair of helper scripts and Hyprland keybinds that:
|
|
||||||
|
|
||||||
- Start **gamescope** in a full-screen gaming session
|
It installs all the bits you need for a SteamOS-style experience (Steam, Gamescope, MangoHud, GameMode, 32-bit libs, GPU drivers), wires everything into Hyprland keybinds, and gives you a friendly TUI to pick resolution and performance overlay before it launches Steam.
|
||||||
- Launch **Steam** in Big Picture / Gamepad UI mode
|
|
||||||
- Apply CPU & GPU performance tweaks
|
|
||||||
- Optionally show a **MangoHud** overlay
|
|
||||||
- Restore everything cleanly when you quit
|
|
||||||
|
|
||||||
Once installed you get:
|
Once installed:
|
||||||
|
|
||||||
- `Super + Shift + S` → **Enter Gaming Mode** (W.O.P.R TUI, then Steam)
|
- `SUPER`+`SHIFT`+`S` → **enter Gaming Mode**
|
||||||
- `Super + Shift + R` → **Exit Gaming Mode** (restore governors, GPU states, idle, etc.)
|
- `SUPER`+`SHIFT`+`R` → **exit Gaming Mode and restore your desktop**
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
- 🖥 **Resolution presets**
|
- 🎮 **One-key Steam “Gaming Mode”**
|
||||||
|
- Launches Steam inside Gamescope using a floating, pinned TUI
|
||||||
The TUI detects your current monitor and lets you choose:
|
- Default keybinds: `SUPER`+`SHIFT`+`S` to start, `SUPER`+`SHIFT`+`R` to exit
|
||||||
|
- 🖥️ **Resolution presets & scaling**
|
||||||
- Native resolution (best quality)
|
- Native panel resolution
|
||||||
- 1440p upscaled (1080p → 1440p)
|
- 1080p → 1440p upscaled
|
||||||
- 1440p native (2560×1440)
|
- Native 1440p
|
||||||
- 4K upscaled (1440p → 4K)
|
- 1440p → 4K upscaled
|
||||||
- 4K/UHD native (3840×2160)
|
- Native 4K/UHD (3840×2160)
|
||||||
|
|
||||||
Internally it configures *gamescope*’s render and output sizes to match.
|
|
||||||
|
|
||||||
- 📊 **MangoHud presets**
|
- 📊 **MangoHud presets**
|
||||||
|
- Off (clean view)
|
||||||
- **Off** – cleanest view
|
- Minimal – FPS counter only
|
||||||
- **Minimal** – FPS counter only
|
- Full stats – CPU, GPU, frametime, temps, etc.
|
||||||
- **Full Stats** – FPS, frametime, CPU/GPU temps, power, RAM, etc.
|
- ⚙️ **Automatic GPU detection**
|
||||||
|
- NVIDIA, AMD, Intel iGPU, Intel Arc
|
||||||
- ⚙️ **Performance mode**
|
- Installs appropriate Vulkan and 32-bit driver stacks via `pacman`
|
||||||
|
- 🚀 **Performance mode (optional)**
|
||||||
When `PERFORMANCE_MODE=enabled` (default):
|
- Temporarily switches CPU governor and GPU power/performance settings for gaming
|
||||||
|
- Uses udev rules so later launches do **not** require sudo
|
||||||
- Uses **gamemoderun** to wrap gamescope/Steam
|
- Restores everything cleanly when you exit gaming mode
|
||||||
- Can add `--rt --immediate-flips` to gamescope for lower latency
|
- 🧠 **Remembers your choices**
|
||||||
- Optionally grants `cap_sys_nice` to `gamescope` (if you accept the prompt)
|
- Saves last used resolution and overlay and offers to reuse them next time
|
||||||
- Switches CPU governor to performance-oriented mode while gaming
|
- 🎨 **Themed TUI with `gum`**
|
||||||
- Applies GPU performance tweaks and records original settings
|
- Uses your terminal’s colours (Ghostty/kitty/Alacritty/foot/xterm)
|
||||||
|
- Clean centred layout with a WarGames-style header
|
||||||
On exit, CPU governor, GPU power/perf modes and idle behaviour are restored.
|
- 🧩 **Intel Arc quality-of-life fixes**
|
||||||
|
- Optional GTK4 rendering workaround (sets `GSK_RENDERER=gl`) to fix visual glitches in Nautilus and other GTK4 apps
|
||||||
- 🎮 **Steam launch modes**
|
- 🧰 **Arch-friendly installer**
|
||||||
|
- Checks multilib, Steam dependencies and 32-bit libs
|
||||||
Configurable via `/etc/gaming-mode.conf` or `~/.gaming-mode.conf`:
|
- Offers a full system upgrade (`pacman -Syu`) before installing anything
|
||||||
|
- Rolls back cleanly if something fails
|
||||||
- `STEAM_LAUNCH_MODE=bigpicture` → `steam -tenfoot` (default)
|
|
||||||
- `STEAM_LAUNCH_MODE=gamepadui` → `steam -gamepadui`
|
|
||||||
|
|
||||||
- 🧠 **Smart GPU support**
|
|
||||||
|
|
||||||
Detects GPU(s) via `lspci` and helper functions:
|
|
||||||
|
|
||||||
- **NVIDIA** – installs Vulkan loader, 32-bit libs and video drivers
|
|
||||||
- **AMD** – installs RADV Vulkan stack, 32-bit libs and VAAPI/VDPAU
|
|
||||||
- **Intel Arc (xe)** – installs lean Vulkan + compute stack and applies
|
|
||||||
a `GSK_RENDERER=gl` fix for GTK4 apps on Arc
|
|
||||||
- **Intel iGPU (i915/Xe)** – installs the full Intel media/Vulkan stack
|
|
||||||
|
|
||||||
On first run it can also add you to relevant groups (e.g. `video`, `input`,
|
|
||||||
`gamemode` etc.), and will warn that you need to log out and back in.
|
|
||||||
|
|
||||||
- 🎨 **Omarchy-aware theming**
|
|
||||||
|
|
||||||
If available, it reads colours from:
|
|
||||||
|
|
||||||
- `~/.config/omarchy/current/theme/ghostty.conf`
|
|
||||||
- `~/.config/omarchy/current/theme/colors.sh`
|
|
||||||
|
|
||||||
and uses them to style the **gum** TUI. If those aren’t present, it falls
|
|
||||||
back to a neutral dark theme.
|
|
||||||
|
|
||||||
- 🪟 **Tidy Hyprland integration**
|
|
||||||
|
|
||||||
- Automatically finds your Hyprland config:
|
|
||||||
- `~/.config/hypr/bindings.conf`
|
|
||||||
- `~/.config/hypr/keybinds.conf`
|
|
||||||
- `~/.config/hypr/hyprland.conf`
|
|
||||||
- Appends a clearly-marked block of bindings and window rules
|
|
||||||
- Makes the W.O.P.R terminal **floating, centred and pinned**
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## How it works
|
|
||||||
|
|
||||||
The installer script (`WOPR.sh`):
|
|
||||||
|
|
||||||
1. **Validates environment**
|
|
||||||
|
|
||||||
- Requires `pacman`, `hyprctl` and a Hyprland config under `~/.config/hypr/`.
|
|
||||||
|
|
||||||
2. **Checks Steam + GPU dependencies**
|
|
||||||
|
|
||||||
- Refreshes pacman DB (`pacman -Syy`)
|
|
||||||
- Optionally offers a full system upgrade (`pacman -Syu`)
|
|
||||||
- Verifies the **multilib** repository is enabled (needed for 32-bit Steam)
|
|
||||||
- Assembles a list of core packages (Steam, Vulkan loaders, 32-bit libs etc.)
|
|
||||||
plus GPU-specific packages, then offers to install anything missing.
|
|
||||||
|
|
||||||
3. **Installs core tools (if needed)**
|
|
||||||
|
|
||||||
Through `setup_requirements()` it ensures:
|
|
||||||
|
|
||||||
- `steam`, `gamescope`, `mangohud`, `gum`
|
|
||||||
- `python`, `pciutils`, `libcap`, `gamemode`
|
|
||||||
- plus whatever is needed by your GPU
|
|
||||||
|
|
||||||
4. **Deploys launcher scripts**
|
|
||||||
|
|
||||||
Creates:
|
|
||||||
|
|
||||||
- `~/.local/share/steam-launcher/enter-gamesmode`
|
|
||||||
- `~/.local/share/steam-launcher/leave-gamesmode`
|
|
||||||
|
|
||||||
These manage:
|
|
||||||
|
|
||||||
- Session state (`~/.cache/gaming-session`)
|
|
||||||
- CPU governor / GPU perf modes
|
|
||||||
- Hypridle (suspend/lock) behaviour
|
|
||||||
- gamescope + Steam start/stop
|
|
||||||
- MangoHud configuration
|
|
||||||
|
|
||||||
5. **Adds Hyprland keybinds**
|
|
||||||
|
|
||||||
Appends a block like:
|
|
||||||
|
|
||||||
```ini
|
|
||||||
# Gaming Mode bindings - added by installation script
|
|
||||||
windowrulev2 = float, class:(WOPR-Terminal)
|
|
||||||
windowrulev2 = size 800 600, class:(WOPR-Terminal)
|
|
||||||
windowrulev2 = center, class:(WOPR-Terminal)
|
|
||||||
windowrulev2 = pin, class:(WOPR-Terminal)
|
|
||||||
|
|
||||||
bindd = SUPER SHIFT, S, Steam Gaming Mode, exec, <your-terminal> ~/.local/share/steam-launcher/enter-gamesmode
|
|
||||||
bindd = SUPER SHIFT, R, Exit Gaming Mode, exec, ~/.local/share/steam-launcher/leave-gamesmode
|
|
||||||
# End Gaming Mode bindings
|
|
||||||
|
|
||||||
(It auto-detects whether your config uses bind or bindd.)
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
6. Validation
|
|
||||||
|
|
||||||
A final check confirms:
|
|
||||||
• Launcher scripts exist and are executable
|
|
||||||
• The bindings block is present in your Hypr config
|
|
||||||
• gamescope capabilities are compatible with PERFORMANCE_MODE
|
|
||||||
|
|
|
||||||
Loading…
Add table
Reference in a new issue