docs: user-facing docs revamp — structured product docs + per-platform setup
ci / web (push) Failing after 47s
ci / rust (push) Successful in 54s
docker / build-push (., web/Dockerfile, punktfunk-web) (push) Successful in 4s
docker / build-push (ci, ci/rust-ci.Dockerfile, punktfunk-rust-ci) (push) Successful in 3s
docker / build-push (docs-site, docs-site/Dockerfile, punktfunk-docs) (push) Successful in 17s
ci / docs-site (push) Failing after 37s
docker / deploy-docs (push) Successful in 17s
apple / swift (push) Successful in 1m19s
ci / web (push) Failing after 47s
ci / rust (push) Successful in 54s
docker / build-push (., web/Dockerfile, punktfunk-web) (push) Successful in 4s
docker / build-push (ci, ci/rust-ci.Dockerfile, punktfunk-rust-ci) (push) Successful in 3s
docker / build-push (docs-site, docs-site/Dockerfile, punktfunk-docs) (push) Successful in 17s
ci / docs-site (push) Failing after 37s
docker / deploy-docs (push) Successful in 17s
apple / swift (push) Successful in 1m19s
Replace the dev/agent-log pages with a proper user-facing doc set: - Getting Started: Introduction (rewritten), How It Works, Quick Start. - Host Setup: Requirements, then clean per-platform guides — Ubuntu GNOME, Ubuntu KDE, Fedora KDE (new), Bazzite (rewritten) — plus Running as a Service (desktop / headless GNOME / headless KDE). - Connecting: Clients overview, Moonlight, Pairing & Trust. - Configuration: host.env reference, Host CLI, Troubleshooting. - The dev/design notes (architecture, roadmap, the deferred design specs, CI) move to a clearly-separated "Project & Internals" nav section. Removes the superseded box-specific pages (gnome-box, headless-box, linux-setup, overview). status.md (the internal progress tracker, with box IPs) is kept as a file but dropped from the public nav. Site builds clean. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This commit is contained in:
@@ -1,49 +1,63 @@
|
||||
---
|
||||
title: "Bazzite / SteamOS-like Host"
|
||||
description: "Run punktfunk on Bazzite as a headless Steam host — gamescope session at the client's mode, input perms, and the gotchas."
|
||||
title: Bazzite — gamescope
|
||||
description: Set up a punktfunk host on Bazzite, streaming a Steam/gamescope session at your client's mode.
|
||||
---
|
||||
|
||||
Running punktfunk on **Bazzite** (Fedora Atomic / SteamOS-like) as a headless game-streaming host.
|
||||
The host launches a **gamescope** session at the *client's* exact resolution + refresh, so games see
|
||||
the client mode, not the box's TV. Full packaging (COPR / RPM / bootc) is in
|
||||
[`packaging/bazzite/README.md`](https://github.com); this page is the operational quick-reference.
|
||||
[Bazzite](https://bazzite.gg/) already ships everything a punktfunk host needs — the NVIDIA driver,
|
||||
NVENC, PipeWire, and **gamescope**. So a Bazzite host is the most "appliance-like" setup: the host
|
||||
launches its own gamescope session at the **client's** resolution and refresh, so your games run at
|
||||
the mode of the device you're streaming to, not the TV the box is plugged into.
|
||||
|
||||
## Input permissions — use the ujust command
|
||||
> This is ideal for a dedicated game-streaming box. For a general desktop, prefer
|
||||
> [Ubuntu/Fedora KDE](/docs/ubuntu-kde) or [GNOME](/docs/ubuntu-gnome).
|
||||
|
||||
Gamepad + DualSense injection needs the user in the `input` group. On Bazzite you **can't** just
|
||||
`usermod -aG input` (the immutable base + how the group is managed) — use the provided recipe:
|
||||
## Install
|
||||
|
||||
The host installs from the punktfunk COPR repository (see `packaging/bazzite/` in the repo for the
|
||||
exact COPR/RPM/bootc options). You can also build from source as on
|
||||
[Fedora KDE](/docs/fedora-kde) — Bazzite is Fedora Atomic underneath, and its FFmpeg builds the host
|
||||
fine.
|
||||
|
||||
## Allow controller input
|
||||
|
||||
Gamepad and DualSense input needs your user in the `input` group. On Bazzite, don't use
|
||||
`usermod` — the base is immutable and the group is managed by a recipe. Use:
|
||||
|
||||
```sh
|
||||
ujust add-user-to-input-group
|
||||
```
|
||||
|
||||
The udev rule (`60-punktfunk.rules`) grants access to `/dev/uinput` and `/dev/uhid`. A DualSense that
|
||||
shows "detected but no input" is almost always this **host-side** `/dev/uhid`/`/dev/uinput`
|
||||
permission, not a client bug — confirm the input group + the udev rule, then re-login.
|
||||
Then **log out and back in**. (A controller that's "detected but does nothing" is almost always this
|
||||
permission, not a client problem.)
|
||||
|
||||
## Headless Steam session at the client's mode
|
||||
## Configure
|
||||
|
||||
The host owns a `gamescope-session-plus` session and relaunches it when the client mode changes, so
|
||||
games run at the client's resolution + refresh (`--nested-refresh` + a generated CVT mode). Requires
|
||||
the headless-appliance prerequisites (linger + `multi-user.target`) and **no** physical gaming
|
||||
session running. Configure via `host.env`:
|
||||
Point the host at the gamescope backend in `~/.config/punktfunk/host.env`:
|
||||
|
||||
```sh
|
||||
PUNKTFUNK_COMPOSITOR=gamescope
|
||||
PUNKTFUNK_GAMESCOPE_SESSION=steam # host owns the session at the client mode
|
||||
PUNKTFUNK_GAMESCOPE_SESSION=steam # the host owns a Steam session at the client's mode
|
||||
PUNKTFUNK_INPUT_BACKEND=gamescope
|
||||
PUNKTFUNK_ZEROCOPY=1
|
||||
```
|
||||
|
||||
## Gotchas
|
||||
With this, when a client connects the host starts a `gamescope-session-plus` (Steam) session at the
|
||||
client's exact resolution and refresh, and relaunches it if the client changes mode. There should be
|
||||
**no physical gaming session already running** on the box.
|
||||
|
||||
- **gamescope ≥ 3.16.22 required.** Older versions deadlock capturing on PipeWire ≥ 1.6 (a loop-lock
|
||||
bug), and a wedged capture link head-blocks the whole PipeWire daemon. Never `pkill -x gamescope-wl`
|
||||
on a box where it's the live session compositor — it kills the user's session.
|
||||
- **The hardware cursor isn't in the capture** (gamescope limitation; won't-fix for now).
|
||||
- **HDR is blocked upstream**: gamescope's capture node is 8-bit only (PipeWire HDR export
|
||||
unimplemented), so HDR/10-bit is deferred even though the downstream encode path is ready.
|
||||
## Run as an always-on host
|
||||
|
||||
## FFmpeg
|
||||
Bazzite hosts are typically headless. Enable the host service and linger so it starts at boot — see
|
||||
[Running as a Service](/docs/running-as-a-service). Because the host launches its own gamescope
|
||||
session per client, you don't need a separate desktop-session unit.
|
||||
|
||||
Bazzite ships FFmpeg 7.x / libavcodec 61 — `ffmpeg-sys-next` auto-detects it and the host builds
|
||||
against it (validated live). NVENC (`hevc_nvenc` / `av1_nvenc`) works through the system FFmpeg.
|
||||
## Good to know
|
||||
|
||||
- **gamescope 3.16.22 or newer is required.** Older versions can deadlock during capture. Bazzite's
|
||||
current gamescope is fine; this only bites if you've pinned an old one.
|
||||
- **The mouse cursor isn't included in the captured image** — a gamescope limitation for now.
|
||||
- **HDR isn't supported yet** on the gamescope path — gamescope's capture output is 8-bit. SDR streams
|
||||
normally.
|
||||
|
||||
Then [connect a client](/docs/clients) — Moonlight works great for couch gaming, and the Apple app for
|
||||
Apple TV / iPad.
|
||||
|
||||
Reference in New Issue
Block a user