summaryrefslogtreecommitdiffstats
path: root/manual
diff options
context:
space:
mode:
authorMarianne Arnold <pixelma@rockbox.org>2008-06-05 14:42:32 +0000
committerMarianne Arnold <pixelma@rockbox.org>2008-06-05 14:42:32 +0000
commit5105d8e4ad844ea95dfa023be8004ca42f7350aa (patch)
treed11729b028bc97a5fad8bdf99328bbd83459eafe /manual
parentf002b7d0552f7c4b5d8229fe07982748e9ade731 (diff)
downloadrockbox-5105d8e4ad844ea95dfa023be8004ca42f7350aa.tar.gz
rockbox-5105d8e4ad844ea95dfa023be8004ca42f7350aa.tar.bz2
rockbox-5105d8e4ad844ea95dfa023be8004ca42f7350aa.zip
Manual: add a 'ZXBox' chapter. This is mostly a conversion of the PluginZXBox wiki page to the target specific style of the manual, phrased a bit differently and also included a button table (of the default mapping) and screenshots for every display type.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@17691 a1c6a512-1295-4272-9138-f99709370657
Diffstat (limited to 'manual')
-rw-r--r--manual/plugins/images/ss-zxbox-112x64x1.pngbin0 -> 782 bytes
-rw-r--r--manual/plugins/images/ss-zxbox-128x128x16.pngbin0 -> 1320 bytes
-rw-r--r--manual/plugins/images/ss-zxbox-132x80x16.pngbin0 -> 1055 bytes
-rw-r--r--manual/plugins/images/ss-zxbox-138x110x2.pngbin0 -> 1282 bytes
-rw-r--r--manual/plugins/images/ss-zxbox-160x128x1.pngbin0 -> 1502 bytes
-rw-r--r--manual/plugins/images/ss-zxbox-160x128x16.pngbin0 -> 1549 bytes
-rw-r--r--manual/plugins/images/ss-zxbox-160x128x2.pngbin0 -> 1515 bytes
-rw-r--r--manual/plugins/images/ss-zxbox-176x132x16.pngbin0 -> 1713 bytes
-rw-r--r--manual/plugins/images/ss-zxbox-176x220x16.pngbin0 -> 2456 bytes
-rw-r--r--manual/plugins/images/ss-zxbox-220x176x16.pngbin0 -> 2512 bytes
-rw-r--r--manual/plugins/images/ss-zxbox-240x320x16.pngbin0 -> 3551 bytes
-rw-r--r--manual/plugins/images/ss-zxbox-320x240x16.pngbin0 -> 3557 bytes
-rw-r--r--manual/plugins/main.tex2
-rw-r--r--manual/plugins/zxbox.tex95
14 files changed, 97 insertions, 0 deletions
diff --git a/manual/plugins/images/ss-zxbox-112x64x1.png b/manual/plugins/images/ss-zxbox-112x64x1.png
new file mode 100644
index 0000000000..089bf28cdb
--- /dev/null
+++ b/manual/plugins/images/ss-zxbox-112x64x1.png
Binary files differ
diff --git a/manual/plugins/images/ss-zxbox-128x128x16.png b/manual/plugins/images/ss-zxbox-128x128x16.png
new file mode 100644
index 0000000000..9b37aea645
--- /dev/null
+++ b/manual/plugins/images/ss-zxbox-128x128x16.png
Binary files differ
diff --git a/manual/plugins/images/ss-zxbox-132x80x16.png b/manual/plugins/images/ss-zxbox-132x80x16.png
new file mode 100644
index 0000000000..d779645796
--- /dev/null
+++ b/manual/plugins/images/ss-zxbox-132x80x16.png
Binary files differ
diff --git a/manual/plugins/images/ss-zxbox-138x110x2.png b/manual/plugins/images/ss-zxbox-138x110x2.png
new file mode 100644
index 0000000000..c9de1ea3ce
--- /dev/null
+++ b/manual/plugins/images/ss-zxbox-138x110x2.png
Binary files differ
diff --git a/manual/plugins/images/ss-zxbox-160x128x1.png b/manual/plugins/images/ss-zxbox-160x128x1.png
new file mode 100644
index 0000000000..fa2b637ea0
--- /dev/null
+++ b/manual/plugins/images/ss-zxbox-160x128x1.png
Binary files differ
diff --git a/manual/plugins/images/ss-zxbox-160x128x16.png b/manual/plugins/images/ss-zxbox-160x128x16.png
new file mode 100644
index 0000000000..9ea77d25f1
--- /dev/null
+++ b/manual/plugins/images/ss-zxbox-160x128x16.png
Binary files differ
diff --git a/manual/plugins/images/ss-zxbox-160x128x2.png b/manual/plugins/images/ss-zxbox-160x128x2.png
new file mode 100644
index 0000000000..7da5081f93
--- /dev/null
+++ b/manual/plugins/images/ss-zxbox-160x128x2.png
Binary files differ
diff --git a/manual/plugins/images/ss-zxbox-176x132x16.png b/manual/plugins/images/ss-zxbox-176x132x16.png
new file mode 100644
index 0000000000..fb5e8e3f33
--- /dev/null
+++ b/manual/plugins/images/ss-zxbox-176x132x16.png
Binary files differ
diff --git a/manual/plugins/images/ss-zxbox-176x220x16.png b/manual/plugins/images/ss-zxbox-176x220x16.png
new file mode 100644
index 0000000000..3cf08ea882
--- /dev/null
+++ b/manual/plugins/images/ss-zxbox-176x220x16.png
Binary files differ
diff --git a/manual/plugins/images/ss-zxbox-220x176x16.png b/manual/plugins/images/ss-zxbox-220x176x16.png
new file mode 100644
index 0000000000..1a5b248e0e
--- /dev/null
+++ b/manual/plugins/images/ss-zxbox-220x176x16.png
Binary files differ
diff --git a/manual/plugins/images/ss-zxbox-240x320x16.png b/manual/plugins/images/ss-zxbox-240x320x16.png
new file mode 100644
index 0000000000..85e68bde67
--- /dev/null
+++ b/manual/plugins/images/ss-zxbox-240x320x16.png
Binary files differ
diff --git a/manual/plugins/images/ss-zxbox-320x240x16.png b/manual/plugins/images/ss-zxbox-320x240x16.png
new file mode 100644
index 0000000000..e88e7dc18a
--- /dev/null
+++ b/manual/plugins/images/ss-zxbox-320x240x16.png
Binary files differ
diff --git a/manual/plugins/main.tex b/manual/plugins/main.tex
index b478d9733b..456d9d9153 100644
--- a/manual/plugins/main.tex
+++ b/manual/plugins/main.tex
@@ -129,6 +129,8 @@ the associated file. Viewers are stored in the
\opt{recorder,recorderv2fm,ondio}{\input{plugins/wavplay.tex}}
+\opt{lcd_bitmap}{\input{plugins/zxbox.tex}}
+
\section{Applications}
\opt{player,recorder,recorderv2fm}{\input{plugins/alpinecdc.tex}}
diff --git a/manual/plugins/zxbox.tex b/manual/plugins/zxbox.tex
new file mode 100644
index 0000000000..3913f23af3
--- /dev/null
+++ b/manual/plugins/zxbox.tex
@@ -0,0 +1,95 @@
+\subsection{\label{ref:ZXBox}ZXBox}
+\screenshot{plugins/images/ss-zxbox}{ZXBox}{img:zxbox}
+ZXBox is a port of the ``Spectemu'' ZX Spectrum 48k emulator for Rockbox
+(\Pointinghand\href{http://kempelen.iit.bme.hu/~mszeredi/spectemu/spectemu.html}
+{project's homepage}). To start a game open a tape file or snapshot saved as
+\fname{.tap}, \fname{.tzx}, \fname{.z80} or \fname{.sna} in the file browser.\\
+\note{As ZXBox is a 48k emulator only loading of 48k z80 snapshots is possible.}
+
+\subsubsection{Default keys}
+The emulator is set up for 5 different buttons: Up, Down, Left, Right and
+Jump/Fire. Each one of these can be mapped to one key of the Spectrum Keyboard
+or they can be used like a ``Kempston'' joystick. Per default the buttons,
+including an additional but fixed menu button, are assigned as follows:
+
+\begin{table}
+ \begin{btnmap}{}{}
+ \opt{IPOD_3G_PAD,IPOD_4G_PAD}{\ButtonMenu/\ButtonPlay/}
+ \opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,GIGABEAT_PAD,GIGABEAT_S_PAD%
+ ,IAUDIO_X5_PAD,SANSA_C200_PAD,SANSA_E200_PAD,MROBE100_PAD}{\ButtonUp/\ButtonDown/}
+ \opt{IRIVER_H10_PAD}{\ButtonScrollUp/\ButtonScrollDown/}
+ \ButtonLeft/\ButtonRight
+ & Directional movement\\
+ %
+ \opt{IPOD_3G_PAD,IPOD_4G_PAD,GIGABEAT_PAD,GIGABEAT_S_PAD,IAUDIO_X5_PAD%
+ ,SANSA_C200_PAD,SANSA_E200_PAD,MROBE100_PAD}{\ButtonSelect}
+ \opt{RECORDER_PAD}{\ButtonPlay}
+ \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOn}
+ \opt{ONDIO_PAD}{\ButtonMenu}
+ \opt{IRIVER_H10_PAD}{\ButtonRew}
+ & Jump/Fire\\
+ %
+ \opt{RECORDER_PAD}{\ButtonFOne}
+ \opt{ONDIO_PAD}{\ButtonOff}
+ \opt{IPOD_3G_PAD,IPOD_4G_PAD}{\ButtonHold{} switch}
+ \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonMode}
+ \opt{GIGABEAT_PAD,GIGABEAT_S_PAD}{\ButtonMenu}
+ \opt{SANSA_C200_PAD,SANSA_E200_PAD,MROBE100_PAD}{\ButtonPower}
+ \opt{IAUDIO_X5_PAD}{\ButtonPlay}
+ \opt{IRIVER_H10_PAD}{\ButtonFF}
+ & Open ZXBox menu\\
+ \end{btnmap}
+\end{table}
+
+\subsubsection{ZXBox menu}
+\begin{description}
+\item[ Vkeyboard.]
+ This is a virtual keyboard representing the Spectrum keyboard. Controls are
+ the same as in standard Rockbox, but you just press one key instead of
+ entering a phrase.
+\item[Play/Pause Tape.] Toggles playing of the tape (if it is loaded).
+\item[Save Quick Snapshot.] Saves snapshot into \fname{/.rockbox/zxboxq.z80}.
+\item[Load Quick Snapshot.] Loads snapshot from \fname{/.rockbox/zxboxq.z80}.
+\item[Save Snapshot.]
+ Saves a snapshot of the current state. You would enter the full path and
+ desired name - for example \fname{/games/zx/snapshots/chuckie.sna}. The
+ snapshot format will be chosen after the extension you specified, per
+ default \fname{.z80} will be taken in case you leave it open.
+\item[Toggle Fast Mode.]
+ Toggles fastest possible emulation speed (no sound, maximum frameskip etc.).
+ This is Useful when loading tapes with some specific loaders.
+\item[Options.]
+ \begin{description}
+ \item[Map Keys To Kempston.]
+ Controls whether the \daps{} buttons should simulate a ``Kempston''
+ joystick or some assigned keys of the Spectrum keyboard.
+ \item[Display Speed.]Toggle displaying the emulation speed (in percent).
+ \item[Invert Colors.]
+ Inverts the Spectum colour palette, sometimes helps visibility.
+ \item[Frameskip]
+ Sets the number of frames to skip before displaying one. With zero
+ frameskip ZXBox tries to display 50 frames per second.
+ \item[Sound.]Turns sound on or off.
+ \item[Volume.]Controls volume of sound output.
+ \item[Predefined Keymap]
+ Select one of the predefined keymaps. For example \setting{2w90z} means:
+ map ZXBox's \btnfnt{Up} to \setting{2}, \btnfnt{Down} to \setting{w},
+ \btnfnt{Left} to \setting{9}, \btnfnt{Right} to \setting{0} and
+ \btnfnt{Jump/Fire} to \setting{z}. This example keymap is used in the
+ ``Chuckie Egg'' game.
+ \item[Custom Keymap]
+ This menu allows you to map one of the Spectrum keys accessible through the
+ plugin's virtual keyboard to each one of the buttons.
+ \end{description}
+\item[Quit.] Quits the emulator..
+\end{description}
+
+\nopt{ipodvideo}{% no scaling for here, still include it?
+\subsubsection{Hacking graphics}
+Due to ZXBox's simple (but fast) scaling to the screen by dropping lines and
+columns some games can become unplayable. It is possible to hack graphics to
+make them better visible with the help of an utility such as the ``Spectrum
+Graphics Editor''. Useful tools can be found at the ``World of Spectrum'' site
+(\url{http://www.worldofspectrum.org/utilities.html}).}
+
+See also the plugin's wiki page \wikilink{PluginZXBox}.