Skip to main content
Rockbox reads ~/.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" (CPAL) if omitted.

Top-level keys

Output sinks

Each sink has its own configuration block. See the dedicated pages:

Built-in (CPAL)

Default. No setup.

HLS + DASH (CMAF)

Plays in any browser.

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

The full 10-band parametric EQ is documented in Audio settings › Equalizer.

Crossfade

Tone & stereo

ReplayGain

Compressor

Where settings come from

There are three layers, in order of precedence:
  1. Runtime API calls — every setting is also exposed over GraphQL/gRPC and persists to disk on the next save cycle.
  2. settings.toml — applied once at startup.
  3. Compiled-in defaults — in apps/settings_list.c.
For the full settings catalogue with units, ranges and where each one is applied, see the Settings TOML reference.