Files
punktfunk/docs-site/content/docs/clients.md
T
enricobuehler 296b976b8f
apple / swift (push) Successful in 54s
audit / cargo-audit (push) Failing after 1m19s
android / android (push) Failing after 2m22s
ci / web (push) Successful in 41s
ci / docs-site (push) Successful in 33s
ci / bench (push) Successful in 1m56s
deb / build-publish (push) Successful in 3m28s
ci / rust (push) Successful in 7m23s
docker / build-push (--build-arg FEDORA_VERSION=44, ci, ci/fedora-rpm.Dockerfile, punktfunk-fedora44-rpm) (push) Successful in 6s
docker / build-push (., web/Dockerfile, punktfunk-web) (push) Successful in 4s
decky / build-publish (push) Successful in 12s
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 18s
flatpak / build-publish (push) Successful in 3m59s
rpm / build-publish (bazzite, punktfunk-fedora-rpm) (push) Successful in 5m21s
docker / deploy-docs (push) Successful in 7s
rpm / build-publish (fedora-44, punktfunk-fedora44-rpm) (push) Successful in 4m43s
feat(windows-client): SDL3 gamepads + docs — full stage-1 parity, MSVC-green
Adds the SDL3 gamepad service (near-verbatim port of the GTK client's — SDL3 is
cross-platform) and wires it into the winit app: per-session capture (buttons/axes,
DualSense touchpad + motion 0xCC), feedback (rumble, lightbar, raw DualSense effects),
single-pad-forwarded model with auto pad-type from the physical controller. Built from
source on Windows (no system SDL3).

- gamepad.rs: GamepadService (app-lifetime SDL thread) attach/detach on session
  connect/end; auto_pref resolves "Automatic" to the attached pad's type.
- app.rs: hold the service, attach on Connected, detach on Ended/Failed/close. Also
  simplify the keydown path (drop the identical if/else arms).
- main.rs: start the service for the windowed path, resolve GamepadPref from settings +
  the physical pad.

Build gotcha documented + fixed in the dev loop: SDL3's build-from-source MSVC
precompiled-header chokes on the `ü` in the dev box's username embedded in the cargo
registry path (MSB8084/C4828) — CARGO_HOME must be an ASCII path
(C:\Users\Public\.cargo). Unrelated to our code.

Docs: CLAUDE.md M4 + docs/windows-client-bootstrap.md status banner (winit-not-Reactor
rationale, CARGO_HOME gotcha, what's pending) + docs-site clients.md "Windows desktop
client (in development)". Crate is build + clippy + fmt + test green on
x86_64-pc-windows-msvc.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-15 22:11:35 +00:00

4.5 KiB

title, description
title description
Clients The ways to connect to a punktfunk host — the Apple app, Moonlight, or the Linux client.

A punktfunk host accepts clients over its own punktfunk/1 protocol (the Apple and Linux apps) and over GameStream (Moonlight). Pick whichever fits the device you're streaming to.

Apple app (Mac, iPhone, iPad, Apple TV)

The native app for Apple devices speaks punktfunk's own punktfunk/1 protocol — the lowest-latency, most resilient path, with the full feature set:

  • Automatic host discovery — hosts on your network appear under On this network; no IP typing.
  • PIN pairing built in, and pinned reconnects after that.
  • Controllers, including DualSense — rumble, adaptive triggers, lightbar, motion, and touchpad.
  • A live stats overlay (resolution, fps, bitrate, latency) and a built-in network speed test to pick a bitrate for your link.

Open the app, pick your host, pair once, and stream. It builds from the clients/apple directory in the repo (Swift / VideoToolbox / Metal).

Moonlight (anything else)

punktfunk also speaks the GameStream protocol, so any Moonlight client — Windows, Android, Steam Deck, a browser, an old phone — connects with no punktfunk-specific software. See Connect with Moonlight.

This is the broadest-compatibility option and great for couch gaming. It doesn't use the native protocol's FEC/encryption extensions, but for a healthy LAN that rarely matters.

Linux desktop client (GTK4)

punktfunk-client is the native graphical Linux client — a GTK4 / libadwaita app that speaks punktfunk/1 directly, with hardware decode (VAAPI → dmabuf on Intel/AMD, software fallback), PipeWire audio, and SDL3 controllers (rumble, lightbar, DualSense touchpad/motion). Like the Apple app it discovers hosts on your network automatically, does PIN pairing, and pins reconnects.

It ships as a real package, not just a source build:

  • Ubuntu / Debianapt install punktfunk-client from the punktfunk apt registry (see packaging/debian/README.md).
  • Fedora / Bazziterpm-ostree install punktfunk-client from the Gitea RPM registry (see packaging/rpm/README.md).
  • Arch / SteamOS — the punktfunk-client split package from the PKGBUILD (see packaging/arch/README.md).
  • Steam Deck / any Flatpak distro — the io.unom.Punktfunk Flatpak bundle (see packaging/flatpak/README.md); this is what the Decky plugin launches.

Launch it, pick your host from the list, and stream. For scripting you can skip the host list and connect straight away:

punktfunk-client --connect <host>:9777   # skip the picker, start a session immediately

Windows desktop client (in development)

punktfunk-client for Windows (crates/punktfunk-client-windows) is the native graphical client for Windows — pure Rust, the same punktfunk/1 core as the Apple and Linux apps, with a winit + Direct3D11 present surface, WASAPI audio, FFmpeg decode, SDL3 controllers, network discovery, and PIN pairing. It builds on x86_64-pc-windows-msvc and runs the connect/decode/present/input path; hardware (D3D11VA) decode, 10-bit/HDR present, and a native host-list/settings window are in progress, so it is not yet packaged. For now it is driven from the command line:

punktfunk-client --discover                       # list hosts on the network
punktfunk-client --connect <host>:9777            # stream (trust-on-first-use)
punktfunk-client --connect <host>:9777 --pair 1234 # pair with the PIN the host shows

Until it ships, Moonlight remains the recommended way to stream to Windows (see below).

Linux reference client (headless)

punktfunk-client-rs (in the repo) is a command-line client for the native protocol, used for testing, development, and latency measurement — not an everyday client. It connects, streams to a file, runs the speed test, and can discover hosts:

punktfunk-client-rs --discover                        # list hosts on the network
punktfunk-client-rs --connect <host>:9777 --pin <fp>  # connect to one

Which should I use?

You're streaming to… Use
A Mac, iPhone, iPad, or Apple TV The Apple app
A Linux desktop or laptop, or a Steam Deck punktfunk-client (GTK4)
Windows, Android, a browser, a TV Moonlight
Automated tests / latency measurement punktfunk-client-rs (headless)

Whichever you choose, the first connection needs a one-time pairing.