https://github.com/unlbslk/arch-deckify
A script to easily set up a SteamOS-like gaming environment on Arch Linux.
https://github.com/unlbslk/arch-deckify
archlinux steamdeck steamos
Last synced: 12 months ago
JSON representation
A script to easily set up a SteamOS-like gaming environment on Arch Linux.
- Host: GitHub
- URL: https://github.com/unlbslk/arch-deckify
- Owner: unlbslk
- License: mit
- Created: 2024-12-30T19:36:17.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-22T11:30:52.000Z (about 1 year ago)
- Last Synced: 2025-04-12T14:25:06.994Z (12 months ago)
- Topics: archlinux, steamdeck, steamos
- Language: Shell
- Homepage:
- Size: 120 KB
- Stars: 19
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: change_default_desktop.sh
- License: LICENSE
Awesome Lists containing this project
README
# 🎮 Arch-Deckify
A script to easily set up a SteamOS-like gaming environment on Arch Linux.
This script is designed to bring SteamOS-style session switching to Arch Linux. It automates the installation and setup of a **Gaming Mode (Gamescope)** and a **Desktop Mode (Wayland session)**, along with configuration for **SDDM** and several optional components.
## 📌 Features:
- **Wayland Session Selector**: Allows you to choose a desktop session for your system.
- **Gamescope Gaming Mode**: Switch to a full-screen gaming experience similar to SteamOS. It uses [gamescope-session-steam](https://github.com/ChimeraOS/gamescope-session-steam) (Thanks to ChimeraOS team for this).
- **SDDM Configuration**: Automatically configures SDDM for autologin.
- **Shortcut Creation**: Adds a desktop shortcut for easy switching to Gaming Mode.
- **Optional Tools**: Offers installation of **Flatpak**, **Decky Loader**.
- **Session Switcher**: Shortcuts to easily switch between desktop and game mode.
## ⛓️ Requirements:
- Arch Linux (or an Arch-based distribution)
- SDDM display manager
- A compatible GPU (NVIDIA hardware may face issues)
- A gamepad for best UI experience
- KDE Plasma Desktop (Other desktops are also supported, but KDE Plasma is recommended for the best experience.)
# 🧭 How to install?
**Run this code in your terminal and follow the instructions:**
```bash
curl -sSL https://raw.githubusercontent.com/unlbslk/arch-deckify/refs/heads/main/install.sh > deckify_install.sh && bash deckify_install.sh; rm -rf deckify_install.sh
```
And that's all!
## ⚠️ Important Notice (READ BEFORE INSTALLING)
Please note that running this script may modify important system configurations, files, and settings. In some cases, it could lead to system instability, configuration loss, or make the system unbootable. Restoring the system to a working state may require advanced technical knowledge. Before executing directly, check the content of the script.
By using this script, you acknowledge that **you** are fully responsible for any issues that arise, including but not limited to data loss, system corruption, or any unforeseen consequences. It is highly recommended that you back up your important data and configurations before proceeding. Use this script at your own risk.
### Session Switching
**The** `steamos-session-select` **command allows you to switch between Gamescope (Gaming Mode) and your selected Wayland session. Example usage:**
```bash
steamos-session-select gamescope # Switch to Gaming Mode
steamos-session-select desktop # Switch to Desktop (to your selected session)
```
You can also switch between Gaming Mode and Desktop Mode easily using the Steam interface or the desktop shortcut created during setup.
### Change Default Desktop
**To change the session used when switching to Desktop Mode, run the following script:**
```bash
curl -sSL https://raw.githubusercontent.com/unlbslk/arch-deckify/refs/heads/main/change_default_desktop.sh > deckify_change_default_desktop.sh && bash deckify_change_default_desktop.sh; rm -rf deckify_change_default_desktop.sh
```
### Updating System
You can update the system in Steam by adding the `~/arch-deckify/system_update.sh` file to Steam as a non-Steam game while in desktop mode.
> In order for the system update script to work, at least one of the supported terminals (konsole, gnome-terminal, kitty, alacritty) must be installed.
**Unfortunately, system updates are not possible through Steam settings.**
### Decky Plugin Loader
The Decky Loader is an **unofficial** community-driven tool that allows you to install and manage plugins for your Steam interface. While not essential for system functionality, it provides additional customization options for SteamOS. (https://decky.xyz/)
Please note that it is **not an official tool** and may cause issues. Any potential risks or problems are the user's responsibility.
**To install Decky Loader:**
```bash
curl -sSL https://raw.githubusercontent.com/unlbslk/arch-deckify/refs/heads/main/setup_deckyloader.sh > setup_deckyloader.sh && bash setup_deckyloader.sh; rm -rf setup_deckyloader.sh
```
**To remove Decky Loader:**
```bash
curl -sSL https://raw.githubusercontent.com/unlbslk/arch-deckify/refs/heads/main/remove_deckyloader.sh > remove_deckyloader.sh && bash remove_deckyloader.sh; rm -rf remove_deckyloader.sh
```
## Disclaimer
All logos, trademarks, and names related to **Steam**, **SteamOS**, **Steam Deck**, **Valve**, **Deckify** and other software such as **Plasma** and **Arch** are the property of their respective owners. These logos and names are used for reference and informational purposes only. This project is not affiliated with, endorsed, or sponsored by **Valve**, **Steam**, **SteamOS**, **Steam Deck**, **Plasma**, **Arch Linux**, **Flatpak**, **Decky Loader**, **Deckify** or any of their respective organizations. All rights reserved to the original trademark holders.