mirror of
https://github.com/theupriser/steamify-cachyos.git
synced 2026-10-03 17:41:58 +02:00
docs: README lists the sources and projects Steamify builds on, with licences and thanks
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
This commit is contained in:
1 parent
cab1a9792f
commit
96336fa80f
1 file changed
+45
@@ -187,6 +187,51 @@ Contributing (or an AI agent)? Read [AGENTS.md](AGENTS.md).
|
|||||||
|
|
||||||
MIT - do whatever you want with it. See [LICENSE.md](LICENSE.md).
|
MIT - do whatever you want with it. See [LICENSE.md](LICENSE.md).
|
||||||
|
|
||||||
|
## Sources and credits
|
||||||
|
|
||||||
|
Steamify is glue around other people's work. It installs, configures or
|
||||||
|
downloads the following, and doesn't claim any of it:
|
||||||
|
|
||||||
|
| Project | What Steamify uses it for |
|
||||||
|
|---|---|
|
||||||
|
| [CachyOS](https://cachyos.org) | The distribution it targets, and its packages: `cachyos-vapor` (the Vapor theme), the gamescope session packages (`gamescope-session-cachyos` and the autologin helpers), `dmemcg-booster` and `plasma-foreground-booster` (VRAM booster), and the `xone` / `xpadneo` DKMS packages (extended controller support) |
|
||||||
|
| [Valve / SteamOS](https://github.com/ValveSoftware/SteamOS) | The behaviour it imitates (`steam-set-session`, `steamos-manager`, the Steam Deck UI). Downloaded from Valve's package mirror at install time, never shipped here: `steamdeck-kde-presets` (the SteamOS extras, installed under `/usr/local`), the Steam Machine BIOS package and its checksums, and the SteamOS release number shown in Steam's System settings. The gear icon (`assets/steam-gaming-settings.svg`) is Valve's *Return to Gaming Mode* icon (GPL-2.0) with a gear |
|
||||||
|
| [Steam](https://store.steampowered.com) and [gamescope](https://github.com/ValveSoftware/gamescope) | The client and the compositor the gaming session is built on |
|
||||||
|
| [evlaV/linux-integration](https://github.com/evlaV/linux-integration) | Valve's `cros_ec_cec` kernel driver (GPL-2.0) for the Steam Machine's HDMI-CEC, downloaded at a pinned commit and checksum, then patched by `patches/cros-ec-cec-single-port.patch` |
|
||||||
|
| `leds-valve-dkms-git` (AUR) | The Steam Machine's front LED bar driver |
|
||||||
|
| [KDE Plasma](https://kde.org/plasma-desktop/), SDDM, plasma-login-manager | The desktop and the login managers whose settings it edits (`kwriteconfig6`, `lookandfeeltool`) |
|
||||||
|
| [DKMS](https://github.com/dell/dkms), [fwupd](https://fwupd.org), [yay](https://github.com/Jguer/yay) / [paru](https://github.com/Morganamilo/paru) | Building kernel modules, flashing the BIOS, and installing AUR packages |
|
||||||
|
| [PySide6 / Qt](https://doc.qt.io/qtforpython-6/) | The graphical app |
|
||||||
|
|
||||||
|
Licences: Steamify itself is MIT. `patches/steamify-fremont-poweroff.c` is a
|
||||||
|
kernel module and therefore GPL-2.0 (see its SPDX header), and the CEC
|
||||||
|
driver it patches is GPL-2.0 too. Each of the projects above keeps its own
|
||||||
|
licence.
|
||||||
|
|
||||||
|
The problems other people found first are credited where they were used: the
|
||||||
|
[SteamOS](https://github.com/ValveSoftware/SteamOS/issues/2626) and
|
||||||
|
[CachyOS gamescope-session](https://github.com/CachyOS/gamescope-session/issues/9)
|
||||||
|
issues linked in [TECHNICAL.md](TECHNICAL.md).
|
||||||
|
|
||||||
|
### Mentions
|
||||||
|
|
||||||
|
Thanks to:
|
||||||
|
|
||||||
|
- The **CachyOS** team and packagers, for a distribution that makes this
|
||||||
|
possible and for the gamescope session packages Steamify builds on.
|
||||||
|
- **Valve**, for SteamOS, for publishing its package repositories and the
|
||||||
|
Steam Machine's kernel sources, and for Steam and gamescope.
|
||||||
|
- **evlaV** for the public `linux-integration` mirror of Valve's kernel,
|
||||||
|
without which the Steam Machine's CEC driver would be out of reach.
|
||||||
|
- The maintainers of **`leds-valve-dkms-git`**, **xone**, **xpadneo**,
|
||||||
|
**dmemcg-booster** and **plasma-foreground-booster**.
|
||||||
|
- The **KDE**, **Arch Linux** and **AUR** communities, and the authors of
|
||||||
|
**yay** and **paru**.
|
||||||
|
- Everyone who reported problems or tested on real hardware.
|
||||||
|
|
||||||
|
If something here is missing or wrongly credited, open an issue or a pull
|
||||||
|
request and it will be fixed.
|
||||||
|
|
||||||
## Disclaimer
|
## Disclaimer
|
||||||
|
|
||||||
Steamify CachyOS is an unofficial community project. It is not affiliated
|
Steamify CachyOS is an unofficial community project. It is not affiliated
|
||||||
|
|||||||
Reference in new issue
Block a user