feat: Rename to Steamify CachyOS

Menu header, shortcut, release titles, README and AGENTS.md. Repository, script and URLs keep the name cachyos-gamescope-boot.
This commit is contained in:
theupriser committed 2026-09-24 12:24:50 +02:00
1 parent 0607be86ac
commit 0b4a1555b7
8 files changed
+35 -27

No files matched your search

+3 -3
View File
@@ -73,7 +73,7 @@ jobs:
## Changes in v$VERSION ## Changes in v$VERSION
$changes" $changes"
gh release create "v$VERSION" dist/setup-gamescope-boot.sh assets/steam-gaming-settings.svg \ gh release create "v$VERSION" dist/setup-gamescope-boot.sh assets/steam-gaming-settings.svg \
--target "$GITHUB_SHA" --title "v$VERSION" --notes "$notes" --latest --target "$GITHUB_SHA" --title "Steamify CachyOS v$VERSION" --notes "$notes" --latest
# "latest" follows the newest version tag, for the older install URL # "latest" follows the newest version tag, for the older install URL
# (.../releases/download/latest/...). Only moved when a new version # (.../releases/download/latest/...). Only moved when a new version
@@ -81,8 +81,8 @@ jobs:
git tag -f latest "$GITHUB_SHA" && git push -f origin latest git tag -f latest "$GITHUB_SHA" && git push -f origin latest
latest_notes="Always the newest version, currently v$VERSION (see its release for the changes)." latest_notes="Always the newest version, currently v$VERSION (see its release for the changes)."
if gh release view latest >/dev/null 2>&1; then if gh release view latest >/dev/null 2>&1; then
gh release edit latest --title "Latest (v$VERSION)" --notes "$latest_notes" --latest=false gh release edit latest --title "Steamify CachyOS - latest (v$VERSION)" --notes "$latest_notes" --latest=false
else else
gh release create latest --title "Latest (v$VERSION)" --notes "$latest_notes" --latest=false gh release create latest --title "Steamify CachyOS - latest (v$VERSION)" --notes "$latest_notes" --latest=false
fi fi
gh release upload latest dist/setup-gamescope-boot.sh assets/steam-gaming-settings.svg --clobber gh release upload latest dist/setup-gamescope-boot.sh assets/steam-gaming-settings.svg --clobber
+2 -2
View File
@@ -5,7 +5,7 @@ for what the script does from a user's point of view.
## Project overview ## Project overview
A bash wizard that makes CachyOS (KDE Plasma 6 + `plasma-login-manager`) **Steamify CachyOS** (repository `cachyos-gamescope-boot`): a bash wizard that makes CachyOS (KDE Plasma 6 + `plasma-login-manager`)
boot into a SteamOS-style gamescope session, with working switching between boot into a SteamOS-style gamescope session, with working switching between
gamescope and the Plasma desktop. Primary target: the Valve Steam Machine gamescope and the Plasma desktop. Primary target: the Valve Steam Machine
(DMI `Valve`/`Fremont`) running CachyOS Desktop edition. (DMI `Valve`/`Fremont`) running CachyOS Desktop edition.
@@ -149,7 +149,7 @@ gamescope and the Plasma desktop. Primary target: the Valve Steam Machine
- The entry point loops: menu, run, "back to the menu" (or `[m]`/`[r]` when a - The entry point loops: menu, run, "back to the menu" (or `[m]`/`[r]` when a
restart is needed), until `q`; the restart question is asked once at the restart is needed), until `q`; the restart question is asked once at the
end. Scripted input that runs out ends the loop like `q`. end. Scripted input that runs out ends the loop like `q`.
- Wizard shortcut (`launcher`): the icon runs `curl | bash` of - Steamify shortcut (`launcher`): the icon runs `curl | bash` of
`releases/latest/download/setup-gamescope-boot.sh` in Konsole, so it's `releases/latest/download/setup-gamescope-boot.sh` in Konsole, so it's
always the newest release. Its icon, `assets/steam-gaming-settings.svg` always the newest release. Its icon, `assets/steam-gaming-settings.svg`
(Valve's GPL-2.0 return icon with a gear), is a release asset too, and is (Valve's GPL-2.0 return icon with a gear), is a release asset too, and is
+9 -2
View File
@@ -7,14 +7,21 @@ one per merged pull request.
## 0.9.0 - 2026-09-24 ## 0.9.0 - 2026-09-24
- **feat: Wizard shortcut on the desktop and in the launcher** The wizard is now called **Steamify CachyOS**, and can put a shortcut to
- New menu item: a "SteamOS Setup Wizard" desktop icon and app launcher entry itself on the desktop.
- `f01aa93` **feat: Wizard shortcut on the desktop and in the launcher**
- New menu item: a desktop icon and app launcher entry
that open the newest release of the wizard in Konsole (`curl | bash`). that open the newest release of the wizard in Konsole (`curl | bash`).
- Its icon: Valve's Return to Gaming Mode icon with a gear instead of the - Its icon: Valve's Return to Gaming Mode icon with a gear instead of the
arrow (`assets/steam-gaming-settings.svg`), published with every release arrow (`assets/steam-gaming-settings.svg`), published with every release
and downloaded from there. and downloaded from there.
- Desktop files are written already executable, so Plasma runs them instead - Desktop files are written already executable, so Plasma runs them instead
of opening them in an editor. of opening them in an editor.
- **feat: Rename to Steamify CachyOS**
- Menu header, the shortcut ("Steamify CachyOS", menu item "Steamify
shortcut"), release titles, README and AGENTS.md. The repository, script
and download URLs keep the name `cachyos-gamescope-boot`.
## 0.8.0 - 2026-09-24 (#8) ## 0.8.0 - 2026-09-24 (#8)
+7 -6
View File
@@ -1,4 +1,4 @@
# CachyOS Gamescope Boot Wizard # Steamify CachyOS
Turn a CachyOS desktop PC into a SteamOS-style console: it boots straight Turn a CachyOS desktop PC into a SteamOS-style console: it boots straight
into Steam's Big Picture (gamescope), and you can switch to the KDE Plasma into Steam's Big Picture (gamescope), and you can switch to the KDE Plasma
@@ -6,8 +6,9 @@ desktop and back whenever you like - just like on a Steam Deck or Valve's
Steam Machine. Steam Machine.
Out of the box, CachyOS doesn't quite manage this: the switch to the desktop Out of the box, CachyOS doesn't quite manage this: the switch to the desktop
can hang, and the PC doesn't reliably boot back into gaming mode. This can hang, and the PC doesn't reliably boot back into gaming mode. Steamify
script fixes that and sets everything up for you. fixes that and sets everything up for you. (The repository is still called
`cachyos-gamescope-boot`.)
## What you get ## What you get
@@ -24,9 +25,9 @@ Everything you turn off is put back the way it was.
4. **Single user mode** - like SteamOS: never a login or lock screen, no 4. **Single user mode** - like SteamOS: never a login or lock screen, no
user switching or logging out. Typing a password with a controller is no user switching or logging out. Typing a password with a controller is no
fun. (Needs 1.) fun. (Needs 1.)
5. **Wizard shortcut** - a "SteamOS Setup Wizard" icon on the desktop and in 5. **Steamify shortcut** - a "Steamify CachyOS" icon on the desktop and in
the app launcher (the Steam logo with a gear) that opens the newest version the app launcher (the Steam logo with a gear) that opens the newest version
of this wizard in Konsole, so you don't need the install command again. of Steamify in Konsole, so you don't need the install command again.
6. **Steam Machine support** - only shown on a Valve Steam Machine: the 6. **Steam Machine support** - only shown on a Valve Steam Machine: the
driver for the front LED bar, and the hardware settings in Steam (fan, driver for the front LED bar, and the hardware settings in Steam (fan,
TV control over HDMI-CEC). TV control over HDMI-CEC).
@@ -362,7 +363,7 @@ gamescope-session, ...) stay installed.
| `lib/vapor-theme.sh` | SteamOS theme: installs and switches to `cachyos-vapor` | | `lib/vapor-theme.sh` | SteamOS theme: installs and switches to `cachyos-vapor` |
| `lib/steamos-extras.sh` | SteamOS desktop extras from Valve's package (Add to Steam, Nested Desktop, icon, keyboard rule, KWallet) | | `lib/steamos-extras.sh` | SteamOS desktop extras from Valve's package (Add to Steam, Nested Desktop, icon, keyboard rule, KWallet) |
| `lib/single-user.sh` | Single user mode: no lock screen, user switching or log out | | `lib/single-user.sh` | Single user mode: no lock screen, user switching or log out |
| `lib/wizard-shortcut.sh` | Wizard shortcut: desktop icon and launcher entry that run the newest release | | `lib/wizard-shortcut.sh` | Steamify shortcut: desktop icon and launcher entry that run the newest release |
| `lib/bios.sh` | Update BIOS (Steam Machine, opt-in): current/newest version, double confirmation, fwupd | | `lib/bios.sh` | Update BIOS (Steam Machine, opt-in): current/newest version, double confirmation, fwupd |
| `lib/steam-machine.sh` | Steam Machine support: LED driver, LED access, steamos-manager | | `lib/steam-machine.sh` | Steam Machine support: LED driver, LED access, steamos-manager |
| `.github/tools/bundle.sh` | Builds the single-file version (`dist/setup-gamescope-boot.sh`) | | `.github/tools/bundle.sh` | Builds the single-file version (`dist/setup-gamescope-boot.sh`) |
+1 -1
View File
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?> <?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!-- Icon for the "SteamOS Setup Wizard" shortcut of cachyos-gamescope-boot. <!-- Icon for the "Steamify CachyOS" shortcut (cachyos-gamescope-boot).
Derived from Valve's steam-gaming-return.svg (steamdeck-kde-presets, Derived from Valve's steam-gaming-return.svg (steamdeck-kde-presets,
GPL-2.0): the Return to Gaming Mode arrow replaced by a gear. --> GPL-2.0): the Return to Gaming Mode arrow replaced by a gear. -->
<svg <svg

