summaryrefslogtreecommitdiff
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
17will carry on playing whilst plugins are being run. 17will carry on playing whilst plugins are being run.
18 18
19\section{Games} 19\section{Games}
20\opt{recorder,recorderv2fm,ondio,h1xx,h300,ipodcolor,ipodnano} 20\opt{HAVE_LCD_BITMAP}
21 {See also the Chip{}-8 emulator on page \pageref{ref:Chip8emulator} 21 {See also the Chip{}-8 emulator on page \pageref{ref:Chip8emulator}
22 \opt{recorder,recorderv2fm,ondio,h1xx,h300,ipodcolor}{, Rockboy on page 22 \opt{recorder,recorderv2fm,ondio,h1xx,h300,ipodcolor,ipodvideo}
23 \pageref{ref:Rockboy} and Sudoku on page \pageref{ref:Sudoku}}.} 23 {and Rockboy on page \pageref{ref:Rockboy}}.}
24 24
25\opt{HAVE_LCD_BITMAP}{\input{plugins/brickmania.tex}} 25\opt{HAVE_LCD_BITMAP}{\input{plugins/brickmania.tex}}
26 26
27\opt{HAVE_LCD_BITMAP}{\input{plugins/bubbles.tex}} 27\opt{HAVE_LCD_BITMAP}{\input{plugins/bubbles.tex}}
28 28
29\opt{recorder,recorderv2fm,ondio,h1xx,h300,IPOD_4G_PAD}{\input{plugins/chessbox.tex}} 29\opt{HAVE_LCD_BITMAP}{\input{plugins/chessbox.tex}}
30 30
31\opt{h1xx,h300,ipodcolor,ipodnano,ipodvideo}{\input{plugins/doom.tex}} 31\opt{h1xx,h300,ipodcolor,ipodnano,ipodvideo}{\input{plugins/doom.tex}}
32 32
33\opt{recorder,recorderv2fm,ondio,h1xx,h300,IPOD_4G_PAD}{\input{plugins/flipit.tex}} 33\opt{HAVE_LCD_BITMAP}{\input{plugins/flipit.tex}}
34 34
35\opt{player}{\input{plugins/jackpot.tex}} 35\opt{player}{\input{plugins/jackpot.tex}}
36 36
37\opt{recorder,recorderv2fm,ondio,h1xx,h300,IPOD_4G_PAD}{\input{plugins/jewels.tex}} 37\opt{HAVE_LCD_BITMAP}{\input{plugins/jewels.tex}}
38 38
39\opt{recorder,recorderv2fm,ondio,h1xx,h300,IPOD_4G_PAD,x5}{\input{plugins/minesweeper.tex}} 39\opt{HAVE_LCD_BITMAP}{\input{plugins/minesweeper.tex}}
40 40
41\opt{player}{\input{plugins/nim.tex}} 41\opt{player}{\input{plugins/nim.tex}}
42 42
43\opt{h1xx,h300,ipodcolor,ipodnano}{\input{plugins/pacbox.tex}} 43\opt{h1xx,HAVE_LCD_COLOR}{\input{plugins/pacbox.tex}}
44 44
45\opt{HAVE_LCD_BITMAP}{\input{plugins/pong.tex}} 45\opt{HAVE_LCD_BITMAP}{\input{plugins/pong.tex}}
46 46
47 \opt{recorder,recorderv2fm,ondio,h1xx,h300,IPOD_4G_PAD}{\input{plugins/rockblox.tex}} 47\opt{HAVE_LCD_BITMAP}{\input{plugins/rockblox.tex}}
48 48
49\opt{recorder,recorderv2fm,ondio,h1xx,h300,IPOD_4G_PAD}{\input{plugins/sliding.tex}} 49\opt{HAVE_LCD_BITMAP}{\input{plugins/sliding.tex}}
50 50
51\opt{recorder,recorderv2fm,ondio,h1xx,h300,IPOD_4G_PAD}{\input{plugins/snake.tex}} 51\opt{HAVE_LCD_BITMAP}{\input{plugins/snake.tex}}
52 52
53\opt{HAVE_LCD_BITMAP}{\input{plugins/snake2.tex}} 53\opt{HAVE_LCD_BITMAP}{\input{plugins/snake2.tex}}
54 54
@@ -60,15 +60,17 @@ will carry on playing whilst plugins are being run.
60 60
61\opt{HAVE_LCD_BITMAP}{\input{plugins/star.tex}} 61\opt{HAVE_LCD_BITMAP}{\input{plugins/star.tex}}
62 62
63\opt{recorder,recorderv2fm,ondio,h1xx,h300,ipod4g,ipodcolor,ipodnano,ipodvideo,x5}{\input{plugins/sudoku.tex}}
64
63\opt{HAVE_LCD_BITMAP}{\input{plugins/tetrox.tex}} 65\opt{HAVE_LCD_BITMAP}{\input{plugins/tetrox.tex}}
64 66
65\opt{recorder,recorderv2fm,ondio,h1xx,h300,IPOD_4G_PAD}{\input{plugins/wormlet.tex}} 67\opt{recorder,recorderv2fm,ondio,h1xx,h300,IPOD_4G_PAD}{\input{plugins/wormlet.tex}}
66 68
67\opt{h1xx,h300,IPOD_4G_PAD}{\input{plugins/xobox.tex}} 69\opt{SWCODEC}{\input{plugins/xobox.tex}}
68 70
69\section{Demos} 71\section{Demos}
70 72
71\opt{recorder,recorderv2fm,ondio,h1xx,h300,IPOD_4G_PAD}{\input{plugins/bounce.tex}} 73\opt{HAVE_LCD_BITMAP}{\input{plugins/bounce.tex}}
72 74
73{\input{plugins/credits.tex}} 75{\input{plugins/credits.tex}}
74 76
@@ -80,19 +82,19 @@ will carry on playing whilst plugins are being run.
80 82
81{\input{plugins/logo.tex}} 83{\input{plugins/logo.tex}}
82 84
83\opt{recorder,recorderv2fm,ondio,h1xx,h300,ipod4g,ipodcolor,ipodnano,ipodvideo}{\input{plugins/mandelbrot.tex}} 85\opt{recorder,recorderv2fm,ondio,h1xx,HAVE_LCD_COLOR}{\input{plugins/mandelbrot.tex}}
84 86
85\opt{player,recorder,recorderv2fm,ondio,h1xx,h300,IPOD_4G_PAD}{\input{plugins/mosaic.tex}} 87{\input{plugins/mosaic.tex}}
86 88
87\opt{recorder,recorderv2fm,ondio,h1xx,h300,IPOD_4G_PAD}{\input{plugins/oscilloscope.tex}} 89\opt{HAVE_LCD_BITMAP}{\input{plugins/oscilloscope.tex}}
88 90
89\opt{HAVE_LCD_BITMAP}{\input{plugins/plasma.tex}} 91\opt{HAVE_LCD_BITMAP}{\input{plugins/plasma.tex}}
90 92
91\opt{player,recorder,recorderv2fm,ondio,h1xx,h300,IPOD_4G_PAD}{\input{plugins/snow.tex}} 93{\input{plugins/snow.tex}}
92 94
93\opt{HAVE_LCD_BITMAP}{\input{plugins/starfield.tex}} 95\opt{HAVE_LCD_BITMAP}{\input{plugins/starfield.tex}}
94 96
95\opt{recorder,recorderv2fm,ondio,h1xx,h300,IPOD_4G_PAD}{\input{plugins/vumeter.tex}} 97\opt{HAVE_LCD_BITMAP}{\input{plugins/vumeter.tex}}
96 98
97\section{\label{ref:Viewersplugins}Viewers} 99\section{\label{ref:Viewersplugins}Viewers}
98 100
@@ -103,7 +105,7 @@ the associated file. Viewers are stored in the
103 105
104\opt{HAVE_LCD_BITMAP}{\input{plugins/chip8emulator.tex}} 106\opt{HAVE_LCD_BITMAP}{\input{plugins/chip8emulator.tex}}
105 107
106\opt{recorder,recorderv2fm,ondio,h1xx,h300,ipodcolor,ipodnano,ipodvideo}{\input{plugins/jpegviewer.tex}} 108\opt{recorder,recorderv2fm,ondio,h1xx,HAVE_LCD_COLOR}{\input{plugins/jpegviewer.tex}}
107 109
108\opt{recorder,recorderv2fm,ondio}{\input{plugins/movieplayer.tex}} 110\opt{recorder,recorderv2fm,ondio}{\input{plugins/movieplayer.tex}}
109 111
@@ -115,8 +117,6 @@ the associated file. Viewers are stored in the
115 117
116{\input{plugins/sort.tex}} 118{\input{plugins/sort.tex}}
117 119
118\opt{recorder,recorderv2fm,ondio,h1xx,h300,ipod4g,ipodcolor,ipodnano,ipodvideo}{\input{plugins/sudoku.tex}}
119
120{\input{plugins/text_viewer.tex}} 120{\input{plugins/text_viewer.tex}}
121 121
122{\input{plugins/vbrfix.tex}} 122{\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}.
29\subsubsection{Keys} 29\subsubsection{Keys}
30\begin{table} 30\begin{table}
31 \begin{btnmap}{}{} 31 \begin{btnmap}{}{}
32 \opt{h1xx,h300,x5,ipodcolor,ipodnano}{\ButtonRight} 32 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD,IPOD_4G_PAD}{\ButtonRight}
33 & Move Up\\ 33 & Move Up\\
34 \opt{h1xx,h300,x5,ipodcolor,ipodnano}{\ButtonLeft} 34 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD,IPOD_4G_PAD}{\ButtonLeft}
35 & Move Down\\ 35 & Move Down\\
36 \opt{h1xx,h300,x5}{\ButtonUp}\opt{ipodcolor,ipodnano}{\ButtonMenu} 36 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD}{\ButtonUp}
37 \opt{IPOD_4G_PAD}{\ButtonMenu}
37 & Move Left\\ 38 & Move Left\\
38 \opt{h1xx,h300,x5}{\ButtonDown}\opt{ipodcolor,ipodnano}{\ButtonPlay} 39 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD}{\ButtonDown}
40 \opt{IPOD_4G_PAD}{\ButtonPlay}
39 & Move Right\\ 41 & Move Right\\
40 \opt{h1xx,h300,x5}{\ButtonRec}\opt{ipodcolor,ipodnano}{\ButtonSelect} 42 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD}{\ButtonRec}
43 \opt{IPOD_4G_PAD}{\ButtonSelect}
41 & Insert Coin\\ 44 & Insert Coin\\
42 \opt{h1xx,h300,x5,ipodcolor,ipodnano}{\ButtonSelect} 45 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD,IPOD_4G_PAD}{\ButtonSelect}
43 & 1-Player Start\\ 46 & 1-Player Start\\
44 \opt{h1xx,h300,x5}{\ButtonOn}\opt{ipodcolor,ipodnano}{n/a} 47 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOn}
48 \opt{IPOD_4G_PAD}{n/a}
49 \opt{IAUDIO_X5_PAD}{\ButtonPower}
45 & 2-Player Start\\ 50 & 2-Player Start\\
46 \opt{h1xx,h300}{\ButtonMode} 51 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonMode}
47 \opt{x5}{\ButtonOn} 52 \opt{IPOD_4G_PAD}{\ButtonSelect+\ButtonMenu}
48 \opt{ipodcolor,ipodnano}{\ButtonSelect+\ButtonMenu} 53 \opt{IAUDIO_X5_PAD}{\ButtonPlay}
49 & Menu\\ 54 & Menu\\
50 \end{btnmap} 55 \end{btnmap}
51\end{table} 56\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 @@
1\subsection{\label{ref:Sudoku}Sudoku} 1\subsection{\label{ref:Sudoku}Sudoku}
2\screenshot{plugins/images/ss-sudoku}{Sudoku}{fig:sudoku} 2\screenshot{plugins/images/ss-sudoku}{Sudoku}{fig:sudoku}
3To play Sudoku you need sudoku games stored as .ss files (see links below). 3Sudoku in Rockbox is implemented as both a plugin and a viewer.
4Once you have your .ss file just open it in the normal file browser to start playing. 4When you start Sudoku in plugin mode from the \setting{Browse Plugins} menu, a random
5game will be generated automatically, and an estimate of its difficulty
6(very easy, easy, medium, hard or fiendish) will be displayed on the screen.
7New games can be generated from the \setting{Generate} menu option.
8
9When you use Sudoku as a viewer for playing pre-generated Sudoku games.
10You need sudoku games stored (one game per file) in text files with the
11\fname{.ss} extension (see links below). You then browse these games using the
12normal \setting{File Browser}, and open the file to launch Sudoku.
13
5You can create and save your own grids under the \setting{New} menu option. 14You can create and save your own grids under the \setting{New} menu option.
6Press the menu button when you have finished and enter the full path 15Press the menu button when you have finished and enter the full path
7to save to including the .ss extension (e.g. \fname{/sudoku/new.ss}). 16to save to including the \fname{.ss} extension (e.g. \fname{/sudoku/new.ss}).
8 17
9\textbf{The thing on the left (AKA the scratchpad)}\\ 18\subsubsection{The thing on the left (AKA the scratchpad)}
10When you play sudoku on paper most people like to mark numbers in 19When you play sudoku on paper most people like to mark numbers in
11cells that are possible candidates for the cells. 20cells that are possible candidates for the cells.
12This can be done with the column on the left. Change the number 21This 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.
17 26
18\begin{table} 27\begin{table}
19 \begin{btnmap}{}{} 28 \begin{btnmap}{}{}
20 29 \opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD}
21 \opt{RECORDER_PAD,ONDIO_PAD,h1xx,h300,x5}{Direction keys} 30 {\ButtonUp, \ButtonDown, \ButtonLeft, \ButtonRight}
22 \opt{IPOD_4G_PAD}{\ButtonScrollFwd/\ButtonScrollBack} 31 \opt{IPOD_4G_PAD}{\ButtonScrollFwd/\ButtonScrollBack}
23 & Move the cursor\\ 32 & Move the cursor\\
24 % 33 %
25 \opt{RECORDER_PAD}{\ButtonPlay} 34 \opt{RECORDER_PAD}{\ButtonPlay}
26 \opt{ONDIO_PAD}{\ButtonMenu} 35 \opt{ONDIO_PAD}{\ButtonMenu}
27 \opt{h1xx,h300}{\ButtonSelect/\ButtonOn} 36 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonSelect/\ButtonOn}
28 \opt{IPOD_4G_PAD}{\ButtonLeft/\ButtonRight} 37 \opt{IPOD_4G_PAD}{\ButtonLeft/\ButtonRight}
38 \opt{IAUDIO_X5_PAD}{\ButtonSelect}
29 & Change number under the cursor\\ 39 & Change number under the cursor\\
30 % 40 %
31 \opt{RECORDER_PAD}{\ButtonFOne} 41 \opt{RECORDER_PAD}{\ButtonFOne}
32 \opt{ONDIO_PAD}{Long press on \ButtonMenu} 42 \opt{ONDIO_PAD}{Long press on \ButtonMenu}
33 \opt{h1xx,h300}{\ButtonMode} 43 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonMode}
34 \opt{IPOD_4G_PAD}{\ButtonMenu} 44 \opt{IPOD_4G_PAD}{\ButtonMenu}
35 \opt{x5}{\ButtonPlay} 45 \opt{IAUDIO_X5_PAD}{\ButtonPlay}
36 & Open Menu\\ 46 & Open Menu\\
37 % 47 %
38 \opt{RECORDER_PAD}{\ButtonFTwo} 48 \opt{RECORDER_PAD}{\ButtonFTwo}
39 \opt{ONDIO_PAD}{\ButtonMenu+\ButtonLeft} 49 \opt{ONDIO_PAD}{\ButtonMenu+\ButtonLeft}
40 \opt{h1xx,h300,x5}{\ButtonRec} 50 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD}{\ButtonRec}
41 \opt{IPOD_4G_PAD}{\ButtonPlay} 51 \opt{IPOD_4G_PAD}{\ButtonPlay}
42 & Add/Remove number to scratchpad\\ 52 & Add/Remove number to scratchpad\\
43 % 53 %
44 \opt{RECORDER_PAD,ONDIO_PAD,h1xx,h300}{\ButtonOff} 54 \opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOff}
45 \opt{x5}{\ButtonPower} 55 \opt{IAUDIO_X5_PAD}{\ButtonPower}
46 \opt{IPOD_4G_PAD}{Menu $\rightarrow$ Quit} 56 \opt{IPOD_4G_PAD}{Menu $\rightarrow$ Quit}
47 & Quit\\ 57 & Quit\\
48 % 58 %
49 \end{btnmap} 59 \end{btnmap}
50\end{table} 60\end{table}
51 61
52Some places where can you can find .ss files: 62Some places where can you can find \fname{.ss} files:
53\begin{itemize} 63\begin{itemize}
54\item Simple Sudoku (Advanced Puzzle Packs 1 and 2 located near the bottom of that page): 64\item Simple Sudoku (Advanced Puzzle Packs 1 and 2 located near the bottom of that page):
55\url{http://www.angusj.com/sudoku/} 65\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.
11 11
12\begin{table} 12\begin{table}
13\begin{btnmap}{}{} 13\begin{btnmap}{}{}
14\opt{recorder,recorderv2fm}{OFF}\opt{ondio}{ON/OFF} 14\opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOff}
15\opt{h1xx,h300}{Stop}\opt{ipodcolor,ipodnano}{Unknown} 15\opt{IPOD_4G_PAD}{\ButtonMenu}
16& Save settings and quit \\ 16\opt{IAUDIO_X5_PAD}{\ButtonPower}
17\opt{recorder,recorderv2fm}{ON}\opt{ondio}{MODE} 17 & Save settings and quit\\
18\opt{h1xx,h300}{Play}\opt{ipodcolor,ipodnano}{Unknown} 18\opt{RECORDER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOn}
19& Help \\ 19\opt{ONDIO_PAD}{\ButtonMenu}
20\opt{recorder,recorderv2fm}{F1}\opt{ondio}{HOLD MODE} 20\opt{IPOD_4G_PAD,IAUDIO_X5_PAD}{\ButtonPlay}
21\opt{h1xx,h300,ipodcolor,ipodnano}{Unknown} 21 & Help\\
22& Settings \\ 22\opt{RECORDER_PAD}{\ButtonFOne}
23UP & Raise Volume \\ 23\opt{ONDIO_PAD}{Hold \ButtonMenu}
24DOWN & Lower Volume \\ 24\opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IPOD_4G_PAD,IAUDIO_X5_PAD}{\ButtonSelect}
25 & Settings\\
26\opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD}
27{\ButtonUp}
28\opt{IPOD_4G_PAD}{\ButtonScrollFwd}
29 & Raise Volume\\
30\opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD}
31{\ButtonDown}
32\opt{IPOD_4G_PAD}{\ButtonScrollBack}
33 & Lower Volume\\
25\end{btnmap} 34\end{btnmap}
26\end{table} 35\end{table}
27