Fix makefile conditions
[maemo-rb.git] / manual / plugins / rockboy.tex
blob8e6c39a3866872420bbcdd0ab5a27bd24723102c
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,SANSA_CLIP_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 ,SANSA_CLIP_PAD}
24 {\ButtonLeft{} / \ButtonRight}
25 \opt{MPIO_HD300_PAD}{\ButtonRew / \ButtonFF / \ButtonScrollUp / \ButtonScrollDown}
26 \opt{COWON_D2_PAD}{\TouchTopMiddle{} / \TouchBottomMiddle{} / \TouchMidLeft{} / \TouchMidRight}
27 \opt{HAVEREMOTEKEYMAP}{& }
28 & Direction keys\\
30 \opt{RECORDER_PAD}{\ButtonFOne}
31 \opt{IRIVER_H100_PAD}{\ButtonOn}
32 \opt{IRIVER_H300_PAD}{\ButtonRec}
33 \opt{IPOD_4G_PAD}{Tap \btnfnt{Top-Right}}
34 \opt{IAUDIO_X5_PAD,IRIVER_H10_PAD}{\ButtonPlay}
35 \opt{SANSA_E200_PAD,SANSA_FUZE_PAD,SANSA_C200_PAD,SANSA_CLIP_PAD}{\ButtonSelect}
36 \opt{GIGABEAT_PAD,GIGABEAT_S_PAD}{\ButtonVolUp}
37 \opt{COWON_D2_PAD}{\ButtonPlus}
38 \opt{PBELL_VIBE500_PAD}{\ButtonPower}
39 \opt{MPIO_HD300_PAD}{\ButtonPlay}
40 \opt{HAVEREMOTEKEYMAP}{& }
41 & A button\\
43 \opt{RECORDER_PAD}{\ButtonFTwo}
44 \opt{IRIVER_H100_PAD}{\ButtonOff}
45 \opt{IRIVER_H300_PAD}{\ButtonMode}
46 \opt{IPOD_4G_PAD}{Tap \btnfnt{Top-Left}}
47 \opt{IAUDIO_X5_PAD,SANSA_E200_PAD,SANSA_C200_PAD,PBELL_VIBE500_PAD}{\ButtonRec}
48 \opt{SANSA_FUZE_PAD,SANSA_CLIP_PAD}{\ButtonHome}
49 \opt{IRIVER_H10_PAD}{\ButtonFF}
50 \opt{GIGABEAT_PAD,GIGABEAT_S_PAD}{\ButtonVolDown}
51 \opt{COWON_D2_PAD}{\ButtonMinus}
52 \opt{MPIO_HD300_PAD}{\ButtonRec}
53 \opt{HAVEREMOTEKEYMAP}{& }
54 & B button\\
56 \opt{RECORDER_PAD}{\ButtonFThree}
57 \opt{IRIVER_H100_PAD}{\ButtonRec}
58 \opt{IRIVER_H300_PAD}{\ButtonOn}
59 \opt{IPOD_4G_PAD}{Tap \btnfnt{Bottom-Right} /~Press \ButtonSelect}
60 \opt{IAUDIO_X5_PAD}{\ButtonSelect}
61 \opt{SANSA_E200_PAD,SANSA_FUZE_PAD}{\ButtonScrollBack}
62 \opt{SANSA_C200_PAD,SANSA_CLIP_PAD}{\ButtonVolDown}
63 \opt{IRIVER_H10_PAD}{\ButtonRew}
64 \opt{GIGABEAT_PAD}{\ButtonA}
65 \opt{GIGABEAT_S_PAD,PBELL_VIBE500_PAD}{\ButtonPlay}
66 \opt{COWON_D2_PAD}{\TouchTopRight}
67 \opt{MPIO_HD300_PAD}{Long \ButtonPlay}
68 \opt{HAVEREMOTEKEYMAP}{& }
69 & Start\\
71 \nopt{IAUDIO_X5_PAD,IRIVER_H10_PAD}{
72 \opt{RECORDER_PAD}{\ButtonPlay}
73 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonSelect}
74 \opt{IPOD_4G_PAD}{Tap \btnfnt{Bottom-Left}}
75 \opt{SANSA_E200_PAD,SANSA_FUZE_PAD}{\ButtonScrollFwd}
76 \opt{SANSA_C200_PAD,SANSA_CLIP_PAD}{\ButtonVolUp}
77 \opt{GIGABEAT_PAD,GIGABEAT_S_PAD}{\ButtonSelect}
78 \opt{COWON_D2_PAD}{\TouchCenter}
79 \opt{PBELL_VIBE500_PAD}{\ButtonUp}
80 \opt{MPIO_HD300_PAD}{\ButtonEnter}
81 \opt{HAVEREMOTEKEYMAP}{& }
82 & Select\\
85 \opt{RECORDER_PAD,IRIVER_H100_PAD,iaudiom5,MPIO_HD300_PAD}{
86 \opt{RECORDER_PAD}{\ButtonOn}
87 \opt{IRIVER_H100_PAD,IAUDIO_X5_PAD,MPIO_HD300_PAD}{\ButtonHold{} switch}
88 \opt{HAVEREMOTEKEYMAP}{& }
89 & Cycle display scaling modes\\
90 % defined for the Recorders and targets with 160x128x2 displays (H100, M5)
92 \opt{RECORDER_PAD,IRIVER_H300_PAD}{\ButtonOff}
93 \opt{IRIVER_H100_PAD}{\ButtonMode}
94 \opt{IPOD_4G_PAD}{\ButtonHold{} switch}
95 \opt{IAUDIO_X5_PAD,SANSA_E200_PAD,SANSA_FUZE_PAD,SANSA_C200_PAD%
96 ,IRIVER_H10_PAD,SANSA_CLIP_PAD}{\ButtonPower}
97 \opt{GIGABEAT_PAD,GIGABEAT_S_PAD,COWON_D2_PAD,PBELL_VIBE500_PAD%
98 ,MPIO_HD300_PAD}{\ButtonMenu}
99 \opt{HAVEREMOTEKEYMAP}{& }
100 & Open Rockboy menu\\
101 \end{btnmap}
103 \subsubsection{Rockboy menu}
104 \begin{description}
105 \item[Load Game\ldots] Loads a previously saved game.
106 \item[Save Game\ldots] Saves your current state.
107 \item[Options\ldots]
108 \begin{description}
109 \item[Max Frameskip.]
110 Change frameskip setting to improve speed.
111 \item[Sound.]
112 Toggle sound on or off.
113 \item[Stats.]
114 Toggle showing fps and current frameskip.
115 \item[Set Keys (BUGGY)]
116 Select this option to set a new keymapping.
117 \opt{lcd_color}{
118 \note{The direction keys are set for the normal screen orientation,
119 not the rotated orientation.}
120 \item[Screen Size.]
121 Choose whether the original aspect ratio should be kept when scaling
122 the picture to the screen%
123 % targets with bigger displays than the original gameboy
124 \opt{gigabeat,iriverh300,ipodcolor,ipodvideo,e200,e200v2}{
125 or whether it should be displayed unscaled%
127 \item[Screen Rotate.]
128 Rotate the displayed picture and direction keys by 90 degrees.
129 \item[Set Palette.]
130 Pick one of a few predefined colour palettes.
132 \end{description}
133 \item[Reset.] Resets the Emulator.
134 \item[Quit RockBoy.] Quits the Rockboy plugin.
135 \end{description}