summaryrefslogtreecommitdiff
path: root/docs/CUSTOM_CFG_FORMAT
diff options
context:
space:
mode:
Diffstat (limited to 'docs/CUSTOM_CFG_FORMAT')
-rw-r--r--docs/CUSTOM_CFG_FORMAT45
1 files changed, 45 insertions, 0 deletions
diff --git a/docs/CUSTOM_CFG_FORMAT b/docs/CUSTOM_CFG_FORMAT
new file mode 100644
index 0000000000..87bc18162a
--- /dev/null
+++ b/docs/CUSTOM_CFG_FORMAT
@@ -0,0 +1,45 @@
1Custom CFG
2File Format Specifications
3
4Description / General Info
5--------------------------
6* 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.
10
11File Location
12-------------
13The files may reside anywhere on the hard disk. The only restriction is that
14the filename must end in .cfg
15
16Format Rules
17------------
18* Each setting must have it's own line.
19* Lines starting with # are ignored.
20* If a value is out of the acceptable range for the device, which can vary
21 depending on the model, the value will be set to its default value.
22
23Example File
24------------
25volume: 70
26bass: 11
27treble: 12
28balance: 0
29channels: 0
30loudness: 5
31bass boost: 30
32auto volume: 0
33
34This 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)