Mark const return value; correct the comment about valid menu items for the hotkey
[kugel-rb.git] / manual / plugins / rockboy.tex
blob5a0808ed82e5a1117d9535d0b2648c101ced8f09
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%
16 ,SANSA_E200_PAD,SANSA_FUZE_PAD,SANSA_C200_PAD,GIGABEAT_PAD%
17 ,GIGABEAT_S_PAD}{\ButtonUp{} / \ButtonDown}
18 \opt{IPOD_4G_PAD}{Tap \ButtonPlay{} / \ButtonMenu}
19 \opt{IRIVER_H10_PAD}{\ButtonScrollUp{} / \ButtonScrollDown}
20 \opt{RECORDER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD%
21 ,SANSA_E200_PAD,SANSA_FUZE_PAD,SANSA_C200_PAD,GIGABEAT_PAD%
22 ,GIGABEAT_S_PAD,IPOD_4G_PAD,IRIVER_H10_PAD}
23 {\ButtonLeft{} / \ButtonRight}
24 \opt{COWON_D2_PAD}{\TouchTopMiddle{} / \TouchBottomMiddle{} / \TouchMidLeft{} / \TouchMidRight}
25 \opt{HAVEREMOTEKEYMAP}{& }
26 & Direction keys\\
28 \opt{RECORDER_PAD}{\ButtonFOne}
29 \opt{IRIVER_H100_PAD}{\ButtonOn}
30 \opt{IRIVER_H300_PAD}{\ButtonRec}
31 \opt{IPOD_4G_PAD}{Tap \btnfnt{Top-Right}}
32 \opt{IAUDIO_X5_PAD,IRIVER_H10_PAD}{\ButtonPlay}
33 \opt{SANSA_E200_PAD,SANSA_FUZE_PAD,SANSA_C200_PAD}{\ButtonSelect}
34 \opt{GIGABEAT_PAD,GIGABEAT_S_PAD}{\ButtonVolUp}
35 \opt{COWON_D2_PAD}{\ButtonPlus}
36 \opt{HAVEREMOTEKEYMAP}{& }
37 & A button\\
39 \opt{RECORDER_PAD}{\ButtonFTwo}
40 \opt{IRIVER_H100_PAD}{\ButtonOff}
41 \opt{IRIVER_H300_PAD}{\ButtonMode}
42 \opt{IPOD_4G_PAD}{Tap \btnfnt{Top-Left}}
43 \opt{IAUDIO_X5_PAD,SANSA_E200_PAD,SANSA_C200_PAD}{\ButtonRec}
44 \opt{SANSA_FUZE_PAD}{\ButtonPower}
45 \opt{IRIVER_H10_PAD}{\ButtonFF}
46 \opt{GIGABEAT_PAD,GIGABEAT_S_PAD}{\ButtonVolDown}
47 \opt{COWON_D2_PAD}{\ButtonMinus}
48 \opt{HAVEREMOTEKEYMAP}{& }
49 & B button\\
51 \opt{RECORDER_PAD}{\ButtonFThree}
52 \opt{IRIVER_H100_PAD}{\ButtonRec}
53 \opt{IRIVER_H300_PAD}{\ButtonOn}
54 \opt{IPOD_4G_PAD}{Tap \btnfnt{Bottom-Right} /~Press \ButtonSelect}
55 \opt{IAUDIO_X5_PAD}{\ButtonSelect}
56 \opt{SANSA_E200_PAD,SANSA_FUZE_PAD}{\ButtonScrollBack}
57 \opt{SANSA_C200_PAD}{\ButtonVolDown}
58 \opt{IRIVER_H10_PAD}{\ButtonRew}
59 \opt{GIGABEAT_PAD}{\ButtonA}
60 \opt{GIGABEAT_S_PAD}{\ButtonPlay}
61 \opt{COWON_D2_PAD}{\TouchTopRight}
62 \opt{HAVEREMOTEKEYMAP}{& }
63 & Start\\
65 \nopt{IAUDIO_X5_PAD,IRIVER_H10_PAD}{
66 \opt{RECORDER_PAD}{\ButtonPlay}
67 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonSelect}
68 \opt{IPOD_4G_PAD}{Tap \btnfnt{Bottom-Left}}
69 \opt{SANSA_E200_PAD,SANSA_FUZE_PAD}{\ButtonScrollFwd}
70 \opt{SANSA_C200_PAD}{\ButtonVolUp}
71 \opt{GIGABEAT_PAD,GIGABEAT_S_PAD}{\ButtonSelect}
72 \opt{COWON_D2_PAD}{\TouchCenter}
73 \opt{HAVEREMOTEKEYMAP}{& }
74 & Select\\
77 \opt{RECORDER_PAD,IRIVER_H100_PAD,iaudiom5}{
78 \opt{RECORDER_PAD}{\ButtonOn}
79 \opt{IRIVER_H100_PAD,IAUDIO_X5_PAD}{\ButtonHold{} switch}
80 \opt{HAVEREMOTEKEYMAP}{& }
81 & Cycle display scaling modes\\
84 \opt{RECORDER_PAD,IRIVER_H300_PAD}{\ButtonOff}
85 \opt{IRIVER_H100_PAD}{\ButtonMode}
86 \opt{IPOD_4G_PAD}{\ButtonHold{} switch}
87 \opt{IAUDIO_X5_PAD,SANSA_E200_PAD,SANSA_FUZE_PAD,SANSA_C200_PAD,IRIVER_H10_PAD}{\ButtonPower}
88 \opt{GIGABEAT_PAD,GIGABEAT_S_PAD,COWON_D2_PAD}{\ButtonMenu}
89 \opt{HAVEREMOTEKEYMAP}{& }
90 & Open Rockboy menu\\
91 \end{btnmap}
92 \end{table}
94 \subsubsection{Rockboy menu}
95 \begin{description}
96 \item[Load Game\ldots] Loads a previously saved game.
97 \item[Save Game\ldots] Saves your current state.
98 \item[Options\ldots]
99 \begin{description}
100 \item[Max Frameskip.]
101 Change frameskip setting to improve speed.
102 \item[Sound.]
103 Toggle sound on or off.
104 \item[Stats.]
105 Toggle showing fps and current frameskip.
106 \item[Set Keys (BUGGY)]
107 Select this option to set a new keymapping.
108 \opt{lcd_color}{
109 \item[Screen Size.]
110 Chose whether the original aspect ratio should be kept when scaling
111 the picture to the screen%
112 % targets with bigger displays than the original gameboy
113 \opt{gigabeat,h300,ipodcolor,ipodvideo,e200,e200v2}{
114 or whether it should be displayed unscaled%
116 \item[Screen Rotate.]
117 Rotate the displayed picture by 90 degrees.
118 \item[Set Palette.]
119 Pick one of a few predefined colour palettes.
121 \end{description}
122 \item[Quit RockBoy.] Quits the Rockboy plugin.
123 \end{description}