enricobuehler
058630f542
- The "Punktfunk" shortcut is no longer hidden: it now ships committed
artwork (grid/wide/hero/logo/icon, generated by scripts/gen-steam-art.py
— a pure-stdlib SDF renderer drawing the lens mark + a monoline
"punktfunk" wordmark) applied via SetCustomArtworkForApp /
SetShortcutIcon. Existing installs are unhidden and re-arted once per
ART_VERSION; relaunching the library entry streams to the last host.
- Updates cover the flatpak CLIENT too: check_update compares the
user-scope installed commit against its remote, applyUpdate runs
`flatpak update --user` first (awaited) and the plugin reinstall —
which reloads the panel — last; docs spell out the sudo-less --user
update ("sudo flatpak update" silently skips per-user installs).
- Fullscreen page: DialogButton stretches to 100% width in the gamepad
UI, so the Stream/Pair/Refresh/… actions filled whole rows — sized to
content + right-aligned now; the header drops its Update button (About
tab + QAM banner keep the flow) and the back button gets a real 40px
hit target.
- Settings: the disable-Steam-Input note also shows for Automatic — on a
Deck that now forwards the built-in controller as a Steam Deck pad
(paddles/trackpads/gyro), which needs Steam Input off for the shortcut.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
89 lines
5.1 KiB
Markdown
89 lines
5.1 KiB
Markdown
# Punktfunk — Steam Deck plugin (Decky)
|
|
|
|
Stream to your **Steam Deck** without ever leaving Gaming Mode. This
|
|
**[Decky Loader](https://decky.xyz/)** plugin adds a **Punktfunk** panel to the Quick Access Menu
|
|
(the `…` button): discover hosts on your network, pair with a PIN, tweak stream settings, and launch
|
|
a fullscreen, gamescope-focused stream — all from the couch, gamepad-navigable.
|
|
|
|
The video itself is the native GTK4 Linux client (the `io.unom.Punktfunk` flatpak); the plugin
|
|
discovers, pairs, configures, and *launches it the right way* so gamescope fullscreens it — the same
|
|
Steam-shortcut trick MoonDeck uses. Because it's built from real Steam UI primitives (`@decky/ui`),
|
|
the panel looks and feels native to Gaming Mode.
|
|
|
|
## What it does
|
|
|
|
1. **Discover** — browses the LAN over mDNS for Punktfunk hosts, in both the QAM panel and a
|
|
fullscreen page; each host row opens a details view (address, pairing policy, certificate
|
|
fingerprint to cross-check against the host's log).
|
|
2. **Pair** — for a host that requires it, a gamepad-navigable PIN keypad runs the SPAKE2 pairing
|
|
ceremony headlessly, then remembers the host so future streams connect silently.
|
|
3. **Stream** — launches fullscreen via a branded "Punktfunk" Steam shortcut so gamescope focuses it.
|
|
4. **Settings** — resolution / refresh / bitrate / gamepad type / host compositor / mic, written
|
|
to the client's config.
|
|
5. **About** — plugin version, an explicit "Check for updates" button, the setup-guide link, and
|
|
a force-stop for a wedged stream client.
|
|
|
|
To leave a stream: the in-client controller chord (**L1 + R1 + Start + Select**), or close the
|
|
"game" from the Steam overlay — either returns you to Gaming Mode.
|
|
|
|
## Install on the Deck
|
|
|
|
You need **[Decky Loader](https://decky.xyz/)** and the **`io.unom.Punktfunk` flatpak**
|
|
([`packaging/flatpak`](../../packaging/flatpak/README.md)) installed on the Deck — SteamOS `/usr` is
|
|
read-only, so the flatpak (which bundles libadwaita/SDL3) is the canonical client. Discovery uses
|
|
`avahi-browse`, which ships on SteamOS/Bazzite.
|
|
|
|
**Recommended — install from URL** (published by CI): in Decky → Settings → **Developer Mode** →
|
|
**Install Plugin from URL**, paste:
|
|
|
|
```
|
|
https://git.unom.io/api/packages/unom/generic/punktfunk-decky/latest/punktfunk.zip
|
|
```
|
|
|
|
(or a pinned `.../punktfunk-decky/<version>/punktfunk.zip`). The plugin then **self-updates** without
|
|
the Decky store — when a newer build exists, an **Update** button appears and drives Decky
|
|
Loader's own (SHA-256-verified) install. Installs and updates can take a couple of minutes on some
|
|
networks: Decky's installer also contacts its plugin store first, which may be slow or blackholed
|
|
before the actual download proceeds.
|
|
|
|
## Build & sideload (development)
|
|
|
|
```sh
|
|
cd clients/decky
|
|
pnpm install
|
|
pnpm build # rollup → dist/index.js
|
|
pnpm run package # → out/punktfunk/ + out/punktfunk-v<ver>.zip
|
|
DECK=deck@<deck-ip> pnpm run deploy # rsync → /tmp, sudo-install into the root-owned plugins dir, restart loader
|
|
```
|
|
|
|
`~/homebrew/plugins/` is root-owned (the loader runs as root), so `deploy.sh` stages to a temp dir
|
|
then `sudo`-installs and restarts the loader — set `DECKPASS=…` to run it non-interactively. A loader
|
|
restart is required for an out-of-band install to appear.
|
|
|
|
## Architecture
|
|
|
|
| File | Role |
|
|
| --- | --- |
|
|
| `src/index.tsx` | Plugin entry: the QAM panel + route registration. |
|
|
| `src/page.tsx` | The `/punktfunk` fullscreen page — Hosts (with per-host details) / Settings / About tabs. |
|
|
| `src/settings.tsx` · `src/pair.tsx` | Stream-settings section; the gamepad-navigable PIN-pairing modal. |
|
|
| `src/hooks.ts` · `src/boundary.tsx` | Shared discovery/update hooks + actions; the render error boundary. |
|
|
| `src/steam.ts` | Steam-shortcut launch (`AddShortcut` / `SetAppLaunchOptions` / `RunGame`) — the focus-correct stream start. The shortcut's exe is `/bin/sh` with the wrapper passed as an argument, so the script never needs an exec bit (Decky's zip extraction drops it and the root-owned plugins dir can't be chmodded by the unprivileged backend). |
|
|
| `src/backend.ts` | Typed `callable` bridges to `main.py`. |
|
|
| `bin/punktfunkrun.sh` | The launch wrapper the Steam shortcut runs (so the window is focusable). |
|
|
| `main.py` | Backend: `discover` (via `avahi-browse`) / `pair` / settings / `kill_stream` / `check_update` (with an explicit CA-bundle search — Decky's embedded Python has no usable default TLS roots on SteamOS). |
|
|
| `plugin.json` · `update.json` | Decky manifest; CI-baked update channel. |
|
|
|
|
## Limitations / next steps
|
|
|
|
- No manual "add host by IP" entry yet (discovery is mDNS-only).
|
|
- No in-stream overlay inside the plugin — the client owns the session once launched.
|
|
- Pairing needs the operator to **arm pairing on the host** so it shows the PIN; the plugin can't arm
|
|
it remotely.
|
|
|
|
## Related
|
|
|
|
- **[Documentation](https://docs.punktfunk.unom.io/docs/steam-deck)** — Steam Deck setup guide
|
|
- **[Linux client](../linux/README.md)** — the app this plugin launches
|
|
- **[Project README](../../README.md)** — the host, the other clients, and how it all fits together
|