Theme Editor: Removed some lingering debug code
[kugel-rb.git] / manual / plugins / rockboy.tex
blob4231198ec613d7e5858dca4a324b3ac595faa72d
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{btnmap}
14 \opt{RECORDER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD%
15 ,SANSA_E200_PAD,SANSA_FUZE_PAD,SANSA_C200_PAD,GIGABEAT_PAD%
16 ,GIGABEAT_S_PAD}{\ButtonUp{} / \ButtonDown}
17 \opt{IPOD_4G_PAD}{Tap \ButtonPlay{} / \ButtonMenu}
18 \opt{IRIVER_H10_PAD}{\ButtonScrollUp{} / \ButtonScrollDown}
19 \opt{PBELL_VIBE500_PAD}{\ButtonOK{} / \ButtonCancel}
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,PBELL_VIBE500_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{PBELL_VIBE500_PAD}{\ButtonPower}
37 \opt{HAVEREMOTEKEYMAP}{& }
38 & A button\\
40 \opt{RECORDER_PAD}{\ButtonFTwo}
41 \opt{IRIVER_H100_PAD}{\ButtonOff}
42 \opt{IRIVER_H300_PAD}{\ButtonMode}
43 \opt{IPOD_4G_PAD}{Tap \btnfnt{Top-Left}}
44 \opt{IAUDIO_X5_PAD,SANSA_E200_PAD,SANSA_C200_PAD,PBELL_VIBE500_PAD}{\ButtonRec}
45 \opt{SANSA_FUZE_PAD}{\ButtonPower}
46 \opt{IRIVER_H10_PAD}{\ButtonFF}
47 \opt{GIGABEAT_PAD,GIGABEAT_S_PAD}{\ButtonVolDown}
48 \opt{COWON_D2_PAD}{\ButtonMinus}
49 \opt{HAVEREMOTEKEYMAP}{& }
50 & B button\\
52 \opt{RECORDER_PAD}{\ButtonFThree}
53 \opt{IRIVER_H100_PAD}{\ButtonRec}
54 \opt{IRIVER_H300_PAD}{\ButtonOn}
55 \opt{IPOD_4G_PAD}{Tap \btnfnt{Bottom-Right} /~Press \ButtonSelect}
56 \opt{IAUDIO_X5_PAD}{\ButtonSelect}
57 \opt{SANSA_E200_PAD,SANSA_FUZE_PAD}{\ButtonScrollBack}
58 \opt{SANSA_C200_PAD}{\ButtonVolDown}
59 \opt{IRIVER_H10_PAD}{\ButtonRew}
60 \opt{GIGABEAT_PAD}{\ButtonA}
61 \opt{GIGABEAT_S_PAD,PBELL_VIBE500_PAD}{\ButtonPlay}
62 \opt{COWON_D2_PAD}{\TouchTopRight}
63 \opt{HAVEREMOTEKEYMAP}{& }
64 & Start\\
66 \nopt{IAUDIO_X5_PAD,IRIVER_H10_PAD}{
67 \opt{RECORDER_PAD}{\ButtonPlay}
68 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonSelect}
69 \opt{IPOD_4G_PAD}{Tap \btnfnt{Bottom-Left}}
70 \opt{SANSA_E200_PAD,SANSA_FUZE_PAD}{\ButtonScrollFwd}
71 \opt{SANSA_C200_PAD}{\ButtonVolUp}
72 \opt{GIGABEAT_PAD,GIGABEAT_S_PAD}{\ButtonSelect}
73 \opt{COWON_D2_PAD}{\TouchCenter}
74 \opt{PBELL_VIBE500_PAD}{\ButtonUp}
75 \opt{HAVEREMOTEKEYMAP}{& }
76 & Select\\
79 \opt{RECORDER_PAD,IRIVER_H100_PAD,iaudiom5}{
80 \opt{RECORDER_PAD}{\ButtonOn}
81 \opt{IRIVER_H100_PAD,IAUDIO_X5_PAD}{\ButtonHold{} switch}
82 \opt{HAVEREMOTEKEYMAP}{& }
83 & Cycle display scaling modes\\
86 \opt{RECORDER_PAD,IRIVER_H300_PAD}{\ButtonOff}
87 \opt{IRIVER_H100_PAD}{\ButtonMode}
88 \opt{IPOD_4G_PAD}{\ButtonHold{} switch}
89 \opt{IAUDIO_X5_PAD,SANSA_E200_PAD,SANSA_FUZE_PAD,SANSA_C200_PAD,IRIVER_H10_PAD}{\ButtonPower}
90 \opt{GIGABEAT_PAD,GIGABEAT_S_PAD,COWON_D2_PAD,PBELL_VIBE500_PAD}{\ButtonMenu}
91 \opt{HAVEREMOTEKEYMAP}{& }
92 & Open Rockboy menu\\
93 \end{btnmap}
95 \subsubsection{Rockboy menu}
96 \begin{description}
97 \item[Load Game\ldots] Loads a previously saved game.
98 \item[Save Game\ldots] Saves your current state.
99 \item[Options\ldots]
100 \begin{description}
101 \item[Max Frameskip.]
102 Change frameskip setting to improve speed.
103 \item[Sound.]
104 Toggle sound on or off.
105 \item[Stats.]
106 Toggle showing fps and current frameskip.
107 \item[Set Keys (BUGGY)]
108 Select this option to set a new keymapping.
109 \opt{lcd_color}{
110 \item[Screen Size.]
111 Chose whether the original aspect ratio should be kept when scaling
112 the picture to the screen%
113 % targets with bigger displays than the original gameboy
114 \opt{gigabeat,h300,ipodcolor,ipodvideo,e200,e200v2}{
115 or whether it should be displayed unscaled%
117 \item[Screen Rotate.]
118 Rotate the displayed picture by 90 degrees.
119 \item[Set Palette.]
120 Pick one of a few predefined colour palettes.
122 \end{description}
123 \item[Quit RockBoy.] Quits the Rockboy plugin.
124 \end{description}