Rockbox readsDocumentation Index
Fetch the complete documentation index at: https://rockboxzig.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
~/.config/rockbox.org/settings.toml once on startup. Edit the
file, then rockbox restart. There is no live-reload; the API is the way to
change things at runtime.
Minimal config
music_dir is the only required field. audio_output defaults to "builtin"
if omitted.
Top-level keys
| Key | Type | Default | Description |
|---|---|---|---|
music_dir | string | — | Absolute path to your music library |
audio_output | string | "builtin" | One of: builtin, fifo, airplay, squeezelite, chromecast, snapcast_tcp, upnp |
player_name | string | "" | Name advertised to MPD clients and UI |
Output sinks
Each sink has its own configuration block. See the dedicated pages:Built-in (SDL)
Default. No setup.
Snapcast
FIFO or direct TCP.
AirPlay
Single or multi-room RAOP.
Squeezelite
Slim Protocol multi-room.
Chromecast
Google Cast over WAV/HTTP.
UPnP / DLNA
Sink, server, renderer.
Playback defaults
Equalizer
Crossfade
Tone & stereo
ReplayGain
Compressor
Where settings come from
There are three layers, in order of precedence:- Runtime API calls — every setting is also exposed over GraphQL/gRPC and persists to disk on the next save cycle.
settings.toml— applied once at startup.- Compiled-in defaults — in
apps/settings_list.c.