blob: 87bc18162a3f97b248f8ed02a91bea589a35c994 [file] [log] [blame]
Björn Stenbergdcfc20f2002-10-10 14:05:34 +00001Custom CFG
Justin Heiner94d3ba22002-09-06 06:20:15 +00002File Format Specifications
3
4Description / General Info
5--------------------------
Björn Stenbergdcfc20f2002-10-10 14:05:34 +00006* The .cfg file is used on both the Rockbox Player and Recorder, in order to
7 load custom settings.
8* Currently, only sound settings are supported but this will change in the
9 future.
Justin Heiner94d3ba22002-09-06 06:20:15 +000010
11File Location
12-------------
13The files may reside anywhere on the hard disk. The only restriction is that
Björn Stenbergdcfc20f2002-10-10 14:05:34 +000014the filename must end in .cfg
Justin Heiner94d3ba22002-09-06 06:20:15 +000015
16Format Rules
17------------
Björn Stenberg0e6088f2002-10-02 16:33:26 +000018* Each setting must have it's own line.
19* Lines starting with # are ignored.
Justin Heiner94d3ba22002-09-06 06:20:15 +000020* If a value is out of the acceptable range for the device, which can vary
Björn Stenberg0e6088f2002-10-02 16:33:26 +000021 depending on the model, the value will be set to its default value.
Justin Heiner94d3ba22002-09-06 06:20:15 +000022
23Example File
24------------
Björn Stenberg0e6088f2002-10-02 16:33:26 +000025volume: 70
26bass: 11
27treble: 12
28balance: 0
29channels: 0
30loudness: 5
31bass boost: 30
32auto volume: 0
Justin Heiner94d3ba22002-09-06 06:20:15 +000033
Björn Stenberg0e6088f2002-10-02 16:33:26 +000034This sets each line to the respective values after it.
35
36Value ranges
37------------
38volume: 0 to 100
39bass: player: -15 to 15, recorder: -12 to 12
40treble: player: -15 to 15, recorder: -12 to 12
41balance: -100 to 100
42channels: 0=Stereo, 1=Mono, 2=Mono Left, 3=Mono Right
43loudness: 0 to 17 (recorder only)
44bass boost: 0 to 100 (recorder only)
45auto volume: 0=off, 1=2s, 2=4s, 3=8s (recorder only)