summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--manual/advanced_topics/main.tex5
-rw-r--r--manual/plugins/boomshine.tex5
-rw-r--r--manual/plugins/dict.tex23
-rw-r--r--manual/plugins/fft.tex4
-rw-r--r--manual/plugins/frotz.tex2
-rw-r--r--manual/plugins/main.tex28
-rw-r--r--manual/plugins/main_menu_config.tex17
-rw-r--r--manual/plugins/matrix.tex4
-rw-r--r--manual/plugins/maze.tex39
-rw-r--r--manual/plugins/pdbox.tex11
-rw-r--r--manual/plugins/superdom.tex53
11 files changed, 184 insertions, 7 deletions
diff --git a/manual/advanced_topics/main.tex b/manual/advanced_topics/main.tex
index ba51422e17..9ddf680106 100644
--- a/manual/advanced_topics/main.tex
+++ b/manual/advanced_topics/main.tex
@@ -32,8 +32,9 @@ for changing the settings (the latter will be added automatically).
32To reset the menu items to the default, use \config{root~menu~order:-} (i.e. 32To reset the menu items to the default, use \config{root~menu~order:-} (i.e.
33use a hyphen instead of ``items''). 33use a hyphen instead of ``items'').
34 34
35This configuration entry can only be created and edited with a text editor. It is 35This configuration entry can only be created and edited with a text editor or
36not possible to change this setting via the settings menu. 36the Main Menu Config Plugin (see \reference{ref:main_menu_config}).
37It is not possible to change this setting via the settings menu.
37 38
38\opt{lcd_bitmap}{ 39\opt{lcd_bitmap}{
39\subsection{\label{ref:GettingExtras}Getting Extras} 40\subsection{\label{ref:GettingExtras}Getting Extras}
diff --git a/manual/plugins/boomshine.tex b/manual/plugins/boomshine.tex
new file mode 100644
index 0000000000..d3a3d8504b
--- /dev/null
+++ b/manual/plugins/boomshine.tex
@@ -0,0 +1,5 @@
1\subsection{Boomshine}
2
3This is a game coded in Lua that's a clone of \url{http://www.yvoschaap.com/chainrxn/}.
4It is a rather basic game, but probably a good way to show off some of Lua's features
5in Rockbox.
diff --git a/manual/plugins/dict.tex b/manual/plugins/dict.tex
new file mode 100644
index 0000000000..95ea274a9f
--- /dev/null
+++ b/manual/plugins/dict.tex
@@ -0,0 +1,23 @@
1\subsection{Dict}
2
3\subsubsection{Prerequisites for using the plugin}
4To use the plugin, firstly you need to have the dictionary files which contain
5the words (index) and their description -- \fname{dict.index} and
6\fname{dict.desc}, respectively -- on \fname{/.rockbox/rocks/apps/} folder.
7
8The dictionary files can be created by yourself, or you can get them crafted
9from the web. More information can be found at \wikilink{PluginDict}.
10
11\subsubsection{Using the plugin}
12Now that you already have the two necessary files in place, you can launch the
13dict plugin (under Applications on the Browse plugins menu). The first thing
14you will see is the text input screen.
15
16Type part of a word (or the whole word) or anything the dict files have a
17definition to and accept the text input. The plugin will search for matching
18entries on the \fname{dict.index} file and display according description/meaning
19contained in the \fname{dict.desc} file.
20
21If no matches are found on the dictionary, a ``Not found'' message will be
22displayed and the plugin will exit. You can do another search by relaunching
23the plugin.
diff --git a/manual/plugins/fft.tex b/manual/plugins/fft.tex
new file mode 100644
index 0000000000..69cbbfd8df
--- /dev/null
+++ b/manual/plugins/fft.tex
@@ -0,0 +1,4 @@
1% $Id$ %
2\subsection{FFT}
3This plugin is a basic frequency analyzer with 3 different frequency-amplitude
4plots (lines, bars, and spectrogram).
diff --git a/manual/plugins/frotz.tex b/manual/plugins/frotz.tex
index 4e7882d6be..b9eb4f3ec2 100644
--- a/manual/plugins/frotz.tex
+++ b/manual/plugins/frotz.tex
@@ -1,5 +1,5 @@
1% $Id$ % 1% $Id$ %
2\subsection{Frotz} 2\subsection{\label{ref:Frotz}Frotz}
3Frotz is a Z-Machine interpreter for playing Infocom's interactive fiction 3Frotz is a Z-Machine interpreter for playing Infocom's interactive fiction
4games, and newer games using the same format. To start a game open a 4games, and newer games using the same format. To start a game open a
5\fname{.z1 - .z8} file in the \setting{File Browser}. Most modern games are 5\fname{.z1 - .z8} file in the \setting{File Browser}. Most modern games are
diff --git a/manual/plugins/main.tex b/manual/plugins/main.tex
index 4143fd6b63..e5f5deb140 100644
--- a/manual/plugins/main.tex
+++ b/manual/plugins/main.tex
@@ -19,24 +19,28 @@ text files%
19 19
20\section{Games} 20\section{Games}
21\opt{lcd_bitmap} 21\opt{lcd_bitmap}
22 {See also the Chip{}-8 emulator in \reference{ref:Chip8emulator} 22 {See also the Chip{}-8 emulator in \reference{ref:Chip8emulator},
23 Frotz in \reference{ref:Frotz},
23 \opt{archosrecorder,archosfmrecorder,iriverh100,iaudiom5,lcd_color} 24 \opt{archosrecorder,archosfmrecorder,iriverh100,iaudiom5,lcd_color}
24 {and Rockboy in \reference{ref:Rockboy}}.} 25 {Rockboy in \reference{ref:Rockboy}}
26 and ZXBox in \reference{ref:ZXBox}.}
25 27
26\opt{lcd_bitmap}{\input{plugins/2048.tex}} 28\opt{lcd_bitmap}{\input{plugins/2048.tex}}
27 29
28\opt{lcd_bitmap}{\input{plugins/blackjack.tex}} 30\opt{lcd_bitmap}{\input{plugins/blackjack.tex}}
29 31
32\opt{large_plugin_buffer}{\input{plugins/boomshine.tex}}
33
30\opt{lcd_bitmap}{\input{plugins/brickmania.tex}} 34\opt{lcd_bitmap}{\input{plugins/brickmania.tex}}
31 35
32\opt{lcd_bitmap}{\input{plugins/bubbles.tex}} 36\opt{lcd_bitmap}{\input{plugins/bubbles.tex}}
33 37
34\opt{lcd_bitmap}{\input{plugins/chessbox.tex}} 38\opt{lcd_bitmap}{\input{plugins/chessbox.tex}}
35 39
36\opt{lcd_color}{\input{plugins/clix.tex}}
37
38\opt{lcd_bitmap}{\input{plugins/chopper.tex}} 40\opt{lcd_bitmap}{\input{plugins/chopper.tex}}
39 41
42\opt{lcd_color}{\input{plugins/clix.tex}}
43
40\opt{lcd_color}{\input{plugins/codebuster.tex}} 44\opt{lcd_color}{\input{plugins/codebuster.tex}}
41 45
42{\input{plugins/dice.tex}} 46{\input{plugins/dice.tex}}
@@ -54,6 +58,8 @@ text files%
54 58
55\opt{lcd_bitmap}{\input{plugins/jewels.tex}} 59\opt{lcd_bitmap}{\input{plugins/jewels.tex}}
56 60
61\opt{lcd_bitmap}{\input{plugins/maze.tex}}
62
57\opt{lcd_bitmap}{\input{plugins/mazezam.tex}} 63\opt{lcd_bitmap}{\input{plugins/mazezam.tex}}
58 64
59\opt{lcd_bitmap}{\input{plugins/minesweeper.tex}} 65\opt{lcd_bitmap}{\input{plugins/minesweeper.tex}}
@@ -90,6 +96,9 @@ text files%
90 96
91\opt{lcd_bitmap}{\input{plugins/sudoku.tex}} 97\opt{lcd_bitmap}{\input{plugins/sudoku.tex}}
92 98
99\opt{lcd_non-mono}{\nopt{iriverh10_5gb,ipodmini1g,c200,c200v2,mpiohd200,clipzip,samsungyh820}{
100 \input{plugins/superdom.tex}}}
101
93\opt{lcd_bitmap}{\input{plugins/wormlet.tex}} 102\opt{lcd_bitmap}{\input{plugins/wormlet.tex}}
94 103
95\opt{lcd_bitmap}{\input{plugins/xobox.tex}} 104\opt{lcd_bitmap}{\input{plugins/xobox.tex}}
@@ -106,12 +115,16 @@ text files%
106 115
107\opt{lcd_bitmap}{\input{plugins/demystify.tex}} 116\opt{lcd_bitmap}{\input{plugins/demystify.tex}}
108 117
118\opt{swcodec}{\input{plugins/fft.tex}}
119
109\opt{lcd_bitmap}{\input{plugins/fire.tex}} 120\opt{lcd_bitmap}{\input{plugins/fire.tex}}
110 121
111\opt{lcd_bitmap}{\input{plugins/fractals.tex}} 122\opt{lcd_bitmap}{\input{plugins/fractals.tex}}
112 123
113{\input{plugins/logo.tex}} 124{\input{plugins/logo.tex}}
114 125
126\opt{lcd_bitmap}{\input{plugins/matrix.tex}}
127
115{\input{plugins/mosaic.tex}} 128{\input{plugins/mosaic.tex}}
116 129
117\opt{lcd_bitmap}{\input{plugins/oscilloscope.tex}} 130\opt{lcd_bitmap}{\input{plugins/oscilloscope.tex}}
@@ -193,6 +206,9 @@ option from the \setting{Context Menu} (see \reference{ref:Contextmenu}).}
193 206
194\opt{swcodec}{\input{plugins/mp3_encoder.tex}} 207\opt{swcodec}{\input{plugins/mp3_encoder.tex}}
195 208
209\opt{iriverh300,iriverh100,SANSA_FUZE_PAD,SANSA_E200_PAD,IPOD_4G_PAD,IPOD_3G_PAD%
210 ,IPOD_1G2G_PAD,SAMSUNG_YPR0_PAD}{
211 \input{plugins/pdbox.tex}}
196 212
197\opt{archosrecorder,archosfmrecorder,ondio}{\input{plugins/rockbox_flash.tex}} 213\opt{archosrecorder,archosfmrecorder,ondio}{\input{plugins/rockbox_flash.tex}}
198 214
@@ -236,6 +252,8 @@ option from the \setting{Context Menu} (see \reference{ref:Contextmenu}).}
236 252
237\opt{rtc}{\input{plugins/clock.tex}} 253\opt{rtc}{\input{plugins/clock.tex}}
238 254
255{\input{plugins/dict.tex}}
256
239{\input{plugins/disktidy.tex}} 257{\input{plugins/disktidy.tex}}
240 258
241\opt{archosplayer}{\input{plugins/euro_converter.tex}} 259\opt{archosplayer}{\input{plugins/euro_converter.tex}}
@@ -248,6 +266,8 @@ option from the \setting{Context Menu} (see \reference{ref:Contextmenu}).}
248 266
249\opt{lcd_bitmap}{\input{plugins/lrcplayer.tex}} 267\opt{lcd_bitmap}{\input{plugins/lrcplayer.tex}}
250 268
269{\input{plugins/main_menu_config.tex}}
270
251{\input{plugins/md5sum.tex}} 271{\input{plugins/md5sum.tex}}
252 272
253{\input{plugins/metronome.tex}} 273{\input{plugins/metronome.tex}}
diff --git a/manual/plugins/main_menu_config.tex b/manual/plugins/main_menu_config.tex
new file mode 100644
index 0000000000..b21c0020c6
--- /dev/null
+++ b/manual/plugins/main_menu_config.tex
@@ -0,0 +1,17 @@
1\subsection{Main Menu Configuration}
2{\label{ref:main_menu_config}}
3
4This plugin helps you customizing the main menu (i.e. reorder or hide menu
5items). It changes the appropriate configuration file as described in
6\reference{ref:CustomisingTheMainMenu}.
7
8When you start the plugin, the available main menu items will be displayed.
9By pressing \ActionStdOk{} you open a menu with the following options:
10\begin{description}
11\item[Toggle Item] Hide the selected menu item or make it visible again
12\item[Move Item Up] Swap the selected menu item with the previous one
13\item[Move Item down] Swap the selected menu item with the next one
14\item[Load Default Configuration] Discards all customization
15\item[Exit] Save your changes to the configuration file and exit the plugin
16\end{description}
17You can leave the plugin without saving by pressing \ActionStdCancel{}.
diff --git a/manual/plugins/matrix.tex b/manual/plugins/matrix.tex
new file mode 100644
index 0000000000..8f5622b626
--- /dev/null
+++ b/manual/plugins/matrix.tex
@@ -0,0 +1,4 @@
1\subsection{Matrix}
2
3This plugin is a visual demo resembling the scrolling code from ``The Matrix''
4(\url{https://en.wikipedia.org/wiki/The_Matrix}).
diff --git a/manual/plugins/maze.tex b/manual/plugins/maze.tex
new file mode 100644
index 0000000000..186a650b4d
--- /dev/null
+++ b/manual/plugins/maze.tex
@@ -0,0 +1,39 @@
1\subsection{Maze}
2
3This is a simple maze generator that creates perfect mazes that have only
4one solution.
5
6\begin{btnmap}
7 \opt{IPOD_3G_PAD}{\ButtonScrollBack/\ButtonScrollFwd/\ButtonLeft/\ButtonRight}
8 \nopt{IPOD_3G_PAD}{\PluginUp/\PluginDown/\PluginLeft/\PluginRight}
9 &
10 \opt{HAVEREMOTEKEYMAP}{
11 \PluginRCUp, \PluginRCDown, \PluginRCLeft, \PluginRCRight
12 &}
13 Navigate maze
14 \\
15
16 \opt{IPOD_3G_PAD}{\ButtonMenu}
17 \nopt{IPOD_3G_PAD}{\PluginCancel}
18 &
19 \opt{HAVEREMOTEKEYMAP}{\PluginRCCancel
20 &}
21 Exit plugin
22 \\
23
24 \opt{IPOD_3G_PAD}{Long \ButtonSelect}
25 \nopt{IPOD_3G_PAD}{\PluginSelectRepeat}
26 &
27 \opt{HAVEREMOTEKEYMAP}{\PluginRCSelectRepeat
28 &}
29 New Maze
30 \\
31
32 \opt{IPOD_3G_PAD}{\ButtonSelect}
33 \nopt{IPOD_3G_PAD}{\PluginSelect}
34 &
35 \opt{HAVEREMOTEKEYMAP}{\PluginRCSelect
36 &}
37 Display solution (toggle)
38 \\
39\end{btnmap}
diff --git a/manual/plugins/pdbox.tex b/manual/plugins/pdbox.tex
new file mode 100644
index 0000000000..8301ea2c04
--- /dev/null
+++ b/manual/plugins/pdbox.tex
@@ -0,0 +1,11 @@
1\subsection{PDBox}
2
3PDBox is a Pure Data audio environment with small-size GUI. Those who do not know
4what Pure Data is are advised to look at the book \href{http://aspress.co.uk/ds/}
5{``Designing Sound''}, both at the abridged text and at the sample chapters.
6Another good Pure Data tutorial can be found at \url{http://www.pd-tutorial.com/}.
7
8\subsubsection{Prerequisites for using the plugin}
9To test the abilities of PDBox get the file
10\href{http://www.rockbox.org/wiki/pub/Main/PureDataOnRockbox/PureData.zip}
11{\fname{PureData.zip}}. See \wikilink{PluginPdbox} for more information.
diff --git a/manual/plugins/superdom.tex b/manual/plugins/superdom.tex
new file mode 100644
index 0000000000..59ebffa0b4
--- /dev/null
+++ b/manual/plugins/superdom.tex
@@ -0,0 +1,53 @@
1\subsection{Superdom}
2
3Superdom is a turn based strategy game, where the aim is to defeat the computer
4player by overpowering them using your army.
5
6When the game starts the player is given roughly 50% of the tiles on the map,
7two farms, and two factories. To overpower the enemy, you must place resources
8in adjacent tiles (diagonals do not count), such that your strength is greater
9than the computers, then attack the square.
10
11Each ``year'' is broken up into three phases: purchasing, movement, and war.
12During the purchasing phase you are allocated money and food, may purchase
13units/buildings, and may access the bank.
14
15During the movement phase you can move your units only to adjacent squares
16(except planes, which may move anywhere), at a cost of 1 move per unit you move.
17(Men are considered to be one unit, no matter how many you move). You can change
18the number of moves you receive by default in the settings, and you may purchase
19additional moves for \$100 each. You may also launch nuclear weapons if you have
20purchased any.
21
22During the war phase you can attack the enemy. This is where the strengths come
23into play. Each tile has its own strength for both the computer, and the human
24player. If you attack a square owned by the computer player where your strength
25is greater than the computer's, you will win the tile - and take control of any
26building that were on it. If the strengths are equal, a victor is chosen at
27random.
28
29The bank (in the purchasing phase) is a place where you can store your money
30and earn interest (usually about 10% p.a.), however, while the money is in the
31bank, it is not accessible until the next purchasing phase.
32
33\subsubsection{Notes on food}
34Each year you are allocated an amount of food based on the number of farms you
35control. Food is used to feed your men, but if you do not have enough food to
36feed your population of men, some will die of starvation.
37
38\subsubsection{Summary of units}
39\begin{table}
40 \begin{rbtabular}{\textwidth}{lccX}%
41 {\textbf{Unit} & \textbf{Cost} & \textbf{Individual strength}%
42 & \textbf{Special abilities}}{}{}
43 Men & \$1 each & 1.33 per 100 & No square population limit, however %
44 require 1 food each per year\\
45 Tanks & \$300 & 3 & None\\
46 Planes & \$600 & 4 & Can move to any human controlled point on the map\\
47 Farms & \$1150 & 3 & Generates additional food at start of year\\
48 Factories & \$1300 & 3 & Generates additional food at start of year\\
49 Nukes & \$2000 & 2 & During the movement phase you may lauch a nuke %
50 to destroy all units on a given tile\\
51 \end{rbtabular}
52\end{table}
53Also note that the colour of the adjacent tiles also count towards your strength.