Add plugin keys to the manual for the Gigabeat S, plus a couple of missing ones for...
[kugel-rb/myfork.git] / manual / plugins / rockboy.tex
blobc01bb5f6ee4e2856700a8cb0dd074ea973d5c778
1 \subsection{\label{ref:Rockboy}Rockboy}
2 \screenshot{plugins/images/ss-rockboy}{Rockboy}{img:rockboy}
3 Rockboy is a Nintendo Game Boy and Game Boy Color emulator for Rockbox based on
4 the gnuboy emulator. To start a game, open a ROM file saved as \fname{.gb} or
5 \fname{.gbc} in the file browser.\\
7 \opt{ipod}{
8 Within Rockboy the wheel is used as a touchpad. It is split into 8 sections
9 that when tapped correspond to 8 buttons as detailed in the table below.
12 \subsubsection{Default keys}
13 \begin{table}
14 \begin{btnmap}{}{}
15 \opt{RECORDER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD,SANSA_E200_PAD%
16 ,SANSA_C200_PAD,GIGABEAT_PAD,GIGABEAT_S_PAD}{\ButtonUp{} / \ButtonDown}
17 \opt{IPOD_4G_PAD}{Tap \ButtonPlay{} / \ButtonMenu}
18 \opt{IRIVER_H10_PAD}{\ButtonScrollUp{} / \ButtonScrollDown}
19 / \ButtonLeft{} / \ButtonRight
20 & Direction keys\\
22 \opt{RECORDER_PAD}{\ButtonFOne}
23 \opt{IRIVER_H100_PAD}{\ButtonOn}
24 \opt{IRIVER_H300_PAD}{\ButtonRec}
25 \opt{IPOD_4G_PAD}{Tap \btnfnt{Top-Right}}
26 \opt{IAUDIO_X5_PAD,IRIVER_H10_PAD}{\ButtonPlay}
27 \opt{SANSA_E200_PAD,SANSA_C200_PAD}{\ButtonSelect}
28 \opt{GIGABEAT_PAD,GIGABEAT_S_PAD}{\ButtonVolUp}
29 & A button\\
31 \opt{RECORDER_PAD}{\ButtonFTwo}
32 \opt{IRIVER_H100_PAD}{\ButtonOff}
33 \opt{IRIVER_H300_PAD}{\ButtonMode}
34 \opt{IPOD_4G_PAD}{Tap \btnfnt{Top-Left}}
35 \opt{IAUDIO_X5_PAD,SANSA_E200_PAD,SANSA_C200_PAD}{\ButtonRec}
36 \opt{IRIVER_H10_PAD}{\ButtonFF}
37 \opt{GIGABEAT_PAD,GIGABEAT_S_PAD}{\ButtonVolDown}
38 & B button\\
40 \opt{RECORDER_PAD}{\ButtonFThree}
41 \opt{IRIVER_H100_PAD}{\ButtonRec}
42 \opt{IRIVER_H300_PAD}{\ButtonOn}
43 \opt{IPOD_4G_PAD}{Tap \btnfnt{Bottom-Right} /~Press \ButtonSelect}
44 \opt{IAUDIO_X5_PAD}{\ButtonSelect}
45 \opt{SANSA_E200_PAD}{\ButtonScrollBack}
46 \opt{SANSA_C200_PAD}{\ButtonVolDown}
47 \opt{IRIVER_H10_PAD}{\ButtonRew}
48 \opt{GIGABEAT_PAD}{\ButtonA}
49 \opt{GIGABEAT_S_PAD}{\ButtonPlay}
50 & Start\\
52 \nopt{IAUDIO_X5_PAD,IRIVER_H10_PAD}{
53 \opt{RECORDER_PAD}{\ButtonPlay}
54 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonSelect}
55 \opt{IPOD_4G_PAD}{Tap \btnfnt{Bottom-Left}}
56 \opt{SANSA_E200_PAD}{\ButtonScrollFwd}
57 \opt{SANSA_C200_PAD}{\ButtonVolUp}
58 \opt{GIGABEAT_PAD,GIGABEAT_S_PAD}{\ButtonSelect}
59 & Select\\
62 \opt{RECORDER_PAD,IRIVER_H100_PAD,m5}{
63 \opt{RECORDER_PAD}{\ButtonOn}
64 \opt{IRIVER_H100_PAD,IAUDIO_X5_PAD}{\ButtonHold{} switch}
65 & Cycle display scaling modes\\
68 \opt{RECORDER_PAD,IRIVER_H300_PAD}{\ButtonOff}
69 \opt{IRIVER_H100_PAD}{\ButtonMode}
70 \opt{IPOD_4G_PAD}{\ButtonHold{} switch}
71 \opt{IAUDIO_X5_PAD,SANSA_E200_PAD,SANSA_C200_PAD,IRIVER_H10_PAD}{\ButtonPower}
72 \opt{GIGABEAT_PAD,GIGABEAT_S_PAD}{\ButtonMenu}
73 & Open Rockboy menu\\
74 \end{btnmap}
75 \end{table}
77 \subsubsection{Rockboy menu}
78 \begin{description}
79 \item[Load Game\ldots] Loads a previously saved game.
80 \item[Save Game\ldots] Saves your current state.
81 \item[Options\ldots]
82 \begin{description}
83 \item[Max Frameskip.]
84 Change frameskip setting to improve speed.
85 \item[Sound.]
86 Toggle sound on or off.
87 \item[Stats.]
88 Toggle showing fps and current frameskip.
89 \item[Set Keys (BUGGY)]
90 Select this option to set a new keymapping.
91 \opt{lcd_color}{
92 \item[Screen Size.]
93 Chose whether the original aspect ratio should be kept when scaling
94 the picture to the screen%
95 % targets with bigger displays than the original gameboy
96 \opt{gigabeat,h300,ipodcolor,ipodvideo,e200}{
97 or whether it should be displayed unscaled%
99 \item[Screen Rotate.]
100 Rotate the displayed picture by 90 degrees.
101 \item[Set Palette.]
102 Pick one of a few predefined colour palettes.
104 \end{description}
105 \item[Quit RockBoy.] Quits the Rockboy plugin.
106 \end{description}