Files
punktfunk/docs-site/content/docs/configuration.md
T
enricobuehler 9c8fa9340c
apple / swift (push) Failing after 40s
audit / cargo-audit (push) Failing after 1m12s
windows-msix / package (push) Successful in 1m37s
windows / build (push) Successful in 1m14s
android / android (push) Successful in 4m48s
ci / web (push) Successful in 27s
ci / rust (push) Successful in 4m21s
ci / docs-site (push) Successful in 31s
ci / bench (push) Successful in 4m39s
decky / build-publish (push) Successful in 11s
docker / build-push (--build-arg FEDORA_VERSION=44, ci, ci/fedora-rpm.Dockerfile, punktfunk-fedora44-rpm) (push) Successful in 5s
docker / build-push (., web/Dockerfile, punktfunk-web) (push) Successful in 4s
docker / build-push (ci, ci/fedora-rpm.Dockerfile, punktfunk-fedora-rpm) (push) Successful in 4s
docker / build-push (ci, ci/rust-ci.Dockerfile, punktfunk-rust-ci) (push) Successful in 4s
docker / build-push (docs-site, docs-site/Dockerfile, punktfunk-docs) (push) Successful in 19s
deb / build-publish (push) Successful in 6m3s
flatpak / build-publish (push) Successful in 4m13s
rpm / build-publish (bazzite, punktfunk-fedora-rpm) (push) Successful in 8m15s
rpm / build-publish (fedora-44, punktfunk-fedora44-rpm) (push) Successful in 8m16s
docker / deploy-docs (push) Successful in 18s
refactor: drop milestone names + consolidate clients; loss-recovery & rumble fixes
Two bodies of work in one commit (the rename moved files the fixes also touched).

Naming/structure cleanup (pre-launch):
- Host modules m3.rs->punktfunk1.rs, m0.rs->spike.rs; CLI m3-host->punktfunk1-host,
  m0->spike; bare `punktfunk-host` now prints help. Types M3Options/M3Source->
  Punktfunk1Options/Punktfunk1Source.
- Clients consolidated out of crates/ into clients/: punktfunk-client-rs->
  clients/probe (crate punktfunk-probe), client-linux->clients/linux,
  client-windows->clients/windows, punktfunk-android->clients/android/native
  (crate punktfunk-client-android; kept [lib] name=punktfunk_android so the JNI
  contract is unchanged). crates/ now holds only core + host.
- Milestone codes M0-M4 purged from code/CLI/CLAUDE.md/README/docs/docs-site,
  kept only in docs/implementation-plan.md. docs/m2-plan.md->
  docs/gamestream-host-plan.md. CI/gradle/flatpak paths updated.

Client loss-recovery (video froze and never recovered after a brief drop):
- Export punktfunk_connection_frames_dropped through the C ABI (the core already
  tracked it for the client keyframe-recovery loop; it was never reachable from
  the ABI clients). Regenerated punktfunk_core.h.
- Apple (StreamPump + Stage2Pipeline) and Android (decode.rs) now poll
  frames_dropped and request a keyframe when it climbs -- the same loss-driven
  recovery Linux/Windows already had. Under infinite GOP the decoder silently
  conceals reference-missing frames, so the decode-error trigger rarely fires.

Apple rumble robustness (worked then went spotty -- DualSense + Xbox):
- Add CHHapticEngine stopped/reset handlers (rebuild on app background / audio
  interruption / server reset) and drop the permanent `broken` latch on a
  transient drive failure; latch only when the controller truly has no haptics.
- Surface swallowed SDL set_rumble errors on Linux/Windows + diagnostic logging.

Verified: cargo build/clippy/fmt --workspace, C-ABI harness, header drift.
Not runnable on this box (verify in CI): Gitea workflows, gradle/Android,
flatpak, Swift/decky.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-18 21:05:58 +00:00

3.1 KiB

title, description
title description
Configuration The host.env settings — compositor, resolution, bitrate, input — and how to tune them.

The host reads its settings from ~/.config/punktfunk/host.env (a simple KEY=value file). Your setup guide gives you a starting host.env for your desktop; this page is the reference.

Session settings

These tell the host which desktop session to attach to. Your setup guide sets them for you.

Setting What it does
WAYLAND_DISPLAY The Wayland socket of your session (wayland-0 for a normal desktop).
XDG_CURRENT_DESKTOP Your desktop (GNOME, KDE).
XDG_RUNTIME_DIR, DBUS_SESSION_BUS_ADDRESS Needed when the host runs outside your interactive session (e.g. as a service).

Core settings

Setting Values Meaning
PUNKTFUNK_COMPOSITOR mutter · kwin · gamescope · wlroots Which backend creates the virtual display. Match your desktop.
PUNKTFUNK_VIDEO_SOURCE virtual · portal virtual creates a per-client display at its exact mode (the normal choice). portal captures an existing monitor instead.
PUNKTFUNK_ZEROCOPY 1 · 0 GPU zero-copy capture→encode. Leave on; it falls back to a CPU path automatically.
PUNKTFUNK_INPUT_BACKEND libei · gamescope · wlr · uinput How input is injected. libei for GNOME/KDE, gamescope for Bazzite.

Resolution and refresh rate

You don't set these on the host — the client chooses them. When a device connects, the host creates a virtual display at that device's resolution and refresh rate. A 1080p60 laptop and a 1440p120 desktop each get their own. (With Moonlight, set the mode in Moonlight's settings; with the Apple app, it uses the device's display.)

Bitrate

The client requests a bitrate; the host encodes to it. To find a good value for your link:

  • Apple app: use the built-in speed test (a host card's menu → Test Network Speed). It measures your link and suggests a bitrate, then applies it.
  • Moonlight: set the bitrate in Moonlight's settings. Start moderate and raise it.

Multiple devices at once

Today the native punktfunk/1 host (serve --native) streams one session at a time — additional clients wait in the accept queue until the active session ends. Each session gets its own virtual display at the client's exact resolution; concurrent native sessions are on the roadmap.

(punktfunk1-host, the standalone test host, has a --max-concurrent N knob, default 4, bounded by your GPU's encoder — see the Host CLI reference — but serve --native does not take that flag.)

Codec and FEC

  • The host encodes HEVC (H.265) by default; AV1 is available for clients that support it.
  • The native protocol adds forward error correction for lossy links. PUNKTFUNK_FEC_PCT=N sets the redundancy percentage (the default is sensible for a normal LAN).

Diagnostics

  • PUNKTFUNK_PERF=1 logs per-stage timing (capture, encode, send) — handy when tuning latency.
  • RUST_LOG=info (or debug) controls log verbosity.