summaryrefslogtreecommitdiff
path: root/manual
diff options
context:
space:
mode:
authorSolomon Peachy <pizza@shaftnet.org>2020-08-24 19:27:23 -0400
committerSolomon Peachy <pizza@shaftnet.org>2020-08-24 19:27:23 -0400
commit22eb2300b10768a63131d78b3607460b93dda2c5 (patch)
treed0668170e5fcd7b7e2bf5bae1879c1e006367e84 /manual
parent062c597f79c833f0f8bbd715074f0569b2db4943 (diff)
downloadrockbox-22eb2300b10768a63131d78b3607460b93dda2c5.tar.gz
rockbox-22eb2300b10768a63131d78b3607460b93dda2c5.zip
manual: Document all mikmod configuration options
Change-Id: I942b3198c720ab74d429f5549f7eae01390c567d
Diffstat (limited to 'manual')
-rw-r--r--manual/plugins/mikmod.tex24
-rw-r--r--manual/rockbox_interface/main.tex2
2 files changed, 23 insertions, 3 deletions
diff --git a/manual/plugins/mikmod.tex b/manual/plugins/mikmod.tex
index 00040c28ee..2564dadef2 100644
--- a/manual/plugins/mikmod.tex
+++ b/manual/plugins/mikmod.tex
@@ -2,8 +2,6 @@
2 2
3Mikmod plays most common tracker music formats. 3Mikmod plays most common tracker music formats.
4 4
5\note{TODO: Document configuration settings}
6
7\begin{btnmap} 5\begin{btnmap}
8 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,GIGABEAT_PAD,GIGABEAT_S_PAD% 6 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,GIGABEAT_PAD,GIGABEAT_S_PAD%
9 ,IAUDIO_X5_PAD,MROBE100_PAD,PBELL_VIBE500_PAD,SANSA_FUZEPLUS_PAD,SAMSUNG_YH92X_PAD% 7 ,IAUDIO_X5_PAD,MROBE100_PAD,PBELL_VIBE500_PAD,SANSA_FUZEPLUS_PAD,SAMSUNG_YH92X_PAD%
@@ -67,3 +65,25 @@ Mikmod plays most common tracker music formats.
67 \opt{HAVEREMOTEKEYMAP}{& } 65 \opt{HAVEREMOTEKEYMAP}{& }
68 & Stop playback and quit\\ 66 & Stop playback and quit\\
69\end{btnmap} 67\end{btnmap}
68
69Mikmod is highly configurable, and has many setting that affect output quality. However,
70less powerful \dap{}s may lack the cpu resources that higher quality settings require, expecially
71on more complex modules. Settings are saved and re-loaded automatically.
72
73\subsubsection{Configuration}
74\begin {description}
75\item [Panning Separation]
76 Specifies how far to separate Left and Right channels. 128 is full separation, 0 is none, effectively resulting in mono sound.
77\item [Reverberation]
78 Specifies the amount of reberb (echo) to add to the mix. 0 is disabled.
79\item [Interpolation]
80 Enabling this improves the sound of lower-quality instruments. Recommended.
81\item [Swap Channels]
82 Swaps the left and right channels.
83\item [Surround]
84 Enables a faux-surround effect.
85\item [HQ Mixer]
86 Enables a high quality audio mixer that is very CPU intensive. Must restart the plugin to take effect.
87\item [Sample Rate]
88 Select the sample/mixing rate for playback. 44.1KHz or higher is recommended, but you can select from any rate the \dap{} natively supports.
89\end {description}
diff --git a/manual/rockbox_interface/main.tex b/manual/rockbox_interface/main.tex
index 9d8e5aacc9..c1075ef7cd 100644
--- a/manual/rockbox_interface/main.tex
+++ b/manual/rockbox_interface/main.tex
@@ -712,7 +712,7 @@ To turn on and off your Rockbox enabled \dap{} use the following keys:
712 { 712 {
713 Rockbox has a dual-boot feature. To boot into the original firmware, 713 Rockbox has a dual-boot feature. To boot into the original firmware,
714 when the \dap{} is turned off, set the \ButtonLock{} switch to locked, 714 when the \dap{} is turned off, set the \ButtonLock{} switch to locked,
715 and then press the \ButtonOn{} button. 715 and then press the \ButtonPower button.
716 } 716 }
717 717
718 } 718 }