enricobuehler
7f639f7cf5
apple / swift (push) Successful in 1m16s
apple / screenshots (push) Successful in 6m29s
ci / web (push) Successful in 1m11s
ci / docs-site (push) Successful in 56s
android / android (push) Successful in 13m53s
arch / build-publish (push) Successful in 12m20s
decky / build-publish (push) Successful in 19s
ci / bench (push) Successful in 5m50s
docker / build-push (--build-arg FEDORA_VERSION=44, ci, ci/fedora-rpm.Dockerfile, punktfunk-fedora44-rpm) (push) Successful in 10s
docker / build-push (ci, ci/fedora-rpm.Dockerfile, punktfunk-fedora-rpm) (push) Successful in 9s
docker / build-push (., web/Dockerfile, punktfunk-web) (push) Successful in 34s
docker / build-push (docs-site, docs-site/Dockerfile, punktfunk-docs) (push) Successful in 59s
docker / build-push (ci, ci/rust-ci.Dockerfile, punktfunk-rust-ci) (push) Successful in 5m45s
docker / deploy-docs (push) Successful in 29s
deb / build-publish (push) Successful in 11m25s
ci / rust (push) Successful in 24m23s
rpm / build-publish (43, bazzite, punktfunk-fedora-rpm) (push) Successful in 18m16s
rpm / build-publish (44, fedora-44, punktfunk-fedora44-rpm) (push) Successful in 18m8s
The "Which should I use?" table on the clients page listed most client names as bold text, not links — only the Decky plugin and pf-webos were clickable — so the client references appeared broken. Link each client to its section (or dedicated page), and fix a stale Windows headless command. Repo-wide docs correctness/staleness pass against the code: - steam-deck: client-not-found -> flatpak-not-found (the real backend code) - install: host cert is punktfunk-host-windows_<ver>.cer, not ..._setup.cer - configuration: GPU_PRIORITY_CLASS default is auto; 10BIT/444 are default-on - how-it-works/index: GameStream/Moonlight is opt-in (--gamestream) - roadmap: clipboard sync is shipped, not planned - install-client: MSIX/cert artifacts are arch-suffixed (_x64/_arm64) - requirements: fix garbled 22H2/IddCx sentence - status: Linux encode also covers AMD/Intel (VAAPI/Vulkan Video) - automation: add the plugins.changed event - windows-host: note the optional bundled VB-CABLE virtual mic - sway: PUNKTFUNK_COMPOSITOR=hyprland is a wlroots-family alias - running-as-a-service: punktfunk-probe is a source-build-only dev tool Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
53 lines
3.1 KiB
Plaintext
53 lines
3.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) with zero CPU copies, 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
|
|
|
|
<Cards>
|
|
<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="Quick Start" href="/docs/quickstart" description="From nothing to streaming: set up a host and connect your first client." />
|
|
<Card title="Host Setup" href="/docs/requirements" description="Install on Ubuntu, Fedora, Arch, Bazzite, SteamOS, 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="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 a supported GPU — either a **Linux** machine running one of the
|
|
[supported setups](/docs/requirements) (**Ubuntu**, **Fedora**, **Arch**, or **Bazzite**), or
|
|
a **[Windows](/docs/windows-host) PC**.
|
|
- 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.
|