Before

Width:  |  Height:  |  Size: 11 KiB

After

Width:  |  Height:  |  Size: 11 KiB

+2 -2
View File
@@ -15,7 +15,7 @@ declare -A LABEL=(
[theme]="Install SteamOS theme: Vapor look (cachyos-vapor)" [theme]="Install SteamOS theme: Vapor look (cachyos-vapor)"
[glyphs]="Install Steam Deck/Machine icons: Deck button icons in gaming mode" [glyphs]="Install Steam Deck/Machine icons: Deck button icons in gaming mode"
[single]="Single user mode: no password, lock screen or log out (SDDM)" [single]="Single user mode: no password, lock screen or log out (SDDM)"
[launcher]="Wizard shortcut: desktop icon to run this wizard again" [launcher]="Steamify shortcut: desktop icon to run this again"
[machine]="Steam Machine support: LED bar driver, hardware settings in Steam" [machine]="Steam Machine support: LED bar driver, hardware settings in Steam"
[bios]="Update BIOS" [bios]="Update BIOS"
) )
@@ -104,7 +104,7 @@ run_menu() {
draw_menu_tui() { draw_menu_tui() {
local cursor="$1" i=0 c box state line local cursor="$1" i=0 c box state line
printf '\033[H\033[2J' printf '\033[H\033[2J'
echo -e "${c_bold}CachyOS Steam Deck-style Gamescope Boot Wizard${c_reset} v$VERSION" echo -e "${c_bold}Steamify CachyOS${c_reset} v$VERSION"
echo "Pick what you want. Anything you untick is put back the way it was." echo "Pick what you want. Anything you untick is put back the way it was."
echo echo
MENU_ITEMS=() MENU_ITEMS=()
+9 -9
View File
@@ -1,6 +1,6 @@
#!/bin/bash #!/bin/bash
# "Wizard shortcut" menu item: a desktop icon and an app launcher entry that # "Steamify shortcut" menu item: a desktop icon and an app launcher entry that
# open the newest release of this wizard in Konsole (curl | bash, like the # open the newest release of Steamify CachyOS in Konsole (curl | bash, like the
# install command in the README), so it's never out of date. # install command in the README), so it's never out of date.
# Sourced by setup-gamescope-boot.sh; not meant to be run on its own. # Sourced by setup-gamescope-boot.sh; not meant to be run on its own.
@@ -33,10 +33,10 @@ launcher_status() {
} }
launcher_enable() { launcher_enable() {
info "Adding the wizard shortcut (desktop icon and app launcher entry)..." info "Adding the Steamify shortcut (desktop icon and app launcher entry)..."
install_executable "$WIZARD_LAUNCHER" 755 << EOF install_executable "$WIZARD_LAUNCHER" 755 << EOF
#!/bin/bash #!/bin/bash
# Installed by cachyos-gamescope-boot: run the newest release of the wizard. # Installed by Steamify CachyOS: run its newest release.
if ! curl -fsSL --max-time 30 "$WIZARD_URL" | bash; then if ! curl -fsSL --max-time 30 "$WIZARD_URL" | bash; then
echo echo
echo "Couldn't download or run the wizard. Are you connected to the internet?" echo "Couldn't download or run the wizard. Are you connected to the internet?"
@@ -60,21 +60,21 @@ EOF
local entry local entry
entry="[Desktop Entry] entry="[Desktop Entry]
Type=Application Type=Application
Name=SteamOS Setup Wizard Name=Steamify CachyOS
Comment=Turn the SteamOS-style parts of this PC on or off (cachyos-gamescope-boot) Comment=Turn the SteamOS-style parts of this PC on or off
Exec=konsole -e $WIZARD_LAUNCHER Exec=konsole -e $WIZARD_LAUNCHER
Icon=$icon Icon=$icon
Terminal=false Terminal=false
Categories=System;Settings;" Categories=Game;System;Settings;"
printf '%s\n' "$entry" | install_executable "$WIZARD_APP_ENTRY" 644 printf '%s\n' "$entry" | install_executable "$WIZARD_APP_ENTRY" 644
printf '%s\n' "$entry" | install_executable "$(wizard_desktop_file)" 755 printf '%s\n' "$entry" | install_executable "$(wizard_desktop_file)" 755
kbuildsycoca6 >/dev/null 2>&1 || true kbuildsycoca6 >/dev/null 2>&1 || true
ok "Wizard shortcut added: \"SteamOS Setup Wizard\" on the desktop and in the launcher." ok "Steamify shortcut added: \"Steamify CachyOS\" on the desktop and in the launcher."
} }
launcher_disable() { launcher_disable() {
rm -f "$(wizard_desktop_file)" "$WIZARD_APP_ENTRY" "$WIZARD_LAUNCHER" "$WIZARD_ICON" rm -f "$(wizard_desktop_file)" "$WIZARD_APP_ENTRY" "$WIZARD_LAUNCHER" "$WIZARD_ICON"
rmdir "$(dirname "$WIZARD_LAUNCHER")" 2>/dev/null || true rmdir "$(dirname "$WIZARD_LAUNCHER")" 2>/dev/null || true
kbuildsycoca6 >/dev/null 2>&1 || true kbuildsycoca6 >/dev/null 2>&1 || true
ok "Wizard shortcut removed." ok "Steamify shortcut removed."
} }
+2 -2
View File
@@ -1,6 +1,6 @@
#!/bin/bash #!/bin/bash
# #
# setup-gamescope-boot.sh # setup-gamescope-boot.sh - Steamify CachyOS
# #
# Wizard that makes a CachyOS (KDE Plasma) install behave like SteamOS: # Wizard that makes a CachyOS (KDE Plasma) install behave like SteamOS:
# boot into a Steam Deck-style gamescope session, switch to the Plasma # boot into a Steam Deck-style gamescope session, switch to the Plasma
@@ -26,7 +26,7 @@ done
require_root_helper require_root_helper
echo -e "${c_bold}CachyOS Steam Deck-style Gamescope Boot Wizard${c_reset} v$VERSION" echo -e "${c_bold}Steamify CachyOS${c_reset} v$VERSION"
echo "Turn the SteamOS-style parts on or off. The menu shows what is on now;" echo "Turn the SteamOS-style parts on or off. The menu shows what is on now;"
echo "anything you turn off is put back the way it was." echo "anything you turn off is put back the way it was."