diff --git a/.github/workflows/bundle.yml b/.github/workflows/bundle.yml index ffcadb1..b7dd5a3 100644 --- a/.github/workflows/bundle.yml +++ b/.github/workflows/bundle.yml @@ -73,7 +73,7 @@ jobs: ## Changes in v$VERSION $changes" 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 # (.../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 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 - 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 - 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 gh release upload latest dist/setup-gamescope-boot.sh assets/steam-gaming-settings.svg --clobber diff --git a/AGENTS.md b/AGENTS.md index 368966b..e37f5d8 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -5,7 +5,7 @@ for what the script does from a user's point of view. ## 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 gamescope and the Plasma desktop. Primary target: the Valve Steam Machine (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 restart is needed), until `q`; the restart question is asked once at the 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 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 diff --git a/CHANGELOG.md b/CHANGELOG.md index 93eccc2..59c50a3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,14 +7,21 @@ one per merged pull request. ## 0.9.0 - 2026-09-24 -- **feat: Wizard shortcut on the desktop and in the launcher** - - New menu item: a "SteamOS Setup Wizard" desktop icon and app launcher entry +The wizard is now called **Steamify CachyOS**, and can put a shortcut to +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`). - 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 and downloaded from there. - Desktop files are written already executable, so Plasma runs them instead 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) diff --git a/README.md b/README.md index b29c091..c02c361 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# CachyOS Gamescope Boot Wizard +# Steamify CachyOS 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 @@ -6,8 +6,9 @@ desktop and back whenever you like - just like on a Steam Deck or Valve's Steam Machine. 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 -script fixes that and sets everything up for you. +can hang, and the PC doesn't reliably boot back into gaming mode. Steamify +fixes that and sets everything up for you. (The repository is still called +`cachyos-gamescope-boot`.) ## 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 user switching or logging out. Typing a password with a controller is no 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 - 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 driver for the front LED bar, and the hardware settings in Steam (fan, 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/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/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/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`) | diff --git a/assets/steam-gaming-settings.svg b/assets/steam-gaming-settings.svg index 51c5e5f..e0b94de 100644 --- a/assets/steam-gaming-settings.svg +++ b/assets/steam-gaming-settings.svg @@ -1,5 +1,5 @@ - /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() { rm -f "$(wizard_desktop_file)" "$WIZARD_APP_ENTRY" "$WIZARD_LAUNCHER" "$WIZARD_ICON" rmdir "$(dirname "$WIZARD_LAUNCHER")" 2>/dev/null || true kbuildsycoca6 >/dev/null 2>&1 || true - ok "Wizard shortcut removed." + ok "Steamify shortcut removed." } diff --git a/setup-gamescope-boot.sh b/setup-gamescope-boot.sh index be759b6..565e034 100755 --- a/setup-gamescope-boot.sh +++ b/setup-gamescope-boot.sh @@ -1,6 +1,6 @@ #!/bin/bash # -# setup-gamescope-boot.sh +# setup-gamescope-boot.sh - Steamify CachyOS # # Wizard that makes a CachyOS (KDE Plasma) install behave like SteamOS: # boot into a Steam Deck-style gamescope session, switch to the Plasma @@ -26,7 +26,7 @@ done 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 "anything you turn off is put back the way it was."