summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSolomon Peachy <pizza@shaftnet.org>2020-08-24 18:35:25 -0400
committerSolomon Peachy <pizza@shaftnet.org>2020-08-24 18:49:03 -0400
commite06d7e8516fcd8630120f9a9f34955f4d188354f (patch)
treed5f710d9c33f1460498eb268b8395bb7d561fa97
parent910e600ba20fcc6b8493ca50da05d02d68990ba8 (diff)
downloadrockbox-e06d7e8516fcd8630120f9a9f34955f4d188354f.tar.gz
rockbox-e06d7e8516fcd8630120f9a9f34955f4d188354f.zip
manual: Add section for mikmod and document its formats
Change-Id: Ic07bf2c8dcc29bd535ea7b2ce8a7c4d723c22e6a
-rw-r--r--manual/plugins/main.tex8
-rw-r--r--manual/plugins/mikmod.tex69
2 files changed, 76 insertions, 1 deletions
diff --git a/manual/plugins/main.tex b/manual/plugins/main.tex
index 33bdb13b05..6e1084d5c4 100644
--- a/manual/plugins/main.tex
+++ b/manual/plugins/main.tex
@@ -45,7 +45,7 @@ text files%
{\input{plugins/dice.tex}}
-\opt{swcodec}{\nopt{lowmem}{\input{plugins/doom.tex}}}
+\nopt{xduoox3}{\nopt{lowmem}{\input{plugins/doom.tex}}}
\opt{lcd_color}{\nopt{lowmem,iaudiox5,iriverh300}{\input{plugins/duke3d.tex}}}
@@ -170,6 +170,11 @@ option from the \setting{Context Menu} (see \reference{ref:Contextmenu}).}
Lua scripting language& \fname{.lua} & \\
\opt{swcodec}{\nopt{lowmem}{
Midiplay & \fname{.mid, .midi} & \\
+ Mikmod & \fname{.669, .amf, .asy, .dsm,} & \\
+ & \fname{.far, .gdm, imf, .it,} & \\
+ & \fname{.m15, .med, .mod, .okt,} & \\
+ & \fname{.s3m, .stm, .stx, .ult,} & \\
+ & \fname{.uni, .umx, .xm} & \\
MPEG Player & \fname{.mpg, .mpeg, .mpv, .m2v} & \\
}}
\opt{swcodec}{
@@ -200,6 +205,7 @@ option from the \setting{Context Menu} (see \reference{ref:Contextmenu}).}
\opt{large_plugin_buffer}{\input{plugins/lua.tex}}
\opt{swcodec}{\nopt{lowmem}{\input{plugins/midiplay.tex}}}
+\opt{swcodec}{\nopt{lowmem}{\input{plugins/mikmod.tex}}}
\opt{lcd_bitmap}{\opt{swcodec}{\nopt{lowmem}{\input{plugins/mpegplayer.tex}}}}
diff --git a/manual/plugins/mikmod.tex b/manual/plugins/mikmod.tex
new file mode 100644
index 0000000000..00040c28ee
--- /dev/null
+++ b/manual/plugins/mikmod.tex
@@ -0,0 +1,69 @@
+\subsection{Mikmod}
+
+Mikmod plays most common tracker music formats.
+
+\note{TODO: Document configuration settings}
+
+\begin{btnmap}
+ \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,GIGABEAT_PAD,GIGABEAT_S_PAD%
+ ,IAUDIO_X5_PAD,MROBE100_PAD,PBELL_VIBE500_PAD,SANSA_FUZEPLUS_PAD,SAMSUNG_YH92X_PAD%
+ ,SAMSUNG_YH820_PAD}{\ButtonUp/ \ButtonDown}
+ \opt{IPOD_3G_PAD,IPOD_4G_PAD,SANSA_E200_PAD,SANSA_FUZE_PAD}{\ButtonScrollFwd/ \ButtonScrollBack}
+ \opt{IRIVER_H10_PAD,MPIO_HD300_PAD}{\ButtonScrollUp/ \ButtonScrollDown}
+ \opt{SANSA_C200_PAD,SANSA_CLIP_PAD,MPIO_HD200_PAD}{\ButtonVolUp/ \ButtonVolDown}
+ \opt{COWON_D2_PAD}{\TouchTopMiddle{} / \TouchBottomMiddle}
+ \opt{XDUOO_X3_PAD}{\ButtonVolUp/ \ButtonVolDown}
+ \opt{HAVEREMOTEKEYMAP}{& }
+ & Volume up/ Volume down\\
+ %
+ \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,GIGABEAT_PAD,GIGABEAT_S_PAD%
+ ,IAUDIO_X5_PAD,MROBE100_PAD,IPOD_3G_PAD,IPOD_4G_PAD,SANSA_E200_PAD%
+ ,SANSA_FUZE_PAD,IRIVER_H10_PAD,SANSA_C200_PAD,SANSA_CLIP_PAD,PBELL_VIBE500_PAD%
+ ,SANSA_FUZEPLUS_PAD,SAMSUNG_YH92X_PAD,SAMSUNG_YH820_PAD}
+ {\ButtonRight/ \ButtonLeft}
+ \opt{MPIO_HD200_PAD,MPIO_HD300_PAD}{\ButtonFF / \ButtonRew}
+ \opt{COWON_D2_PAD}{\TouchMidRight{} / \TouchMidLeft}
+ \opt{XDUOO_X3_PAD}{\ButtonNext/ \ButtonPrev}
+ \opt{HAVEREMOTEKEYMAP}{& }
+ & Skip to next/prev file\\
+ %
+ \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,GIGABEAT_PAD,GIGABEAT_S_PAD%
+ ,IAUDIO_X5_PAD,MROBE100_PAD,IPOD_3G_PAD,IPOD_4G_PAD,SANSA_E200_PAD%
+ ,SANSA_FUZE_PAD,IRIVER_H10_PAD,SANSA_C200_PAD,SANSA_CLIP_PAD,PBELL_VIBE500_PAD%
+ ,SANSA_FUZEPLUS_PAD,SAMSUNG_YH92X_PAD,SAMSUNG_YH820_PAD}
+ {Long \ButtonRight/ Long \ButtonLeft}
+ \opt{MPIO_HD200_PAD,MPIO_HD300_PAD}{Long \ButtonFF / Long \ButtonRew}
+ \opt{COWON_D2_PAD}{Long \TouchMidRight{} / Long \TouchMidLeft}
+ \opt{XDUOO_X3_PAD}{Long \ButtonNext/ Long \ButtonPrev}
+ \opt{HAVEREMOTEKEYMAP}{& }
+ & Skip to next/prev sequence\\
+ %
+ \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOn}
+ \opt{IPOD_3G_PAD,IPOD_4G_PAD,GIGABEAT_S_PAD,IAUDIO_X5_PAD,IRIVER_H10_PAD,PBELL_VIBE500_PAD%
+ ,MPIO_HD200_PAD,MPIO_HD300_PAD,SANSA_FUZEPLUS_PAD,SAMSUNG_YH92X_PAD,SAMSUNG_YH820_PAD}
+ {\ButtonPlay}
+ \opt{SANSA_E200_PAD,SANSA_FUZE_PAD,SANSA_C200_PAD,SANSA_CLIP_PAD}{\ButtonUp}
+ \opt{GIGABEAT_PAD}{\ButtonA}
+ \opt{MROBE100_PAD}{\ButtonDisplay}
+ \opt{COWON_D2_PAD}{\TouchCenter}
+ \opt{XDUOO_X3_PAD}{\ButtonPlay}
+ \opt{HAVEREMOTEKEYMAP}{& }
+ & Pause/Resume playback\\
+ %
+ \opt{XDUOO_X3_PAD}{\ButtonOption}
+ \opt{HAVEREMOTEKEYMAP}{& }
+ & Enter configuration menu\\
+ %
+ \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOff}
+ \opt{IPOD_3G_PAD,IPOD_4G_PAD}{\ButtonSelect+\ButtonMenu}
+ \opt{GIGABEAT_PAD,GIGABEAT_S_PAD,SANSA_E200_PAD,SANSA_C200_PAD,SANSA_CLIP_PAD,IAUDIO_X5_PAD%
+ ,IRIVER_H10_PAD,MROBE100_PAD,COWON_D2_PAD,SANSA_FUZEPLUS_PAD}{\ButtonPower}
+ \opt{SANSA_FUZE_PAD}{Long \ButtonHome}
+ \opt{PBELL_VIBE500_PAD}{\ButtonRec}
+ \opt{SAMSUNG_YH92X_PAD,SAMSUNG_YH820_PAD}{Long \ButtonPlay}
+ \opt{MPIO_HD200_PAD}{\ButtonRec + \ButtonPlay}
+ \opt{MPIO_HD300_PAD}{Long \ButtonMenu}
+ \opt{XDUOO_X3_PAD}{\ButtonPower}
+ \opt{HAVEREMOTEKEYMAP}{& }
+ & Stop playback and quit\\
+\end{btnmap}