Skip to main content

Documentation Index

Fetch the complete documentation index at: https://rockboxzig.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Rockbox Zig is a modern take on the Rockbox open-source audio player firmware. The Rockbox C engine — gapless playback, DSP, 20+ codecs, and the tag database — is wrapped in Rust and Zig services that expose gRPC, GraphQL, HTTP and MPD APIs, add a Typesense-backed search engine, and stream audio to AirPlay, Snapcast, Squeezelite, Chromecast and UPnP receivers. Everything ships as a single binary called rockboxd.

Quickstart

Install Rockbox and play your first track in under five minutes.

Audio output

Built-in SDL, AirPlay, Snapcast, Squeezelite, Chromecast, UPnP/DLNA.

API reference

GraphQL, HTTP REST, gRPC and MPD — pick your protocol.

Client SDKs

TypeScript, Python, Ruby, Elixir, Clojure and Gleam.

​
What’s inside

Audio engine

Rockbox C firmware — gapless playback, parametric EQ, crossfade, ReplayGain, PBE, Haas surround, dithering, and the rbcodec DSP pipeline.

Codecs

MP3, OGG, FLAC, WAV, AAC, Opus, ALAC, Musepack, WMA, APE, Wavpack, Speex and many more.

Multi-room

Synchronised playback to AirPlay receivers, Snapcast clients, Squeezelite devices, Chromecasts and DLNA renderers — all at once.

Library

SQLite-backed tag database, instant Typesense search, browse-by-folder and ReplayGain-aware metadata.

APIs

gRPC on :6061, GraphQL on :6062, REST on :6063, MPD on :6600, plus MPRIS and UPnP/DLNA.

Clients

Native macOS (GPUI), GTK4 desktop app, React web UI, terminal TUI and a Rockbox REPL.

​
How it fits together

Clients

Web UI · GTK · GPUI · TUI · REPL · MPD · MPRIS

Protocols

gRPC :6061 · GraphQL :6062 · REST :6063 · MPD :6600

Rust services

playback · library · settings · search · playlists · airplay · slim · chromecast · upnp · netstream

Rockbox C

audio engine · DSP · codecs · tag database

PCM sinks

builtin · fifo · airplay · squeezelite · chromecast · snapcast_tcp · upnp

​
Status

Rockbox Zig is actively developed. The audio engine, library, search, MPD server and the AirPlay / Snapcast / Squeezelite / Chromecast sinks are all production-ready. Mobile clients and Wasm extensions are on the roadmap.
Looking for the source? It lives at github.com/tsirysndr/rockbox-zig. Issues and PRs welcome.