Consolidate code duplication in WPS volume changing handling.
[kugel-rb.git] / manual / plugins / zxbox.tex
blob94422df5e155ed53a09266ad13a5fe571d5fb604
1 \subsection{\label{ref:ZXBox}ZXBox}
2 \screenshot{plugins/images/ss-zxbox}{ZXBox}{img:zxbox}
3 ZXBox is a port of the ``Spectemu'' ZX Spectrum 48k emulator for Rockbox
4 (\Pointinghand\href{http://kempelen.iit.bme.hu/~mszeredi/spectemu/spectemu.html}
5 {project's homepage}). To start a game open a tape file or snapshot saved as
6 \fname{.tap}, \fname{.tzx}, \fname{.z80} or \fname{.sna} in the file browser.\\
7 \note{As ZXBox is a 48k emulator only loading of 48k z80 snapshots is possible.}
9 \subsubsection{Default keys}
10 The emulator is set up for 5 different buttons: Up, Down, Left, Right and
11 Jump/Fire. Each one of these can be mapped to one key of the Spectrum Keyboard
12 or they can be used like a ``Kempston'' joystick. Per default the buttons,
13 including an additional but fixed menu button, are assigned as follows:
15 \begin{table}
16 \begin{btnmap}{}{}
17 \opt{IPOD_3G_PAD,IPOD_4G_PAD}{\ButtonMenu/\ButtonPlay/}
18 \opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,GIGABEAT_PAD,GIGABEAT_S_PAD%
19 ,IAUDIO_X5_PAD,SANSA_C200_PAD,SANSA_E200_PAD,SANSA_FUZE_PAD,MROBE100_PAD}{\ButtonUp/\ButtonDown/}
20 \opt{IRIVER_H10_PAD}{\ButtonScrollUp/\ButtonScrollDown/}
21 \ButtonLeft/\ButtonRight
22 \opt{HAVEREMOTEKEYMAP}{& }
23 & Directional movement\\
25 \opt{IPOD_3G_PAD,IPOD_4G_PAD,GIGABEAT_PAD,GIGABEAT_S_PAD,IAUDIO_X5_PAD%
26 ,SANSA_C200_PAD,SANSA_E200_PAD,SANSA_FUZE_PAD,MROBE100_PAD}{\ButtonSelect}
27 \opt{RECORDER_PAD}{\ButtonPlay}
28 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOn}
29 \opt{ONDIO_PAD}{\ButtonMenu}
30 \opt{IRIVER_H10_PAD}{\ButtonRew}
31 \opt{HAVEREMOTEKEYMAP}{& }
32 & Jump/Fire\\
34 \opt{RECORDER_PAD}{\ButtonFOne}
35 \opt{ONDIO_PAD}{\ButtonOff}
36 \opt{IPOD_3G_PAD,IPOD_4G_PAD}{\ButtonHold{} switch}
37 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonMode}
38 \opt{GIGABEAT_PAD,GIGABEAT_S_PAD}{\ButtonMenu}
39 \opt{SANSA_C200_PAD,SANSA_E200_PAD,MROBE100_PAD}{\ButtonPower}
40 \opt{SANSA_FUZE_PAD}{Long \ButtonHome}
41 \opt{IAUDIO_X5_PAD}{\ButtonPlay}
42 \opt{IRIVER_H10_PAD}{\ButtonFF}
43 \opt{HAVEREMOTEKEYMAP}{& }
44 & Open ZXBox menu\\
45 \end{btnmap}
46 \end{table}
48 \subsubsection{ZXBox menu}
49 \begin{description}
50 \item[ Vkeyboard.]
51 This is a virtual keyboard representing the Spectrum keyboard. Controls are
52 the same as in standard Rockbox, but you just press one key instead of
53 entering a phrase.
54 \item[Play/Pause Tape.] Toggles playing of the tape (if it is loaded).
55 \item[Save Quick Snapshot.] Saves snapshot into \fname{/.rockbox/zxboxq.z80}.
56 \item[Load Quick Snapshot.] Loads snapshot from \fname{/.rockbox/zxboxq.z80}.
57 \item[Save Snapshot.]
58 Saves a snapshot of the current state. You would enter the full path and
59 desired name - for example \fname{/games/zx/snapshots/chuckie.sna}. The
60 snapshot format will be chosen after the extension you specified, per
61 default \fname{.z80} will be taken in case you leave it open.
62 \item[Toggle Fast Mode.]
63 Toggles fastest possible emulation speed (no sound, maximum frameskip etc.).
64 This is Useful when loading tapes with some specific loaders.
65 \item[Options.]
66 \begin{description}
67 \item[Map Keys To Kempston.]
68 Controls whether the \daps{} buttons should simulate a ``Kempston''
69 joystick or some assigned keys of the Spectrum keyboard.
70 \item[Display Speed.]Toggle displaying the emulation speed (in percent).
71 \item[Invert Colors.]
72 Inverts the Spectum colour palette, sometimes helps visibility.
73 \item[Frameskip]
74 Sets the number of frames to skip before displaying one. With zero
75 frameskip ZXBox tries to display 50 frames per second.
76 \item[Sound.]Turns sound on or off.
77 \item[Volume.]Controls volume of sound output.
78 \item[Predefined Keymap]
79 Select one of the predefined keymaps. For example \setting{2w90z} means:
80 map ZXBox's \btnfnt{Up} to \setting{2}, \btnfnt{Down} to \setting{w},
81 \btnfnt{Left} to \setting{9}, \btnfnt{Right} to \setting{0} and
82 \btnfnt{Jump/Fire} to \setting{z}. This example keymap is used in the
83 ``Chuckie Egg'' game.
84 \item[Custom Keymap]
85 This menu allows you to map one of the Spectrum keys accessible through the
86 plugin's virtual keyboard to each one of the buttons.
87 \item[Quit.] Quits the emulator..
88 \end{description}
89 \end{description}
91 \nopt{ipodvideo}{% no scaling for here, still include it?
92 \subsubsection{Hacking graphics}
93 Due to ZXBox's simple (but fast) scaling to the screen by dropping lines and
94 columns some games can become unplayable. It is possible to hack graphics to
95 make them better visible with the help of an utility such as the ``Spectrum
96 Graphics Editor''. Useful tools can be found at the ``World of Spectrum'' site
97 (\url{http://www.worldofspectrum.org/utilities.html}).}