Skip to content

About

Native LG webOS TV client for punktfunk

Topics

Resources

Stars

35 stars

Watchers

1 watching

Forks

Repository files navigation

Punktfunk

Build Release Downloads License

Native LG webOS TV client for Punktfunk — low-latency desktop & game streaming.


Targets webOS 5 and later (developed and verified live on an LG CX, webOS 5.6 and an LG G5, webOS 10), packaged as a homebrew .ipk. webOS 3.5–4.x gets H.264 SDR through the older NDL interface. Built directly on the upstream punktfunk-core crate (a pinned git dependency — see Cargo.toml).

The app is originally developed by dyptan.io and donated to Punktfunk organization. Built on the Punktfunk project by Enrico Bühler (unom) — all credit for the protocol and host implementation belongs there. This repo is only the webOS-specific client: a host for Punktfunk's shared controller shell (Skia on GL over an SDL3 window), NDL DirectMedia hardware video decode, and webOS packaging.

Screenshots

Hosts Games Settings Launching a game

Features

  • Video — up to 4K120 with HDR. H.264, HEVC or AV1, decoded by the TV's hardware media pipeline (NDL DirectMedia). AV1 HDR unverified. Other webOS clients report AV1 at 120 fps looking no smoother than 60, so HEVC is the pick for 120.
  • Bitrate — Automatic mode adjusts to the network, or set a fixed rate from 10 to 200 Mbps. A per-host network speed test measures over the real data plane and applies a recommended rate.
  • HDR calibration — press the remote's Blue button in the menu to measure the panel's black, peak and full-screen levels against the Windows HDR Calibration patterns, played on the video plane. The host then renders to that volume.
  • Audio — stereo, 5.1 or 7.1 Opus, decoded in software on the TV. An experimental stereo or 5.1 route hands the Opus to the TV's media pipeline instead.
  • Library — the host's game library, custom collections and ordering.
  • Settings profiles — Punktfunk's shared profiles: a named set of overrides (resolution, frame rate, bitrate, codec, HDR, audio, controller) bound to a game, picked per launch, or set as a host's default. The same profiles every other client edits.
  • Interface — Punktfunk's shared controller UI, the same one the desktop and Android clients use. Driven by a game pad, the Magic Remote, or a keyboard and mouse.
  • Input — Magic Remote pointer, gamepads, USB keyboard and mouse. Pointer capture for games, absolute pointing for the desktop; the Red button right-clicks.
  • DualSense — adaptive triggers, lightbar, player LEDs, touchpad, gyro, speakers and haptics over Bluetooth and wired (see the note below).
  • Hosts — LAN discovery (mDNS) or add a host by IP; PIN pairing with persisted trust, per-host settings.
  • Host power — Wake-on-LAN starts a sleeping host from the TV, and a paired host that grants those rights can be put to sleep or shut down from its card.

Controller advanced features need newer webOS version. Haptics, triggers, speakers, touchpad, and lightbar all rely on the kernel's hid-playstation driver, which LG ships only on webOS versions 10+. On webOS 5.x (e.g. the CX) the pad still works as an input, but no feedback reaches it. The app supports wired controller connection, which means that DS5Dongle connected to the TV can provide even better performance.

Installing

Via Homebrew Channel (recommended — installs/updates from the TV, no laptop needed):

  1. Install Homebrew Channel on the TV.
  2. Homebrew Channel → Configuration → Add repository → https://raw.githubusercontent.com/punktfunk/client-webos/main/repo.json
  3. Punktfunk now appears in the Homebrew Channel app list.

That repository serves a build of every commit on main. Tagged releases reach the TV through the central webosbrew repository instead.

Directly onto a TV (Developer Mode required): task deploy TV_HOST=root@<tv-ip>.

Development

Everything is a go-task target. Bare targets run natively and need a Linux-aarch64 host with Rust installed (that's how CI runs).

Task What it does
task build Compile a release binary
task package Build + package dist/*.ipk
task deploy TV_HOST=root@<tv-ip> Build, package, install, and launch on a real TV (via ares-cli-rs); add TELEMETRY=auto to stream logs here

For local dev prefix any target with docker: (task docker:build, task docker:package, …) — same logic in an ephemeral docker run, so only Docker is required, no local Rust/NDK install (the cross-toolchain image is Linux-aarch64-only; works on amd64 hosts via QEMU). task --list shows the rest.

deploy settings such as TV_HOST and SSH_KEY can be set in a local .env — see .env.example. Architecture and on-device gotchas live in docs/NOTES.md and AGENTS.md.

Use of AI

This project uses AI for writing code. The rules the agents follow are in AGENTS.md.

License

Dual-licensed under MIT or Apache 2.0, matching upstream Punktfunk, at your option.

About

Native LG webOS TV client for punktfunk

Topics

Resources

Stars

35 stars

Watchers

1 watching

Forks

Releases

Contributors

Languages