summaryrefslogtreecommitdiffstats
path: root/manual
diff options
context:
space:
mode:
Diffstat (limited to 'manual')
-rw-r--r--manual/plugins/images/ss-pacbox-320x240x16.pngbin0 -> 3928 bytes
-rw-r--r--manual/plugins/main.tex42
-rw-r--r--manual/plugins/pacbox.tex25
-rw-r--r--manual/plugins/sudoku.tex40
-rw-r--r--manual/plugins/vumeter.tex32
5 files changed, 81 insertions, 58 deletions
diff --git a/manual/plugins/images/ss-pacbox-320x240x16.png b/manual/plugins/images/ss-pacbox-320x240x16.png
new file mode 100644
index 0000000000..00dc4f5cb2
--- /dev/null
+++ b/manual/plugins/images/ss-pacbox-320x240x16.png
Binary files differ
diff --git a/manual/plugins/main.tex b/manual/plugins/main.tex
index a63dd711c2..a852a8c5c9 100644
--- a/manual/plugins/main.tex
+++ b/manual/plugins/main.tex
@@ -17,38 +17,38 @@ loaded, run and then exited, which returns control to Rockbox. Music
will carry on playing whilst plugins are being run.
\section{Games}
-\opt{recorder,recorderv2fm,ondio,h1xx,h300,ipodcolor,ipodnano}
+\opt{HAVE_LCD_BITMAP}
{See also the Chip{}-8 emulator on page \pageref{ref:Chip8emulator}
- \opt{recorder,recorderv2fm,ondio,h1xx,h300,ipodcolor}{, Rockboy on page
- \pageref{ref:Rockboy} and Sudoku on page \pageref{ref:Sudoku}}.}
+ \opt{recorder,recorderv2fm,ondio,h1xx,h300,ipodcolor,ipodvideo}
+ {and Rockboy on page \pageref{ref:Rockboy}}.}
\opt{HAVE_LCD_BITMAP}{\input{plugins/brickmania.tex}}
\opt{HAVE_LCD_BITMAP}{\input{plugins/bubbles.tex}}
-\opt{recorder,recorderv2fm,ondio,h1xx,h300,IPOD_4G_PAD}{\input{plugins/chessbox.tex}}
+\opt{HAVE_LCD_BITMAP}{\input{plugins/chessbox.tex}}
\opt{h1xx,h300,ipodcolor,ipodnano,ipodvideo}{\input{plugins/doom.tex}}
-\opt{recorder,recorderv2fm,ondio,h1xx,h300,IPOD_4G_PAD}{\input{plugins/flipit.tex}}
+\opt{HAVE_LCD_BITMAP}{\input{plugins/flipit.tex}}
\opt{player}{\input{plugins/jackpot.tex}}
-\opt{recorder,recorderv2fm,ondio,h1xx,h300,IPOD_4G_PAD}{\input{plugins/jewels.tex}}
+\opt{HAVE_LCD_BITMAP}{\input{plugins/jewels.tex}}
-\opt{recorder,recorderv2fm,ondio,h1xx,h300,IPOD_4G_PAD,x5}{\input{plugins/minesweeper.tex}}
+\opt{HAVE_LCD_BITMAP}{\input{plugins/minesweeper.tex}}
\opt{player}{\input{plugins/nim.tex}}
-\opt{h1xx,h300,ipodcolor,ipodnano}{\input{plugins/pacbox.tex}}
+\opt{h1xx,HAVE_LCD_COLOR}{\input{plugins/pacbox.tex}}
\opt{HAVE_LCD_BITMAP}{\input{plugins/pong.tex}}
- \opt{recorder,recorderv2fm,ondio,h1xx,h300,IPOD_4G_PAD}{\input{plugins/rockblox.tex}}
+\opt{HAVE_LCD_BITMAP}{\input{plugins/rockblox.tex}}
-\opt{recorder,recorderv2fm,ondio,h1xx,h300,IPOD_4G_PAD}{\input{plugins/sliding.tex}}
+\opt{HAVE_LCD_BITMAP}{\input{plugins/sliding.tex}}
-\opt{recorder,recorderv2fm,ondio,h1xx,h300,IPOD_4G_PAD}{\input{plugins/snake.tex}}
+\opt{HAVE_LCD_BITMAP}{\input{plugins/snake.tex}}
\opt{HAVE_LCD_BITMAP}{\input{plugins/snake2.tex}}
@@ -60,15 +60,17 @@ will carry on playing whilst plugins are being run.
\opt{HAVE_LCD_BITMAP}{\input{plugins/star.tex}}
+\opt{recorder,recorderv2fm,ondio,h1xx,h300,ipod4g,ipodcolor,ipodnano,ipodvideo,x5}{\input{plugins/sudoku.tex}}
+
\opt{HAVE_LCD_BITMAP}{\input{plugins/tetrox.tex}}
\opt{recorder,recorderv2fm,ondio,h1xx,h300,IPOD_4G_PAD}{\input{plugins/wormlet.tex}}
-\opt{h1xx,h300,IPOD_4G_PAD}{\input{plugins/xobox.tex}}
+\opt{SWCODEC}{\input{plugins/xobox.tex}}
\section{Demos}
-\opt{recorder,recorderv2fm,ondio,h1xx,h300,IPOD_4G_PAD}{\input{plugins/bounce.tex}}
+\opt{HAVE_LCD_BITMAP}{\input{plugins/bounce.tex}}
{\input{plugins/credits.tex}}
@@ -80,19 +82,19 @@ will carry on playing whilst plugins are being run.
{\input{plugins/logo.tex}}
-\opt{recorder,recorderv2fm,ondio,h1xx,h300,ipod4g,ipodcolor,ipodnano,ipodvideo}{\input{plugins/mandelbrot.tex}}
+\opt{recorder,recorderv2fm,ondio,h1xx,HAVE_LCD_COLOR}{\input{plugins/mandelbrot.tex}}
-\opt{player,recorder,recorderv2fm,ondio,h1xx,h300,IPOD_4G_PAD}{\input{plugins/mosaic.tex}}
+{\input{plugins/mosaic.tex}}
-\opt{recorder,recorderv2fm,ondio,h1xx,h300,IPOD_4G_PAD}{\input{plugins/oscilloscope.tex}}
+\opt{HAVE_LCD_BITMAP}{\input{plugins/oscilloscope.tex}}
\opt{HAVE_LCD_BITMAP}{\input{plugins/plasma.tex}}
-\opt{player,recorder,recorderv2fm,ondio,h1xx,h300,IPOD_4G_PAD}{\input{plugins/snow.tex}}
+{\input{plugins/snow.tex}}
\opt{HAVE_LCD_BITMAP}{\input{plugins/starfield.tex}}
-\opt{recorder,recorderv2fm,ondio,h1xx,h300,IPOD_4G_PAD}{\input{plugins/vumeter.tex}}
+\opt{HAVE_LCD_BITMAP}{\input{plugins/vumeter.tex}}
\section{\label{ref:Viewersplugins}Viewers}
@@ -103,7 +105,7 @@ the associated file. Viewers are stored in the
\opt{HAVE_LCD_BITMAP}{\input{plugins/chip8emulator.tex}}
-\opt{recorder,recorderv2fm,ondio,h1xx,h300,ipodcolor,ipodnano,ipodvideo}{\input{plugins/jpegviewer.tex}}
+\opt{recorder,recorderv2fm,ondio,h1xx,HAVE_LCD_COLOR}{\input{plugins/jpegviewer.tex}}
\opt{recorder,recorderv2fm,ondio}{\input{plugins/movieplayer.tex}}
@@ -115,8 +117,6 @@ the associated file. Viewers are stored in the
{\input{plugins/sort.tex}}
-\opt{recorder,recorderv2fm,ondio,h1xx,h300,ipod4g,ipodcolor,ipodnano,ipodvideo}{\input{plugins/sudoku.tex}}
-
{\input{plugins/text_viewer.tex}}
{\input{plugins/vbrfix.tex}}
diff --git a/manual/plugins/pacbox.tex b/manual/plugins/pacbox.tex
index c13ca8253f..a9a445b591 100644
--- a/manual/plugins/pacbox.tex
+++ b/manual/plugins/pacbox.tex
@@ -29,23 +29,28 @@ found at \url{http://www.mame.net}.
\subsubsection{Keys}
\begin{table}
\begin{btnmap}{}{}
- \opt{h1xx,h300,x5,ipodcolor,ipodnano}{\ButtonRight}
+ \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD,IPOD_4G_PAD}{\ButtonRight}
& Move Up\\
- \opt{h1xx,h300,x5,ipodcolor,ipodnano}{\ButtonLeft}
+ \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD,IPOD_4G_PAD}{\ButtonLeft}
& Move Down\\
- \opt{h1xx,h300,x5}{\ButtonUp}\opt{ipodcolor,ipodnano}{\ButtonMenu}
+ \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD}{\ButtonUp}
+ \opt{IPOD_4G_PAD}{\ButtonMenu}
& Move Left\\
- \opt{h1xx,h300,x5}{\ButtonDown}\opt{ipodcolor,ipodnano}{\ButtonPlay}
+ \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD}{\ButtonDown}
+ \opt{IPOD_4G_PAD}{\ButtonPlay}
& Move Right\\
- \opt{h1xx,h300,x5}{\ButtonRec}\opt{ipodcolor,ipodnano}{\ButtonSelect}
+ \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD}{\ButtonRec}
+ \opt{IPOD_4G_PAD}{\ButtonSelect}
& Insert Coin\\
- \opt{h1xx,h300,x5,ipodcolor,ipodnano}{\ButtonSelect}
+ \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD,IPOD_4G_PAD}{\ButtonSelect}
& 1-Player Start\\
- \opt{h1xx,h300,x5}{\ButtonOn}\opt{ipodcolor,ipodnano}{n/a}
+ \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOn}
+ \opt{IPOD_4G_PAD}{n/a}
+ \opt{IAUDIO_X5_PAD}{\ButtonPower}
& 2-Player Start\\
- \opt{h1xx,h300}{\ButtonMode}
- \opt{x5}{\ButtonOn}
- \opt{ipodcolor,ipodnano}{\ButtonSelect+\ButtonMenu}
+ \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonMode}
+ \opt{IPOD_4G_PAD}{\ButtonSelect+\ButtonMenu}
+ \opt{IAUDIO_X5_PAD}{\ButtonPlay}
& Menu\\
\end{btnmap}
\end{table}
diff --git a/manual/plugins/sudoku.tex b/manual/plugins/sudoku.tex
index 42085dcc36..cb641dffe5 100644
--- a/manual/plugins/sudoku.tex
+++ b/manual/plugins/sudoku.tex
@@ -1,12 +1,21 @@
\subsection{\label{ref:Sudoku}Sudoku}
\screenshot{plugins/images/ss-sudoku}{Sudoku}{fig:sudoku}
-To play Sudoku you need sudoku games stored as .ss files (see links below).
-Once you have your .ss file just open it in the normal file browser to start playing.
+Sudoku in Rockbox is implemented as both a plugin and a viewer.
+When you start Sudoku in plugin mode from the \setting{Browse Plugins} menu, a random
+game will be generated automatically, and an estimate of its difficulty
+(very easy, easy, medium, hard or fiendish) will be displayed on the screen.
+New games can be generated from the \setting{Generate} menu option.
+
+When you use Sudoku as a viewer for playing pre-generated Sudoku games.
+You need sudoku games stored (one game per file) in text files with the
+\fname{.ss} extension (see links below). You then browse these games using the
+normal \setting{File Browser}, and open the file to launch Sudoku.
+
You can create and save your own grids under the \setting{New} menu option.
Press the menu button when you have finished and enter the full path
-to save to including the .ss extension (e.g. \fname{/sudoku/new.ss}).
+to save to including the \fname{.ss} extension (e.g. \fname{/sudoku/new.ss}).
-\textbf{The thing on the left (AKA the scratchpad)}\\
+\subsubsection{The thing on the left (AKA the scratchpad)}
When you play sudoku on paper most people like to mark numbers in
cells that are possible candidates for the cells.
This can be done with the column on the left. Change the number
@@ -17,39 +26,40 @@ These are \emph{NOT} saved when saving the game.
\begin{table}
\begin{btnmap}{}{}
-
- \opt{RECORDER_PAD,ONDIO_PAD,h1xx,h300,x5}{Direction keys}
- \opt{IPOD_4G_PAD}{\ButtonScrollFwd/\ButtonScrollBack}
+ \opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD}
+ {\ButtonUp, \ButtonDown, \ButtonLeft, \ButtonRight}
+ \opt{IPOD_4G_PAD}{\ButtonScrollFwd/\ButtonScrollBack}
& Move the cursor\\
%
\opt{RECORDER_PAD}{\ButtonPlay}
\opt{ONDIO_PAD}{\ButtonMenu}
- \opt{h1xx,h300}{\ButtonSelect/\ButtonOn}
- \opt{IPOD_4G_PAD}{\ButtonLeft/\ButtonRight}
+ \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonSelect/\ButtonOn}
+ \opt{IPOD_4G_PAD}{\ButtonLeft/\ButtonRight}
+ \opt{IAUDIO_X5_PAD}{\ButtonSelect}
& Change number under the cursor\\
%
\opt{RECORDER_PAD}{\ButtonFOne}
\opt{ONDIO_PAD}{Long press on \ButtonMenu}
- \opt{h1xx,h300}{\ButtonMode}
+ \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonMode}
\opt{IPOD_4G_PAD}{\ButtonMenu}
- \opt{x5}{\ButtonPlay}
+ \opt{IAUDIO_X5_PAD}{\ButtonPlay}
& Open Menu\\
%
\opt{RECORDER_PAD}{\ButtonFTwo}
\opt{ONDIO_PAD}{\ButtonMenu+\ButtonLeft}
- \opt{h1xx,h300,x5}{\ButtonRec}
+ \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD}{\ButtonRec}
\opt{IPOD_4G_PAD}{\ButtonPlay}
& Add/Remove number to scratchpad\\
%
- \opt{RECORDER_PAD,ONDIO_PAD,h1xx,h300}{\ButtonOff}
- \opt{x5}{\ButtonPower}
+ \opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOff}
+ \opt{IAUDIO_X5_PAD}{\ButtonPower}
\opt{IPOD_4G_PAD}{Menu $\rightarrow$ Quit}
& Quit\\
%
\end{btnmap}
\end{table}
-Some places where can you can find .ss files:
+Some places where can you can find \fname{.ss} files:
\begin{itemize}
\item Simple Sudoku (Advanced Puzzle Packs 1 and 2 located near the bottom of that page):
\url{http://www.angusj.com/sudoku/}
diff --git a/manual/plugins/vumeter.tex b/manual/plugins/vumeter.tex
index aedbb348d5..93299991fe 100644
--- a/manual/plugins/vumeter.tex
+++ b/manual/plugins/vumeter.tex
@@ -11,17 +11,25 @@ and the meter scale can be changed.
\begin{table}
\begin{btnmap}{}{}
-\opt{recorder,recorderv2fm}{OFF}\opt{ondio}{ON/OFF}
-\opt{h1xx,h300}{Stop}\opt{ipodcolor,ipodnano}{Unknown}
-& Save settings and quit \\
-\opt{recorder,recorderv2fm}{ON}\opt{ondio}{MODE}
-\opt{h1xx,h300}{Play}\opt{ipodcolor,ipodnano}{Unknown}
-& Help \\
-\opt{recorder,recorderv2fm}{F1}\opt{ondio}{HOLD MODE}
-\opt{h1xx,h300,ipodcolor,ipodnano}{Unknown}
-& Settings \\
-UP & Raise Volume \\
-DOWN & Lower Volume \\
+\opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOff}
+\opt{IPOD_4G_PAD}{\ButtonMenu}
+\opt{IAUDIO_X5_PAD}{\ButtonPower}
+ & Save settings and quit\\
+\opt{RECORDER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOn}
+\opt{ONDIO_PAD}{\ButtonMenu}
+\opt{IPOD_4G_PAD,IAUDIO_X5_PAD}{\ButtonPlay}
+ & Help\\
+\opt{RECORDER_PAD}{\ButtonFOne}
+\opt{ONDIO_PAD}{Hold \ButtonMenu}
+\opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IPOD_4G_PAD,IAUDIO_X5_PAD}{\ButtonSelect}
+ & Settings\\
+\opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD}
+{\ButtonUp}
+\opt{IPOD_4G_PAD}{\ButtonScrollFwd}
+ & Raise Volume\\
+\opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD}
+{\ButtonDown}
+\opt{IPOD_4G_PAD}{\ButtonScrollBack}
+ & Lower Volume\\
\end{btnmap}
\end{table}
-