rockbox/manual/plugins/rockboy.tex
Sebastian Leonhardt a507bb2837 YH8xx,YH9xx: Keymap improvement
The main "innovation" in this patch are two "virtual buttons"
for the record switch on YH92x targets. When the switch state
changes, a single BUTTON_REC_SW_ON or .._OFF button event will
be generated. Thus keymap code can react on switching, but
not on the actual state of the switch.

Wherever sensible, the following user scheme is applied:
- use PLAY as confirm button
- use REW button or Long REW to exit
- use REC (YH820) or FFWD (YH92X) as modifier key for button combos

Change-Id: Ic8d1db9cc6869daed8dda98990dfdf7f6fd5d5a1
2015-11-15 23:46:39 +01:00

142 lines
6.1 KiB
TeX

\subsection{\label{ref:Rockboy}Rockboy}
\screenshot{plugins/images/ss-rockboy}{Rockboy}{img:rockboy}
Rockboy is a Nintendo Game Boy and Game Boy Color emulator for Rockbox based on
the gnuboy emulator. To start a game, open a ROM file saved as \fname{.gb} or
\fname{.gbc} in the file browser.\\
\opt{ipod}{
Within Rockboy the wheel is used as a touchpad. It is split into 8 sections
that when tapped correspond to 8 buttons as detailed in the table below.
}
\subsubsection{Default keys}
\begin{btnmap}
\opt{RECORDER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD%
,SANSA_E200_PAD,SANSA_FUZE_PAD,SANSA_C200_PAD,GIGABEAT_PAD%
,GIGABEAT_S_PAD,SANSA_CLIP_PAD,SANSA_FUZEPLUS_PAD,SAMSUNG_YH92X_PAD%
,SAMSUNG_YH820_PAD}{\ButtonUp{} / \ButtonDown}
\opt{IPOD_4G_PAD}{Tap \ButtonPlay{} / \ButtonMenu}
\opt{IRIVER_H10_PAD}{\ButtonScrollUp{} / \ButtonScrollDown}
\opt{PBELL_VIBE500_PAD}{\ButtonOK{} / \ButtonCancel}
\opt{RECORDER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD%
,SANSA_E200_PAD,SANSA_FUZE_PAD,SANSA_C200_PAD,GIGABEAT_PAD%
,GIGABEAT_S_PAD,IPOD_4G_PAD,IRIVER_H10_PAD,PBELL_VIBE500_PAD%
,SANSA_CLIP_PAD,SANSA_FUZEPLUS_PAD,SAMSUNG_YH92X_PAD%
,SAMSUNG_YH820_PAD}
{\ButtonLeft{} / \ButtonRight}
\opt{MPIO_HD300_PAD}{\ButtonRew / \ButtonFF / \ButtonScrollUp / \ButtonScrollDown}
\opt{COWON_D2_PAD}{\TouchTopMiddle{} / \TouchBottomMiddle{} / \TouchMidLeft{} / \TouchMidRight}
\opt{HAVEREMOTEKEYMAP}{& }
& Direction keys\\
%
\opt{RECORDER_PAD}{\ButtonFOne}
\opt{IRIVER_H100_PAD}{\ButtonOn}
\opt{IRIVER_H300_PAD}{\ButtonRec}
\opt{IPOD_4G_PAD}{Tap \btnfnt{Top-Right}}
\opt{IAUDIO_X5_PAD,IRIVER_H10_PAD,MPIO_HD300_PAD,SAMSUNG_YH92X_PAD,SAMSUNG_YH820_PAD}{\ButtonPlay}
\opt{SANSA_E200_PAD,SANSA_FUZE_PAD,SANSA_C200_PAD,SANSA_CLIP_PAD}{\ButtonSelect}
\opt{GIGABEAT_PAD,GIGABEAT_S_PAD}{\ButtonVolUp}
\opt{COWON_D2_PAD}{\ButtonPlus}
\opt{PBELL_VIBE500_PAD}{\ButtonPower}
\opt{SANSA_FUZEPLUS_PAD}{\ButtonVolUp}
\opt{HAVEREMOTEKEYMAP}{& }
& A button\\
%
\opt{RECORDER_PAD}{\ButtonFTwo}
\opt{IRIVER_H100_PAD}{\ButtonOff}
\opt{IRIVER_H300_PAD}{\ButtonMode}
\opt{IPOD_4G_PAD}{Tap \btnfnt{Top-Left}}
\opt{IAUDIO_X5_PAD,SANSA_E200_PAD,SANSA_C200_PAD,PBELL_VIBE500_PAD}{\ButtonRec}
\opt{SANSA_FUZE_PAD,SANSA_CLIP_PAD}{\ButtonHome}
\opt{IRIVER_H10_PAD,SAMSUNG_YH92X_PAD,SAMSUNG_YH820_PAD}{\ButtonFF}
\opt{GIGABEAT_PAD,GIGABEAT_S_PAD}{\ButtonVolDown}
\opt{COWON_D2_PAD}{\ButtonMinus}
\opt{MPIO_HD300_PAD}{\ButtonRec}
\opt{SANSA_FUZEPLUS_PAD}{\ButtonVolDown}
\opt{HAVEREMOTEKEYMAP}{& }
& B button\\
%
\opt{RECORDER_PAD}{\ButtonFThree}
\opt{IRIVER_H100_PAD}{\ButtonRec}
\opt{IRIVER_H300_PAD}{\ButtonOn}
\opt{IPOD_4G_PAD}{Tap \btnfnt{Bottom-Right} /~Press \ButtonSelect}
\opt{IAUDIO_X5_PAD,SANSA_FUZEPLUS_PAD}{\ButtonSelect}
\opt{SANSA_E200_PAD,SANSA_FUZE_PAD}{\ButtonScrollBack}
\opt{SANSA_C200_PAD,SANSA_CLIP_PAD}{\ButtonVolDown}
\opt{IRIVER_H10_PAD}{\ButtonRew}
\opt{GIGABEAT_PAD}{\ButtonA}
\opt{GIGABEAT_S_PAD,PBELL_VIBE500_PAD}{\ButtonPlay}
\opt{COWON_D2_PAD}{\TouchTopRight}
\opt{MPIO_HD300_PAD}{Long \ButtonPlay}
\opt{SAMSUNG_YH92X_PAD,SAMSUNG_YH820_PAD}{\ButtonRew}
\opt{HAVEREMOTEKEYMAP}{& }
& Start\\
%
\nopt{IAUDIO_X5_PAD,IRIVER_H10_PAD,SAMSUNG_YH92X_PAD,SAMSUNG_YH820_PAD}{
\opt{RECORDER_PAD,SANSA_FUZEPLUS_PAD,SAMSUNG_YH92X_PAD,SAMSUNG_YH820_PAD}{\ButtonPlay}
\opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonSelect}
\opt{IPOD_4G_PAD}{Tap \btnfnt{Bottom-Left}}
\opt{SANSA_E200_PAD,SANSA_FUZE_PAD}{\ButtonScrollFwd}
\opt{SANSA_C200_PAD,SANSA_CLIP_PAD}{\ButtonVolUp}
\opt{GIGABEAT_PAD,GIGABEAT_S_PAD}{\ButtonSelect}
\opt{COWON_D2_PAD}{\TouchCenter}
\opt{PBELL_VIBE500_PAD}{\ButtonUp}
\opt{MPIO_HD300_PAD}{\ButtonEnter}
\opt{HAVEREMOTEKEYMAP}{& }
& Select\\
%
}
\opt{RECORDER_PAD,IRIVER_H100_PAD,iaudiom5,MPIO_HD300_PAD}{
\opt{RECORDER_PAD}{\ButtonOn}
\opt{IRIVER_H100_PAD,IAUDIO_X5_PAD,MPIO_HD300_PAD}{\ButtonHold{} switch}
\opt{HAVEREMOTEKEYMAP}{& }
& Cycle display scaling modes\\
% defined for the Recorders and targets with 160x128x2 displays (H100, M5)
}
\opt{RECORDER_PAD,IRIVER_H300_PAD}{\ButtonOff}
\opt{IRIVER_H100_PAD}{\ButtonMode}
\opt{IPOD_4G_PAD}{\ButtonHold{} switch}
\opt{IAUDIO_X5_PAD,SANSA_E200_PAD,SANSA_FUZE_PAD,SANSA_C200_PAD%
,IRIVER_H10_PAD,SANSA_CLIP_PAD}{\ButtonPower}
\opt{GIGABEAT_PAD,GIGABEAT_S_PAD,COWON_D2_PAD,PBELL_VIBE500_PAD%
,MPIO_HD300_PAD}{\ButtonMenu}
\opt{SANSA_FUZEPLUS_PAD}{\ButtonBack}
\opt{SAMSUNG_YH92X_PAD}{\ButtonRecOn}
\opt{SAMSUNG_YH820_PAD}{\ButtonRec}
\opt{HAVEREMOTEKEYMAP}{& }
& Open Rockboy menu\\
\end{btnmap}
\subsubsection{Rockboy menu}
\begin{description}
\item[Load Game\ldots] Loads a previously saved game.
\item[Save Game\ldots] Saves your current state.
\item[Options\ldots]
\begin{description}
\item[Max Frameskip.]
Change frameskip setting to improve speed.
\item[Sound.]
Toggle sound on or off.
\item[Stats.]
Toggle showing fps and current frameskip.
\item[Set Keys (BUGGY)]
Select this option to set a new keymapping.
\opt{lcd_color}{
\note{The direction keys are set for the normal screen orientation,
not the rotated orientation.}
\item[Screen Size.]
Choose whether the original aspect ratio should be kept when scaling
the picture to the screen%
% targets with bigger displays than the original gameboy
\opt{gigabeat,iriverh300,ipodcolor,ipodvideo,e200,e200v2}{
or whether it should be displayed unscaled%
}.
\item[Screen Rotate.]
Rotate the displayed picture and direction keys by 90 degrees.
\item[Set Palette.]
Pick one of a few predefined colour palettes.
}
\end{description}
\item[Reset.] Resets the Emulator.
\item[Quit RockBoy.] Quits the Rockboy plugin.
\end{description}