enricobuehlerandClaude Opus 5
d383161723
ci / rust (push) Failing after 2m31s
ci / docs-site (push) Successful in 1m22s
ci / web (push) Successful in 1m48s
docker / builders (--build-arg FEDORA_VERSION=44, ci/fedora-rpm.Dockerfile, punktfunk-fedora44-rpm, -f44) (push) Successful in 1m1s
ci / rust-arm64 (push) Successful in 2m2s
docker / builders (ci/android-ci.Dockerfile, punktfunk-android-ci) (push) Successful in 11s
docker / builders (ci/arch-ci.Dockerfile, punktfunk-arch-ci) (push) Successful in 9s
docker / builders (ci/fedora-rpm.Dockerfile, punktfunk-fedora-rpm) (push) Successful in 9s
docker / builders (ci/rust-ci-noble.Dockerfile, punktfunk-rust-ci-noble) (push) Successful in 9s
docker / builders (ci/rust-ci.Dockerfile, punktfunk-rust-ci) (push) Successful in 9s
docker / builders-arm64cross (push) Successful in 20s
docker / apps (., web/Dockerfile, punktfunk-web) (push) Canceled after 36s
docker / apps (docs-site, docs-site/Dockerfile, punktfunk-docs) (push) Canceled after 36s
docker / deploy-docs (push) Canceled after 0s
~1150 feat/fix commits landed since v0.19 and the docs drifted badly. This is a full sweep of every page against the code as shipped: ~280 verified corrections, nine new pages, and one deletion. The worst of what was wrong: the quickstart's five-minute path could not work (`serve` never started the web console, so step 3 had no PIN to read); every packaged Linux host runs `serve --gamestream` while security.md told readers to leave GameStream off; HDR was documented as Windows-only; `PUNKTFUNK_SECURE_DDA` was documented as a working knob that nothing reads; `PUNKTFUNK_INPUT_BACKEND` listed a `uinput` value that does not exist and named libei for KDE instead of kwin; README linked three pages deleted on 2026-07-05; and the rpm-ostree update command pointed at a script no package installs. Completeness: about half of what shipped since v0.19 had no page at all. New: support-matrix (what works where, from 217 verified capability cells), input (mouse/touch/pen — and the in-stream chords, so the docs finally say how to get your mouse back), client-settings, profiles-and-links, game-library, clipboard, wake-on-lan, hdr, uninstall. Updating existed but had zero inbound links. status.md is gone: its facts moved into the support matrix, its shell stays as a redirect so the public URL does not 404. roadmap.md is themes now, not a feature checklist — checkboxes are what rotted. Debian is no longer claimed. The .deb's Depends resolve against Ubuntu images, nothing in CI builds or tests Debian, and Debian 12 is below the glibc 2.39 floor. The `debian` in the repo URL is the package format. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
63 lines
4.1 KiB
Plaintext
63 lines
4.1 KiB
Plaintext
---
|
|
title: Introduction
|
|
description: Low-latency desktop and game streaming from a Linux or Windows host to any of your devices.
|
|
---
|
|
|
|
import { Cards, Card } from 'fumadocs-ui/components/card'
|
|
|
|
**Punktfunk** streams your desktop or games to your other devices — a laptop, a Mac, a tablet,
|
|
a TV — at low latency and at **each device's own resolution and refresh rate**. Run the host on a
|
|
Linux machine or a Windows PC, connect a client, and you're streaming.
|
|
|
|
It's built for the things that make streaming feel native:
|
|
|
|
- **Your device's exact mode.** The host spins up a virtual display sized to the client that's
|
|
connecting — 1080p60 to your laptop, 1440p120 to your desktop, 4K to your TV — at the same time.
|
|
No letterboxing, no scaling, no juggling your real monitors. On Windows that's Punktfunk's own
|
|
indirect display driver, frames pushed straight in — so there's no physical monitor or dummy HDMI
|
|
plug to deal with, even on the secure desktop.
|
|
- **Low latency, GPU end to end.** Frames go straight from the compositor to the GPU encoder —
|
|
NVENC on NVIDIA, Vulkan Video or VAAPI on AMD and Intel on Linux, AMF or QSV on Windows — with no
|
|
CPU copies on the paths where that's been validated (the
|
|
[support matrix](/docs/support-matrix#zero-copy-capture-to-encode) says which), and over a
|
|
transport tuned for responsiveness rather than throughput.
|
|
- **Works with the apps you already have.** Punktfunk also speaks the GameStream protocol, so with
|
|
`--gamestream` any **Moonlight** client connects — alongside a faster **native protocol** with
|
|
dedicated apps for **macOS, iOS, tvOS, Linux, Windows, and Android**.
|
|
- **Secure by default.** Hosts require a one-time PIN pairing; after that, devices reconnect on a
|
|
pinned identity. No accounts, no cloud.
|
|
|
|
## Pick your path
|
|
|
|
**New here? Start with the [Quick Start](/docs/quickstart)** — it takes you from nothing to a
|
|
stream and links out to the detail as you need it. The rest of these are for when you want depth.
|
|
|
|
<Cards>
|
|
<Card title="Quick Start" href="/docs/quickstart" description="From nothing to streaming: set up a host and connect your first client." />
|
|
<Card title="How It Works" href="/docs/how-it-works" description="The ideas behind Punktfunk in a few minutes — virtual displays, the two protocols, pairing." />
|
|
<Card title="Support Matrix" href="/docs/support-matrix" description="What works where — every host desktop, GPU and client app, each cell read out of the code that decides it." />
|
|
<Card title="Install the Host" href="/docs/install" description="Add the repo and install the package — Ubuntu, Fedora, Arch, Bazzite, SteamOS, NixOS, or Windows." />
|
|
<Card title="Connect a Client" href="/docs/clients" description="Stream with the native app for your device — macOS, Linux, Windows, Android — or any Moonlight client." />
|
|
<Card title="Your Game Library" href="/docs/game-library" description="The host finds your installed games by itself — browse a paired host and launch a title straight into the stream." />
|
|
<Card title="API Reference" href="/api" description="Interactive OpenAPI reference for the host's management REST API — status, devices, pairing, library." />
|
|
</Cards>
|
|
|
|
## What you need
|
|
|
|
- A **host** with an NVIDIA, AMD, or Intel GPU (there's a software encoder to fall back on without
|
|
one) — either a **Linux** machine running one of the [supported setups](/docs/requirements)
|
|
(**Ubuntu**, **Fedora**, **Arch**, **Bazzite**, or **SteamOS**), or a
|
|
**[Windows](/docs/windows-host) PC**. What each combination can actually do — codecs, HDR, 4:4:4,
|
|
cursor, input — is in the [Support matrix](/docs/support-matrix).
|
|
- A **client device** to stream to — there are native apps for **macOS, iOS/iPadOS, tvOS, Linux,
|
|
Windows, and Android**, plus any device that runs **Moonlight**.
|
|
- Both on the **same network** (LAN or VPN). Punktfunk is designed for a trusted local network.
|
|
|
|
Ready? Head to the [Quick Start](/docs/quickstart).
|
|
|
|
## Community
|
|
|
|
Questions, help, or want to try the **Android beta**? Join the
|
|
[**Discord**](https://discord.gg/kaPNvzMuGU) — request a tester invite there — or
|
|
[**r/Punktfunk**](https://www.reddit.com/r/Punktfunk/) on Reddit.
|