diff options
| -rw-r--r-- | manual/plugins/bounce.tex | 66 | ||||
| -rw-r--r-- | manual/plugins/cube.tex | 12 | ||||
| -rw-r--r-- | manual/plugins/flipit.tex | 89 | ||||
| -rw-r--r-- | manual/plugins/grayscale.tex | 11 | ||||
| -rw-r--r-- | manual/plugins/hello.tex | 14 | ||||
| -rw-r--r-- | manual/plugins/jackpot.tex | 37 | ||||
| -rw-r--r-- | manual/plugins/main.tex | 1243 | ||||
| -rw-r--r-- | manual/plugins/mandelbrot.tex | 58 | ||||
| -rw-r--r-- | manual/plugins/minesweeper.tex | 58 | ||||
| -rw-r--r-- | manual/plugins/mosaic.tex | 12 | ||||
| -rw-r--r-- | manual/plugins/nim.tex | 104 | ||||
| -rw-r--r-- | manual/plugins/oscillograph.tex | 69 | ||||
| -rw-r--r-- | manual/plugins/rockblox.tex | 52 | ||||
| -rw-r--r-- | manual/plugins/sliding.tex | 50 | ||||
| -rw-r--r-- | manual/plugins/snake.tex | 8 | ||||
| -rw-r--r-- | manual/plugins/snake2.tex | 66 | ||||
| -rw-r--r-- | manual/plugins/snow.tex | 12 | ||||
| -rw-r--r-- | manual/plugins/sokoban.tex | 63 | ||||
| -rw-r--r-- | manual/plugins/solitaire.tex | 14 | ||||
| -rw-r--r-- | manual/plugins/star.tex | 63 | ||||
| -rw-r--r-- | manual/plugins/vumeter.tex | 82 | ||||
| -rw-r--r-- | manual/plugins/wormlet.tex | 287 |
22 files changed, 2470 insertions, 0 deletions
diff --git a/manual/plugins/bounce.tex b/manual/plugins/bounce.tex new file mode 100644 index 0000000000..9589f7b575 --- /dev/null +++ b/manual/plugins/bounce.tex @@ -0,0 +1,66 @@ +\subsection{Bounce} +{\centering\itshape + [Warning: Image ignored] % Unhandled or unsupported graphics: +%\includegraphics[width=4.15cm,height=2.35cm]{images/rockbox-manual-img48.png} + \newline +The bounce Demo +\par} + +This demo is of the word ``Rockbox'' bouncing across the screen. There +is also an analogue clock on the Recorder platform. (The Ondio does +not have clock support.) + +Key controls for this demo are: + +\begin{center}\begin{tabular}{|p{3.169cm}|p{8.069cm}|} +\hline +{\centering\bfseries\itshape +KEY +\par} +& +{\centering\bfseries\itshape +ACTION +\par} +\\\hline +{\centering +F1/F2/F3 +\par} +& +Enters Bounce configuration options +\\\hline +{\centering +UP/DOWN +\par} +& +Moves to next/previous option +\\\hline +{\centering +LEFT/RIGHT +\par} +& +Increases/decreases option value +\\\hline +{\centering +ON +\par} +& +Changes to Scroll mode +\\\hline +{\centering +OFF +\par} +& +Exits bounce demo +\\\hline +\end{tabular}\end{center} +Available options are: + +\begin{itemize} +\item \textbf{Xdist/Ydist:} The distance to X axis and Y axis +respectively +\item \textbf{Xadd/Yadd:} how fast the code moves on the sine curve on +each axis +\item \textbf{Xsane/Ysane:} Changes the appearance of the bouncing. +\end{itemize} + + diff --git a/manual/plugins/cube.tex b/manual/plugins/cube.tex new file mode 100644 index 0000000000..3ed06a2dfb --- /dev/null +++ b/manual/plugins/cube.tex @@ -0,0 +1,12 @@ +\subsection{Cube} +{\centering\itshape + [Warning: Image ignored] % Unhandled or unsupported graphics: +%\includegraphics[width=4.124cm,height=2.357cm]{images/rockbox-manual-img49.png} + \newline +Cube +\par} + +This is a rotating cube screen saver in 3D. +To see it at full speed, press PLAY and it will run at maximum frame rate. Also you can change the size of the x, y and z axis using LEFT, RIGHT, UP, DOWN, F1 and F2. + + diff --git a/manual/plugins/flipit.tex b/manual/plugins/flipit.tex new file mode 100644 index 0000000000..fd8eedcec2 --- /dev/null +++ b/manual/plugins/flipit.tex @@ -0,0 +1,89 @@ +\subsection{Flipit} +{\centering\itshape + [Warning: Image ignored] % Unhandled or unsupported graphics: +%\includegraphics[width=3.353cm,height=2.154cm]{images/rockbox-manual-img36.png} + \newline +Flipit plugin +\par} + +Flipping the colour of the token under the cursor also flips the tokens +above, below, left and right of the cursor. The aim is to end up with +a screen containing tokens of only one colour. + +\begin{tabular}[c]{|p{4.951cm}|p{4.7050004cm}|p{4.1740003cm}|} +\hline +{\centering\bfseries\itshape + Recorder +\par} +& +{\centering\bfseries\itshape +Ondio +\par} +& +{\centering\bfseries\itshape +ACTION +\par} +\\\hline +{\centering +UP/DOWN/LEFT/RIGHT +\par} +& +{\centering +UP/DOWN/LEFT/RIGHT +\par} +& +Changes the cursor +\\\hline +{\centering +PLAY +\par} +& +{\centering +Mode +\par} +& +Toggle +\\\hline +{\centering +F1 +\par} +& +{\centering + Mode +Left +\par} +& +Shuffle +\\\hline +{\centering +F2 +\par} +& +{\centering +Mode + Right +\par} +& +Solution +\\\hline +{\centering +F3 +\par} +& +{\centering + Mode + On/off +\par} +& +Step by step +\\\hline +{\centering +OFF +\par} +& +{\centering + On/off +\par} +& +Stop the game +\\\hline +\end{tabular} + + diff --git a/manual/plugins/grayscale.tex b/manual/plugins/grayscale.tex new file mode 100644 index 0000000000..48d7ccc51b --- /dev/null +++ b/manual/plugins/grayscale.tex @@ -0,0 +1,11 @@ +\subsection{Grayscale} +{\centering\itshape + [Warning: Image ignored] % Unhandled or unsupported graphics: +%\includegraphics[width=4.359cm,height=2.492cm]{images/rockbox-manual-img50.png} + \newline +Grayscale +\par} + +This is a demonstration of the Rockbox grayscale engine which supports grayscalegraphics on the Jukebox. Press OFF to quit the demo. + + diff --git a/manual/plugins/hello.tex b/manual/plugins/hello.tex new file mode 100644 index 0000000000..7f867808c1 --- /dev/null +++ b/manual/plugins/hello.tex @@ -0,0 +1,14 @@ +\subsection{Hello World} +{\centering\itshape + [Warning: Image ignored] % Unhandled or unsupported graphics: +%\includegraphics[width=4.688cm,height=1.849cm]{images/rockbox-manual-img51.png} + \newline +Hello world! +\par} + +This is a plugin demo for hackers. Every programmer's +first program is the hello world{}-program +which does nothing except displaying ``Hello +world!'' on the screen. + + diff --git a/manual/plugins/jackpot.tex b/manual/plugins/jackpot.tex new file mode 100644 index 0000000000..840c906f45 --- /dev/null +++ b/manual/plugins/jackpot.tex @@ -0,0 +1,37 @@ +\subsection{Jackpot} +{\centering\itshape + [Warning: Image ignored] % Unhandled or unsupported graphics: +%\includegraphics[width=4.669cm,height=1.998cm]{images/rockbox-manual-img37.png} + \newline +Jackpot +\par} + +This is a jackpot slot machine game. At the beginning of the game you +have 20\$. Payouts are given when three matching symbols come up. + +\begin{tabular}[c]{|p{4.7780004cm}|p{4.2770004cm}|} +\hline +{\centering\bfseries\itshape +KEY +\par} +& +{\centering\bfseries\itshape +ACTION +\par} +\\\hline +{\centering +PLAY +\par} +& +Play +\\\hline +{\centering +STOP +\par} +& +Exit the game +\\\hline +\end{tabular} + + + diff --git a/manual/plugins/main.tex b/manual/plugins/main.tex new file mode 100644 index 0000000000..2a53337a6b --- /dev/null +++ b/manual/plugins/main.tex @@ -0,0 +1,1243 @@ +\chapter{Plugins} +\newpage +Plugins are little programs that Rockbox can load and run. Plugins have +the file extension .rock. Most of them can be started from the main +menu if you put them in the \textbf{/.rockbox/rocks} directory. Press +PLAY on them to start them. + +Viewer plugins get started automatically by +``playing'' an associated file (i.e. text +files, chip8 games), or from the ``Open with'' option on the File menu. + +Plugins listed here have the platforms they run under (Player for +Jukebox players, Recorder for Jukebox recorders including Jukebox FM, +and Ondio for the Ondio SP and FM). If no platforms are listed then +the plugin runs on all Rockbox platforms.\\ + +\textbf{The plugin loader} +Only one plugin can be loaded at a time. Plugins run in the GUI thread +and have exclusive control over the user interface. This means you +cannot switch back and forth between a plugin and Rockbox. A plugin is +loaded, run and then exited, which returns control to Rockbox. Music +will carry on playing whilst plugins are being run. + +\section{Games} +See also the Chip{}-8 emulator on page \pageref{ref:Chip8emulator}. + +\opt{recorder,recorderv2fm,ondio,h1xx,h300}{\input{plugins/flipit.tex}} + +\opt{player}{\input{plugins/jackpot.tex}} + +\opt{recorder,recorderv2fm,ondio,h1xx,h300}{\input{plugins/minesweeper.tex}} + +\opt{player}{\input{plugins/nim.tex}} + +\opt{recorder,recorderv2fm,ondio,h1xx,h300}{\input{plugins/rockblox.tex}} + +\opt{recorder,recorderv2fm,ondio,h1xx,h300}{\input{plugins/sliding.tex}} + +\opt{recorder,recorderv2fm,ondio}{\input{plugins/snake.tex}} + +\opt{recorder,recorderv2fm,ondio,h1xx,h300}{\input{plugins/snake2.tex}} + +\opt{recorder,recorderv2fm,ondio,h1xx,h300}{\input{plugins/sokoban.tex}} + +\opt{recorder,recorderv2fm,ondio,h1xx,h300}{\input{plugins/solitaire.tex}} + +\opt{recorder,recorderv2fm,ondio}{\input{plugins/star.tex}} + +\opt{recorder,recorderv2fm}{\input{plugins/wormlet.tex}} + +\section{Demos} + +\opt{recorder,recorderv2fm,ondio,h1xx,h300}{\input{plugins/bounce.tex}} + +\opt{recorder,recorderv2fm,ondio,h1xx,h300}{\input{plugins/cube.tex}} + +\opt{recorder,recorderv2fm,ondio,h1xx,h300}{\input{plugins/grayscale.tex}} + +{\input{plugins/hello.tex}} + +\opt{recorder,recorderv2fm,ondio,h1xx,h300}{\input{plugins/mandelbrot.tex}} + +\opt{recorder,recorderv2fm,ondio,h1xx,h300}{\input{plugins/mosaic.tex}} + +\opt{recorder,recorderv2fm,ondio}{\input{plugins/oscillograph.tex}} + +\opt{recorder,recorderv2fm,ondio,h1xx,h300}{\input{plugins/snow.tex}} + +\opt{recorder,recorderv2fm,ondio}{\input{plugins/vumeter.tex}} + +\section{\label{ref:Viewersplugins}Viewers} + +Viewers are plugins which are associated with specific file extensions. +They cannot be run directly but are started by ``playing'' +the associated file. Viewers are stored in the +\textbf{/.rockbox/viewers/ }directory. + +\subsection{\label{ref:Chip8emulator}Chip{}-8 Emulator (Recorder, Ondio)} +The Chip{}-8 Emulator allows you to play many old chip8 games found on +the Net. It modifies Rockbox, so file extensions .ch8 will be +recognised as chip8 games. Just press PLAY on a .ch8 file to start a +game. + +There are lots of tiny Chip8 games (usually only about 256 bytes to a +couple of KB) which were made popular by the HP48 +calculator's emulator for them. The original Chip8 had +64x32 pixel graphics, and the new superchip emulator supports 128x64 +graphics, which almost fits on the Recorder's display. +The only problem is they are based on a 4x4 keyboard, but since most +games do not use all of the buttons, this can easily be worked around. + +Some places where can you can find .ch8 files: + +\begin{itemize} +\item The original chip8 patch had several attached: +\url{http://sourceforge.net/tracker/index.php?func=detail&aid=628509&group_id=44306&atid=439120} +\item Check out the HP48 chip games section: +\url{http://www.hpcalc.org/hp48/games/chip/} +\item Check out the PC emulator by the guy who wrote the HP48 emulator: +\url{http://www.pdc.kth.se/~lfo/chip8/CHIP8.htm} +\item Links to other chip8 emulators: +\url{http://www.zophar.net/chip8.html} +\end{itemize} + +\subsection{JPEG viewer (Recorder, Ondio)} +Press PLAY on a .jpg file in order to view the contents using Rockbox's greyscale library. Use the arrow keys to move around the image, PLAY to zoom in +and ON to zoom out. Press OFF to exit the viewer. + +Note: JPEGs that use progressive scan encoding are not supported and will produce an error. + +\subsection{Movie Player (Recorder, Ondio)} +Play movies on your Jukebox! In order to do +this, movies must be in AVI format, and then converted to .RVF, +Rockbox's own video format. For more details on how to use this plugin, please see \url{http://www.rockbox.org/twiki/bin/view/Main/VideoTutorial}. + +\subsection{Rockbox\_flash (Recorder, Ondio)} +{\centering\itshape + [Warning: Image ignored] % Unhandled or unsupported graphics: +%\includegraphics[width=4.059cm,height=2.32cm]{images/rockbox-manual-img57.png} + \newline +Rockbox flash +\par} + +For ``playing'' .UCL files on flashed Jukeboxes. Reprograms the flash memory of +the Jukebox unit (see page \pageref{ref:Rockboxinflash} for details). + +\subsection{Search} +This plugin can be used on playlists. It searches through the playlist +that it is opened on looking for any occurrences of the string entered by the +user. The results of this search are saved to a new playlist, +\textbf{search\_results.m3u}, within the same directory as the +original playlist. + +\subsection{Sort} +This plugin takes a file and sorts it in forward alphabetical order. Case is +ignored. This is useful for ordering playlists generated by the ``Create Playlist'' menu option (see page \pageref{ref:Playlistsubmenu}). + +\subsection{Text Viewer} +This is a Viewer for text files with word wrap. Just press PLAY on a +.txt file to display it. Has controls to handle various styles of text +formatting. Has top{}-of{}-file and bottom{}-of{}-file buttons. You +can view files without a .txt extension by using \textbf{Open with ..} +from the Play Screen menu + +\subsubsection{Controls} + +\begin{itemize} +\item \textbf{F1 (Recorder) / ON{}-MINUS (Player): } +toggles Word mode between Wrap and Chop: + +\begin{itemize} +\item Wrap breaks lines at white space or hyphen. +\item Chop breaks lines at the maximum column limit. +\end{itemize} + +\item \textbf{F2 (Recorder) / ON{}-MENU{}-PLUS (Player): } +cycles Line mode through Normal, Join and Expand: + +\begin{itemize} +\item Normal breaks lines at newline characters. +\item Join ignores unpaired newline characters (i.e., joins lines). Useful for +adopting the orphans that occur with e{}-mail style (i.e.,pre{}-wrapped) text files. +\item Expand doubles unpaired newlines (i.e., adds a blank line). Useful +for making the paragraphs clearer in some book style text files. +\end{itemize} + +\item \textbf{F3 (Recorder) / ON{}-PLUS (Player):} +toggles View mode between Narrow and Wide: + +\begin{itemize} +\item Narrow sets maximum column to the screen width. +\item Wide sets maximum column to 114. Useful for navigating large +files. (Currently, Wide and Join cannot be selected together.) +\end{itemize} + +\item \textbf{ON{}-F1 (Recorder):} +toggles Page mode between Normal and Overlap: + +\begin{itemize} +\item Normal sets page{}-down/page{}-up to one full screen. +\item Overlap tells page{}-down/page{}-up to retain one line from +previous screen. +\end{itemize} + +\item \textbf{ON{}-F3 (Recorder):} +toggles Scrollbar mode, for the current View mode. + +\begin{itemize} +\item Narrow mode has no scrollbar by default, until toggled. +\item Wide mode has a scrollbar by default, until toggled. +\item If file fits on one screen, there is no scrollbar and ON{}-F3 has +no effect. +\end{itemize} +\end{itemize} + +Settings are not remembered after the viewer has been exited. +Keys are as follows: + +\subsubsection{Recorder} + +\begin{tabular}[c]{|p{3.317cm}|p{7.104cm}|} +\hline +{\centering\bfseries\itshape +KEY +\par} +& +{\centering\bfseries\itshape +ACTION +\par} +\\\hline +{\centering +UP +\par} +& +Page{}-up (one screen up) +\\\hline +{\centering +DOWN +\par} +& +Page{}-down (one screen down) +\\\hline +{\centering +LEFT +\par} +& +Top of file (Narrow mode)\newline +One screen left (Wide mode) +\\\hline +{\centering +RIGHT +\par} +& +Bottom of file (Narrow mode)\newline +One screen right (Wide mode) +\\\hline +{\centering +ON{}-UP +\par} +& +One line up +\\\hline +{\centering +ON{}-DOWN +\par} +& +One line down +\\\hline +{\centering +ON{}-LEFT +\par} +& +One column left +\\\hline +{\centering +ON{}-RIGHT +\par} +& +One column right +\\\hline +{\centering +OFF +\par} +& +Exit text viewer +\\\hline +\end{tabular} + +\subsubsection{Player} + +\begin{tabular}[c]{|p{3.291cm}|p{7.131cm}|} +\hline +{\centering\bfseries\itshape +KEY +\par} +& +{\centering\bfseries\itshape +ACTION +\par} +\\\hline +{\centering +MINUS +\par} +& +Page{}-up (one screen up) +\\\hline +{\centering +PLUS +\par} +& +Page{}-down (one screen down) +\\\hline +{\centering +MENU MINUS +\par} +& +Top of file (Narrow mode)\newline +One screen left (Wide mode) +\\\hline +{\centering +MENU PLUS +\par} +& +Bottom of file (Narrow mode)\newline +One screen right (Wide mode) +\\\hline +{\centering +STOP +\par} +& +Exit text viewer +\\\hline +\end{tabular} + +\subsubsection{Compatibility} + +\begin{itemize} +\item Correctly reads plain text files in Unix, Win/DOS, or Macintosh +format. Latin{}-alphabet Unicode files are a l m o s t r e a d a b l +e. +\item Currently prefers fixed{}-width fonts. With proportional fonts, +pretends all characters are the width of a lower{}-case 'o'. +\item Currently messages are in English +\item Does not currently support right{}-to{}-left languages. +\end{itemize} + +\subsection{VBRfix} +This function scans a VBR (Variable Bitrate) +MP3 file and updates/creates the Xing VBR header. The Xing header +contains information about the VBR stream used to calculate average bit +rate, time information and to more accurately fwd/rew in the stream. + +This function is especially useful when the playback of a file skips, +fwd/rew does not work correctly or the time display is incorrect. Run +VBRfix on files you record with your Jukebox. The header is not present +in the recorded files and VBRfix adds this header. + +Note: VBRfix can only run when music is +turned off (since it uses the same memory as the player) and can take a +while to complete if run on big files. + +\section{Applications} + +\subsection{Battery\_test} +{\centering\itshape + [Warning: Image ignored] % Unhandled or unsupported graphics: +%\includegraphics[width=3.704cm,height=2.117cm]{images/rockbox-manual-img58.png} + \textmd{ } [Warning: Image ignored] +% Unhandled or unsupported graphics: +%\includegraphics[width=4.598cm,height=1.976cm]{images/rockbox-manual-img59.png} + \newline + Recorder battery test Player battery test +\par} + +This plugin simulates normal power drain by spinning up the disk and +reading a big file once every 90 seconds (or thereabouts). Each +spin up also writes the battery level to a +log file. The test stops when battery level reaches 4\% in order to +avoid being unable to write to the disk. The power usage data is saved +to a file in the root directory of the Jukebox. This plugin can +sometimes be useful for diagnosing problems with battery charging. + +\subsection{Calculator (Recorder, Ondio)} +{\centering\itshape + [Warning: Image ignored] % Unhandled or unsupported graphics: +%\includegraphics[width=3.889cm,height=2.223cm]{images/rockbox-manual-img60.png} + \newline +Calculator +\par} + +This is a simple scientific calculator for +use on the Jukebox. It works like a standard calculator. Move using +the arrow keys and press PLAY to press a button. Pressing the ``1st'' +button will toggle between other available maths functions on the right +hand side. + +\subsection{Calendar (Recorder, Ondio)} +{\centering\itshape + [Warning: Image ignored] % Unhandled or unsupported graphics: +%\includegraphics[width=3.9cm,height=2.23cm]{images/rockbox-manual-img61.png} + \newline +Calendar +\par} + +This is a small and simple calendar application with memo saving function. + +Dots indicate dates with memos. To add a new memo press PLAY on the +date. Includes one off, annual, monthly, and weekly memos: + +\begin{tabular}[c]{|p{2.6469998cm}|p{3.95cm}|} +\hline +{\centering\bfseries\itshape +KEY +\par} +& +{\centering\bfseries\itshape +ACTION +\par} +\\\hline +{\centering +PLAY +\par} +& +monthly +\\\hline +{\centering +LEFT +\par} +& +weekly +\\\hline +{\centering +RIGHT +\par} +& +annually +\\\hline +{\centering +ON +\par} +& +one off +\\\hline +{\centering +STOP +\par} +& +exit +\\\hline +\end{tabular} + +\subsection{Chess Clock} +{\centering\itshape + [Warning: Image ignored] % Unhandled or unsupported graphics: +%\includegraphics[width=4.634cm,height=1.984cm]{images/rockbox-manual-img62.png} + \newline +Chess Clock +\par} + +The chess clock plugin is designed to +simulate a chess clock, but it can be used +in any kind of game with up to ten players. + +\subsubsection{Setup} + +\begin{itemize} +\item First enter the number of players (1{}-10) (press PLAY to +continue). +\item Then set the total game time in mm:ss (press PLAY to continue, +STOP to go back). +\item Then the maximum round time is entered. For example, this could +be used to play Scrabble for a maximum of 15 minutes each, with each +round taking no longer than one minute. (press PLAY to continue). +\item Done. Player 1 starts in paused mode. So press PLAY to start. +\end{itemize} + +\subsubsection{While playing} +The number of the current player is displayed on the top line. The time +below is the time remaining for that round (and possibly also the total +time left if different). + +Keys are as follows: + +\begin{center}\begin{tabular}{|p{1.917cm}|p{2.7649999cm}|p{1.7049999cm}|p{9.433001cm}|} +\hline +{\centering\bfseries\itshape +PLAYER +\par} +& +{\centering\bfseries\itshape +RECORDER +\par} +& +{\centering\bfseries\itshape +ONDIO +\par} +& +{\centering\bfseries\itshape +FUNCTION +\par} +\\\hline +{\centering +ON +\par} +& +{\centering +OFF +\par} +& +{\centering +ONOFF +\par} +& +Exit plugin +\\\hline +{\centering +STOP +\par} +& +{\centering +LEFT +\par} +& +{\centering +LEFT +\par} +& +Restart round for the player +\\\hline +{\centering +PLAY +\par} +& +{\centering +PLAY +\par} +& +{\centering +RIGHT +\par} +& +Pausing the time (press again to continue) +\\\hline +{\centering +RIGHT +\par} +& +{\centering +UP +\par} +& +{\centering +UP +\par} +& +Switch to next player +\\\hline +{\centering +LEFT +\par} +& +{\centering +DOWN +\par} +& +{\centering +DOWN +\par} +& +Switch to previous player +\\\hline +{\centering +MENU +\par} +& +{\centering +F1 +\par} +& +{\centering +MODE +\par} +& +Enter a simple menu +\\\hline +\end{tabular}\end{center} +From the menu it is possible to delete a player, modify the round time +for the current player or set the total time for the game. + +When the round time is up for a player the message ``ROUND UP!'' is shown (press NEXT to continue). + +When the total time is up for a player the message ``TIME UP!''is shown. Then player will then be removed from the timer. + +\subsection{Clock (Recorder)} +{\centering\itshape + [Warning: Image ignored] % Unhandled or unsupported graphics: +%\includegraphics[width=3.528cm,height=2.016cm]{images/rockbox-manual-img63.png} + \newline +Clock +\par} + +This is a fully featured analogue and digital clock program. + +\subsubsection{Key configuration} + +\begin{center}\begin{tabular}{|p{2.411cm}|p{6.012cm}|} +\hline +{\centering\bfseries\itshape +KEY +\par} +& +{\centering\bfseries\itshape +ACTION +\par} +\\\hline +{\centering +F1 +\par} +& +Help +\\\hline +{\centering +F2 +\par} +& +Start / Stop stopwatch +\\\hline +{\centering +F2 (Hold) +\par} +& +Reset stopwatch +\\\hline +{\centering +F3 +\par} +& +Options +\\\hline +{\centering +Play +\par} +& +Select clock mode +\\\hline +{\centering +UP +\par} +& +Enable idle power off +\\\hline +{\centering +DOWN +\par} +& +Disable idle power off +\\\hline +{\centering +RIGHT +\par} +& +Enable backlight +\\\hline +{\centering +LEFT +\par} +& +Disable backlight +\\\hline +{\centering +OFF +\par} +& +Save settings to disk and exit +\\\hline +\end{tabular}\end{center} + +\subsubsection{Backlight configuration} +If RIGHT or LEFT is not pressed during clock operation (with the +exception of at the Help/Options/Mode Selector/Credit screens) then the +backlight timeout will remain your Rockbox default setting (example, 15 +seconds). If RIGHT or LEFT is pressed, Clock will set the backlight to +ON or OFF, respectively. When Clock is exited, your default Rockbox +setting for Backlight will be restored. + +\subsubsection{Saving Settings} +Settings are saved to disk when Clock is exited. They are saved to +\textbf{/.rockbox/rocks/.clock\_settings''}. To reset your settings +back to the defaults, simply navigate to this file using Rockbox, +highlight it, and press the ON+PLAY keys to get the Delete option. This way you can feel free to experiment with the settings {}- and you could even load +separate settings, say, one for your desk at home and one for in the car {}- by keeping two files in your \textbf{/.rockbox/rocks} folder such as +``h.clock\_settings'' and ``c.clock\_settings''. Simply remove the +``h'' for your home settings to go into effect, or add the ``h'' back and take off the ``c'' for your car settings. + +In the future, loading different settings will probably be made easier +through a built{}-in settings file loader in Clock. + +\subsection{Euro Converter (Player)} +{\centering\itshape + [Warning: Image ignored] % Unhandled or unsupported graphics: +%\includegraphics[width=4.671cm,height=2cm]{images/rockbox-manual-img64.png} + \newline +Euro converter +\par} + +This plugin converts euros back into pre{}-euro currency. The country for which is does this is selectable by pressing the MENU key. The MINUS and +PLUS keys move the cursor between the digits and the PLAY and STOP keys +increase and decrease the current digit. The amount in the old +currency is displayed on the second line. + +\subsection{Favorites} +{\centering\itshape + [Warning: Image ignored] % Unhandled or unsupported graphics: +%\includegraphics[width=4.667cm,height=1.998cm]{images/rockbox-manual-img65.png} + \newline +Favorites +\par} + +When listening to any song you can open it with this plugin and it will +add the current song to a special playlist of all songs you selected in +\textbf{/favorites.m3u}. + +\subsection{Firmware\_flash (Recorder, Ondio)} +{\centering\mdseries\itshape + [Warning: Image ignored] % Unhandled or unsupported graphics: +%\includegraphics[width=3.634cm,height=2.076cm]{images/rockbox-manual-img66.png} + \newline +Firmware\_flash +\par} + +Use when flashing Rockbox (see page \pageref{ref:FlashingRockboxReal}. +In the ideal case, you'll need this tool only once. For safety reasons you may wish to delete \textbf{firmware\_flash.rock} from \textbf{/.rockbox/rocks} once flashing is complete. + +\subsection{Metronome} +This plugin can be used as a metronome to keep time during music +practice. Adjust the tempo though the interface or by tapping it out +on the appropriate button. + +\begin{tabular}[c]{|p{2.587cm}|p{2.55cm}|p{2.62cm}|p{4.952cm}|} +\hline +{\centering\bfseries\itshape +PLAYER +\par} +& +{\centering\bfseries\itshape +RECORDER +\par} +& +{\centering\bfseries\itshape +ONDIO +\par} +& +{\centering\bfseries\itshape +FUNCTION +\par} +\\\hline +{\centering +STOP +\par} +& +{\centering +OFF +\par} +& +{\centering +ONOFF +\par} +& +Exit plugin +\\\hline +{\centering +PLAY +\par} +& +{\centering +PLAY +\par} +& +{\centering +~ +\par} +& +Start / Stop +\\\hline +{\centering +ON +\par} +& +{\centering +ON +\par} +& +{\centering +~ +\par} +& +Tap tempo +\\\hline +{\centering +~ +\par} +& +{\centering +~ +\par} +& +{\centering +MODE +\par} +& +Start / Tap tempo +\\\hline +{\centering +~ +\par} +& +{\centering +~ +\par} +& +{\centering +HOLD MODE +\par} +& +Stop +\\\hline +{\centering +MINUS/PLUS +\par} +& +{\centering +LEFT/RIGHT +\par} +& +{\centering +LEFT/RIGHT +\par} +& +Adjust tempo +\\\hline +{\centering +ON+MINUS/\newline +ON+PLUS +\par} +& +{\centering +UP/DOWN +\par} +& +{\centering +UP/DOWN +\par} +& +Adjust volume +\\\hline +\end{tabular} + +\subsection{Split Editor (Recorder, Ondio)} +When recording an mp3 file, it is common practice to start the recording +a little bit early and stop it a little bit late to ensure all the +desired sound is recorded. This results in recordings that contain +extra snippets of sound and the beginning and end. Unfortunately these +snippets can not be deleted easily because they are stored in the same +file as the desired recording. The purpose of the split editor is to +split a mp3 file (the input file) at a point in time (split point). Two +new files can be generated from the input file. The first file contains +the part before the split point and the second file contains the part +after the split point. Once this process has been successful the +original file can be deleted or kept as a backup. + +The whole process of splitting a mp3 file consists of three steps: + +\begin{enumerate} +\item defining the split point +\item generating the result files. +\item if desired delete the input file (with the browser, not the split +editor) +\end{enumerate} + +\subsubsection{How to use the Split Editor} + +\begin{itemize} +\item \textbf{Pause near the split point} +When the device plays the song just hit the PAUSE button, when playback +has roughly reached the split point. This need not be very precise as +the split point can be fine tuned later. +\item \textbf{Open the split editor} + +Open the plugin. A screen similar to the one below will appear. + +{\centering\itshape + [Warning: Image ignored] % Unhandled or unsupported graphics: +%\includegraphics[width=3.701cm,height=2.11cm]{images/rockbox-manual-img67.gif} + \newline +The Split Editor +\par} + +{\centering\upshape +Here is an explanation of the areas marked in red on the screenshot. +\par} + +\begin{enumerate} +\item The waveform \newline +\newline +The waveform displays the volume of the song over time. It will appear +as the song plays and help to visually identify the point in time where +the split is desired +\item The split point indicator\newline +\newline +The split point indicator is a vertical line with a small triangle at +the top end. It is the most important control element of the split +editor. It can be moved with the LEFT and RIGHT buttons. Later, when +you have fine tuned the split point, the song will be split at this +position. +\item The split time\newline +\newline +At the top of the window a time value is displayed. This is the point in +time within the song at which the split point indicator is positioned. +\item The locator\newline +\newline +Another vertical bar represents the position locator. It moves along as +the song plays. In contrast to the split point indicator it has no +triangles at the ends. +\item The time bar\newline +\newline +The time bar displays the current position within the song relative to +the whole song. The entire length of the time bar represents the song +length. The length of the solid part of the time bar represents the position and length +of the displayed part of the song. +\item The scale mode\newline +\newline +Directly above the F3 button the scale mode is displayed. The waveform +can be scaled either logarithmically or linearly. In logarithmic scale +mode the letters ``dB'' are displayed, in linear mode ``\%''. Use F3 to +switch between these modes. Linear mode usually gives better optical +hints with commercially recorded music. For quiet recordings, +especially of human speech, the logarithmic scale often is preferable. +\item The loop mode \newline +\newline +Directly above the F2 button the loop mode icon is displayed. There are +4 different loop modes. Pressing F2 changes to the next loop mode. + +\begin{itemize} +\item [Warning: Image ignored] % Unhandled or unsupported graphics: +%\includegraphics[width=0.794cm,height=0.476cm]{images/rockbox-manual-img68.gif} + Playback loops around the split point indicator. This mode is best +used when searching and zooming for the desired point at which to split +the recording. +\item [Warning: Image ignored] % Unhandled or unsupported graphics: +%\includegraphics[width=0.794cm,height=0.476cm]{images/rockbox-manual-img69.gif} + Playback loops from the split point indicator to the end of the +visible area. This mode is best used when fine tuning the split +indicator position at the beginning of a recording. +\item [Warning: Image ignored] % Unhandled or unsupported graphics: +%\includegraphics[width=0.794cm,height=0.476cm]{images/rockbox-manual-img70.gif} + Playback loops from the beginning of the +visible area to the split point. This mode is best used when fine +tuning the split indicator position at the end of a recording. +\item [Warning: Image ignored] % Unhandled or unsupported graphics: +%\includegraphics[width=0.688cm,height=0.476cm]{images/rockbox-manual-img71.gif} + Playback doesn't loop, the borders of the visible +area as well as the split point indicator are ignored. This mode is +best used when playing the song outside of the borders of the displayed +region. +\end{itemize} + +\item Perform the split \newline +\newline +The icon directly above the F1 button indicates its function to execute +the split. When split positioning is complete open the save dialogue with F1. +\end{enumerate} + +{\bfseries +Controls in the split editor } +\end{itemize} + +\begin{tabular}[c]{|p{2.975cm}|p{3.047cm}|p{6.649cm}|} +\hline +{\centering\bfseries\itshape +Recorder +\par} +& +{\centering\bfseries\itshape +Ondio +\par} +& +{\centering\bfseries\itshape +Function +\par} +\\\hline +{\centering +Off +\par} +& +{\centering +On/Off +\par} +& +Quit plugin +\\\hline +{\centering +Left/Right +\par} +& +{\centering +Left/Right +\par} +& +Move the split point indicator +\\\hline +{\centering +Up/Down +\par} +& +{\centering +Up/Down +\par} +& +Zoom in / out +\\\hline +{\centering +Play +\par} +& +{\centering +Mode +\par} +& +Play from the split position +\\\hline +{\centering +F1 +\par} +& +{\centering +Mode+Left +\par} +& +Enter the save dialogue +\\\hline +{\centering +F2 +\par} +& +{\centering +Mode+Up +\par} +& +Toggle loop modes +\\\hline +{\centering +F3 +\par} +& +{\centering +Mode+Right +\par} +& +Toggle logarithmic / linear scaling +\\\hline +{\centering +On+Left +\par} +& +{\centering +~ +\par} +& +Play half speed +\\\hline +{\centering +On+Right +\par} +& +{\centering +~ +\par} +& +Play 150\% speed +\\\hline +{\centering +On+Play +\par} +& +{\centering +~ +\par} +& +Play normal speed +\\\hline +\end{tabular} + +\subsubsection{Save the files} +In the save dialogue it is possible to specify which of the files you +want to save and their names. When finished, select +``Save'' and the files will be written to +disk. Note that files can not be overwritten, so filenames that +don't exist yet must be chosen. If unsure whether the +file already exists simply try to save it. If another file with this +name exists the dialogue will return and you can choose another +filename + +{\centering\itshape + [Warning: Image ignored] % Unhandled or unsupported graphics: +%\includegraphics[width=3.701cm,height=2.11cm]{images/rockbox-manual-img72.gif} + \newline +Save dialogue +\par} + +Controls in the save dialogue +\begin{tabular}[c]{|p{2.62cm}|p{2.266cm}|p{3.965cm}|} +\hline +{\centering\bfseries\itshape +RECORDER +\par} +& +{\centering\bfseries\itshape +ONDIO +\par} +& +{\centering\bfseries\itshape +FUNCTION +\par} +\\\hline +{\centering +UP/DOWN +\par} +& +{\centering +UP/DOWN +\par} +& +Select item +\\\hline +{\centering +PLAY +\par} +& +{\centering +RIGHT +\par} +& +Toggle / edit item +\\\hline +\end{tabular} + +\subsubsection{Scale} +The values in the waveform are scaled according to the settings of the +peak meter. These can be altered in the menu +\textbf{General Settings {}-{\textgreater} Display{}-{\textgreater} Peak Meter}. If extreme minimum / +maximum values are set the waveform might be cut off. A minimum +setting of {}-60 dB and a maximum setting of 0 dB are recommended. +These settings should be capable of producing useful waveforms for very +soft sounds in logarithmic mode (dB). When the editor is used on loud +sounds (such as commercial rock or pop music) switching to the linear +scale may prove more effective since the logarithmic scale compresses +loud noises and makes it more difficult to identify characteristic +shapes. Note that it is always possible to toggle the scale with F3. + +\subsection{Stopwatch} +{\centering\itshape + [Warning: Image ignored] % Unhandled or unsupported graphics: +%\includegraphics[width=3.704cm,height=2.117cm]{images/rockbox-manual-img73.png} + \textmd{ } [Warning: Image ignored] +% Unhandled or unsupported graphics: +%\includegraphics[width=4.667cm,height=1.998cm]{images/rockbox-manual-img74.png} + \newline +Recorder stopwatch Player stopwatch +\par} + +A simple stopwatch program with support for saving times. + +\subsubsection{Keys are as follows:} + +\begin{tabular}[c]{|p{2.9029999cm}|p{2.763cm}|p{2.199cm}|p{5.235cm}|} +\hline +{\centering\bfseries\itshape +PLAYER +\par} +& +{\centering\bfseries\itshape +RECORDER +\par} +& +{\centering\bfseries\itshape +ONDIO +\par} +& +{\centering\bfseries\itshape +FUNCTION +\par} +\\\hline +{\centering +MENU +\par} +& +{\centering +OFF +\par} +& +{\centering +ONOFF +\par} +& +Quit Plugin +\\\hline +{\centering +PLAY +\par} +& +{\centering +PLAY +\par} +& +{\centering +RIGHT +\par} +& +Start / stop +\\\hline +{\centering +STOP +\par} +& +{\centering +LEFT +\par} +& +{\centering +LEFT +\par} +& +Reset timer +\\\hline +{\centering +ON +\par} +& +{\centering +ON +\par} +& +{\centering +MODE +\par} +& +Take lap time +\\\hline +{\centering +MINUS/PLUS +\par} +& +{\centering +DOWN/UP +\par} +& +{\centering +DOWN/UP +\par} +& +Scroll through lap times +\\\hline +\end{tabular} diff --git a/manual/plugins/mandelbrot.tex b/manual/plugins/mandelbrot.tex new file mode 100644 index 0000000000..6cbbfa46f6 --- /dev/null +++ b/manual/plugins/mandelbrot.tex @@ -0,0 +1,58 @@ +\subsection{Mandelbrot} +{\centering\itshape + [Warning: Image ignored] % Unhandled or unsupported graphics: +%\includegraphics[width=3.865cm,height=2.21cm]{images/rockbox-manual-img52.png} + \newline +Mandelbrot +\par} + +This is another demonstration using the grayscale engine. It draws fractal images from the Mandelbrot set. + +\begin{center}\begin{tabular}{|p{2.726cm}|p{7.884cm}|} +\hline +{\centering\bfseries\itshape +KEY +\par} +& +{\centering\bfseries\itshape +ACTION +\par} +\\\hline +{\centering +Arrow keys +\par} +& +Move about the image +\\\hline +{\centering +PLAY +\par} +& +Zoom in +\\\hline +{\centering +OFF +\par} +& +Quit +\\\hline +{\centering +F1 +\par} +& +Increase iteration depth (more detail) +\\\hline +{\centering +F2 +\par} +& +Decrease iteration depth (less detail) +\\\hline +{\centering +F3 +\par} +& +Reset and return to the default image +\\\hline +\end{tabular}\end{center} + diff --git a/manual/plugins/minesweeper.tex b/manual/plugins/minesweeper.tex new file mode 100644 index 0000000000..0ec37cd77d --- /dev/null +++ b/manual/plugins/minesweeper.tex @@ -0,0 +1,58 @@ +\subsection{Minesweeper} +{\centering\itshape +Minesweeper plugin +\par} + +\begin{center} + [Warning: Image ignored] % Unhandled or unsupported graphics: +%\includegraphics[width=2.963cm,height=1.693cm]{images/rockbox-manual-img38.png} + +\end{center} +The classic game of minesweeper. Use the UP and DOWN keys to select the +required percentage of mines to set the difficulty then press the MENU +key to begin. + +The aim of the game is to uncover all of the squares on the board. If a +mine is uncovered then the game is over. If a mine is not uncovered, +then the number of mines adjacent to the current square is revealed. +The aim is to use the information you are given to work out where the +mines are and avoid them. When the player is certain that they know +the location of a mine, it can be tagged to avoid accidentally +``stepping'' on it. + +\begin{tabular}[c]{|p{5.0210004cm}|p{10.77cm}|} +\hline +{\centering\bfseries\itshape +KEY +\par} +& +{\centering\bfseries\itshape +ACTION +\par} +\\\hline +{\centering +UP/DOWN/LEFT/RIGHT +\par} +& +Move the cursor across the minefield +\\\hline +{\centering +PLAY / F1 +\par} +& +Toggle flag on / off +\\\hline +{\centering +MENU / F2 +\par} +& +Reveal the contents of the current square +\\\hline +{\centering +STOP +\par} +& +Exit the game +\\\hline +\end{tabular} + diff --git a/manual/plugins/mosaic.tex b/manual/plugins/mosaic.tex new file mode 100644 index 0000000000..4d945da85d --- /dev/null +++ b/manual/plugins/mosaic.tex @@ -0,0 +1,12 @@ +\subsection{Mosaic} +{\centering\itshape + [Warning: Image ignored] % Unhandled or unsupported graphics: +%\includegraphics[width=3.706cm,height=2.117cm]{images/rockbox-manual-img53.png} + \newline +Mosaic +\par} + +This simple graphics demo draws a mosaic picture on the screen of the +Jukebox. Press STOP to quit. + + diff --git a/manual/plugins/nim.tex b/manual/plugins/nim.tex new file mode 100644 index 0000000000..8745a94538 --- /dev/null +++ b/manual/plugins/nim.tex @@ -0,0 +1,104 @@ +subsection{Nim} +{\centering\itshape + [Warning: Image ignored] % Unhandled or unsupported graphics: +%\includegraphics[width=5.128cm,height=1.99cm]{images/rockbox-manual-img39.png} + \newline +Nim plugin +\par} + +Rules of Nim: There are 21 matches. Two players (you and the Jukebox) +alternately pick a certain number of matches and the one who takes the +last match loses. You can take up to twice as many matches as the +Jukebox selected, and vice versa. + +\begin{center}\begin{tabular}{|p{2.257cm}|p{10.341001cm}|} +\hline +{\centering\bfseries\itshape +KEY +\par} +& +{\centering\bfseries\itshape +ACTION +\par} +\\\hline +{\centering +MINUS +\par} +& +Decrease the number of matches +\\\hline +{\centering +PLUS +\par} +& +Increase the number of matches +\\\hline +{\centering +PLAY +\par} +& +Remove the number of matches you have selected +\\\hline +{\centering +STOP +\par} +& +Exit the game +\\\hline +\end{tabular}\end{center} +\subsubsection{Pong (Recorder, Ondio)} +{\centering\itshape + [Warning: Image ignored] % Unhandled or unsupported graphics: +%\includegraphics[width=3.787cm,height=2.164cm]{images/rockbox-manual-img40.png} + \newline +Pong game +\par} + +The world's first arcade game comes to Rockbox. This +is a ``tennis game'' for two players. The +left player uses LEFT and F1 to move and the right player uses RIGHT +and F3. The aim is to prevent the ball leaving the screen. The player +that loses the least balls wins. + +\begin{center}\begin{tabular}{|p{2.269cm}|p{4.7710004cm}|} +\hline +{\centering\bfseries\itshape +KEY +\par} +& +{\centering\bfseries\itshape +ACTION +\par} +\\\hline +{\centering +F1 +\par} +& +Player 1 up +\\\hline +{\centering +LEFT +\par} +& +Player 1 down +\\\hline +{\centering +F3 +\par} +& +Player 2 up +\\\hline +{\centering +RIGHT +\par} +& +Player 2 down +\\\hline +{\centering +OFF +\par} +& +Quit +\\\hline +\end{tabular}\end{center} + diff --git a/manual/plugins/oscillograph.tex b/manual/plugins/oscillograph.tex new file mode 100644 index 0000000000..021b71a875 --- /dev/null +++ b/manual/plugins/oscillograph.tex @@ -0,0 +1,69 @@ +\subsection{Oscillograph} +{\centering\itshape + [Warning: Image ignored] % Unhandled or unsupported graphics: +%\includegraphics[width=3.6cm,height=2.057cm]{images/rockbox-manual-img54.png} + \newline +Oscillograph +\par} + +This demo shows the shape of the sound samples that make up the music +being played. + +At faster speed rates, the Jukebox is less responsive to user input. + +\subsubsection{Key controls:} + +\begin{center}\begin{tabular}{|p{2.217cm}|p{8.205cm}|} +\hline +{\centering\bfseries\itshape +KEY +\par} +& +{\centering\bfseries\itshape +ACTION +\par} +\\\hline +{\centering +F1 +\par} +& +toggles whether to scroll or not +\\\hline +{\centering +F2 +\par} +& +toggles filled / curve / plot +\\\hline +{\centering +F3 +\par} +& +reset speed to 0 +\\\hline +{\centering +UP +\par} +& +slow down scrolling +\\\hline +{\centering +DOWN +\par} +& +Speeds up scrolling +\\\hline +{\centering +PLAY +\par} +& +Pauses the demo +\\\hline +{\centering +OFF +\par} +& +Exits demo +\\\hline +\end{tabular}\end{center} + diff --git a/manual/plugins/rockblox.tex b/manual/plugins/rockblox.tex new file mode 100644 index 0000000000..cdd60cb6c1 --- /dev/null +++ b/manual/plugins/rockblox.tex @@ -0,0 +1,52 @@ +\subsection{Rockblox} +{\centering\itshape + [Warning: Image ignored] % Unhandled or unsupported graphics: +%\includegraphics[width=3.949cm,height=2.23cm]{images/rockbox-manual-img41.png} + \newline +Rockblox plugin +\par} + +This well{}-known game will probably be familiar. The aim of the game is +to complete rows with the given pieces (blocks). Pieces can be rotated +to make them fit into the rows. Once you complete a row, it gets +cleared, but if the blocks reach the top row then you lose. + +The controls for this game (with the Jukebox turned so that the buttons +are to the right of the screen) are: + +\begin{center}\begin{tabular}{|p{3.487cm}|p{9.657001cm}|} +\hline +{\centering\bfseries\itshape +KEY +\par} +& +{\centering\bfseries\itshape +ACTION +\par} +\\\hline +{\centering +UP +\par} +& +Rotate piece +\\\hline +{\centering +LEFT/RIGHT +\par} +& +Move piece to the left/right +\\\hline +{\centering +DOWN +\par} +& +Move faster the piece downwards +\\\hline +{\centering +OFF +\par} +& +Exit Rockblox +\\\hline +\end{tabular}\end{center} + diff --git a/manual/plugins/sliding.tex b/manual/plugins/sliding.tex new file mode 100644 index 0000000000..e569b9f4fa --- /dev/null +++ b/manual/plugins/sliding.tex @@ -0,0 +1,50 @@ +\subsection{Sliding Puzzle} +{\centering\itshape + [Warning: Image ignored] % Unhandled or unsupported graphics: +%\includegraphics[width=3.988cm,height=2.279cm]{images/rockbox-manual-img42.png} + \newline +Sliding puzzle +\par} + +The classic sliding puzzle game. Rearrange the pieces so that you can +see the whole picture. + +Key controls: + +\begin{center}\begin{tabular}{|p{4.7780004cm}|p{4.321cm}|} +\hline +{\centering\bfseries\itshape +KEY +\par} +& +{\centering\bfseries\itshape +ACTION +\par} +\\\hline +{\centering +UP/DOWN/LEFT/RIGHT +\par} +& +Moves +\\\hline +{\centering +F1 +\par} +& +Shuffle +\\\hline +{\centering +F2 +\par} +& +Change the picture +\\\hline +{\centering +OFF +\par} +& +Stop the game +\\\hline +\end{tabular}\end{center} + + diff --git a/manual/plugins/snake.tex b/manual/plugins/snake.tex new file mode 100644 index 0000000000..dfe596b6f5 --- /dev/null +++ b/manual/plugins/snake.tex @@ -0,0 +1,8 @@ +\subsection{Snake} +This is the popular snake game. The aim is to grow your snake as large +as possible by eating the dots that appear on the screen. The game will +end when the snake touches either the borders of the screen or itself. + +Change levels with UP/DOWN keys (level 1 is slowest, level 9 is +fastest). Press PLAY to start or pause. + diff --git a/manual/plugins/snake2.tex b/manual/plugins/snake2.tex new file mode 100644 index 0000000000..1bb6eccb41 --- /dev/null +++ b/manual/plugins/snake2.tex @@ -0,0 +1,66 @@ +\subsection{ Snake 2} +{\centering\itshape + [Warning: Image ignored] % Unhandled or unsupported graphics: +%\includegraphics[width=3.96cm,height=2.23cm]{images/rockbox-manual-img43.png} + \newline +Snake 2 {--} The Snake Strikes Back +\par} + +Another version of the Snake game. Move the snake around, and eat the +apples that pop up on the screen. Each time an apple is eaten, the +snake gets longer. The game ends when the snake hits a wall, or runs +into itself. + +The controls are: + +\begin{center}\begin{tabular}{|p{5.0550003cm}|p{7.984cm}|} +\hline +{\centering\bfseries\itshape +KEY +\par} +& +{\centering\bfseries\itshape +ACTION +\par} +\\\hline +{\centering +UP/DOWN +\par} +& +(in menu) Set game speed +\\\hline +{\centering +F1 +\par} +& +(in menu) Change starting maze +\\\hline +{\centering +F3 +\par} +& +(in menu) Select game type (A or B) +\\\hline +{\centering +UP/DOWN/LEFT/RIGHT +\par} +& +Steer the snake +\\\hline +{\centering +PLAY +\par} +& +Pause the game +\\\hline +{\centering +STOP +\par} +& +Exit the game +\\\hline +\end{tabular}\end{center} +In game A, the maze stays the same, in Game B +after an increasing number of apples eaten the maze is replaced by a +new one. + diff --git a/manual/plugins/snow.tex b/manual/plugins/snow.tex new file mode 100644 index 0000000000..cc7c82d3d4 --- /dev/null +++ b/manual/plugins/snow.tex @@ -0,0 +1,12 @@ + +\subsection{Snow} +{\centering\itshape + [Warning: Image ignored] % Unhandled or unsupported graphics: +%\includegraphics[width=4.15cm,height=2.35cm]{images/rockbox-manual-img55.png} + \newline +Have you ever seen snow falling? +\par} + +This demo replicates snow falling on your screen. If you love winter, +you will love this demo. Or maybe not. + diff --git a/manual/plugins/sokoban.tex b/manual/plugins/sokoban.tex new file mode 100644 index 0000000000..91141a9cbe --- /dev/null +++ b/manual/plugins/sokoban.tex @@ -0,0 +1,63 @@ +\subsection{Sokoban} +{\centering\itshape + [Warning: Image ignored] % Unhandled or unsupported graphics: +%\includegraphics[width=4.15cm,height=2.35cm]{images/rockbox-manual-img44.png} + \newline +Sokoban +\par} + +The object of the game is to push boxes into their correct position in a +crowded warehouse with a minimal number of pushes and moves. The boxes +can only be pushed, never pulled, and only one can be pushed at a time. + +The controls are: + +\begin{tabular}[c]{|p{5.25cm}|p{10.341001cm}|} +\hline +{\centering\bfseries\itshape +KEY +\par} +& +{\centering\bfseries\itshape +ACTION +\par} +\\\hline +{\centering +UP/DOWN/LEFT/RIGHT +\par} +& +Move the ``sokoban'' up, down, left or right +\\\hline +{\centering +F1 +\par} +& +Back to previous level +\\\hline +{\centering +F2 +\par} +& +Restart level +\\\hline +{\centering +F3 +\par} +& +Go to next level +\\\hline +{\centering +ON +\par} +& +Undo last movement +\\\hline +{\centering +OFF +\par} +& +Exit sokoban +\\\hline +\end{tabular} + + diff --git a/manual/plugins/solitaire.tex b/manual/plugins/solitaire.tex new file mode 100644 index 0000000000..7002e69222 --- /dev/null +++ b/manual/plugins/solitaire.tex @@ -0,0 +1,14 @@ +\subsection{Solitaire} +{\centering\itshape + [Warning: Image ignored] % Unhandled or unsupported graphics: +%\includegraphics[width=3.96cm,height=2.251cm]{images/rockbox-manual-img45.png} + \newline +Klondike solitaire +\par} + +This is the classic Klondike solitaire game +for Rockbox. Select \textbf{help }from the game menu to get an +explanation of what the keys do. Rules for Klondike solitaire are +available from \url{http://www.solitairecentral.com/rules/klondike.html}. + + diff --git a/manual/plugins/star.tex b/manual/plugins/star.tex new file mode 100644 index 0000000000..a39b6f4709 --- /dev/null +++ b/manual/plugins/star.tex @@ -0,0 +1,63 @@ +\subsection{Star} +{\centering\itshape + [Warning: Image ignored] % Unhandled or unsupported graphics: +%\includegraphics[width=3.865cm,height=2.208cm]{images/rockbox-manual-img46.png} + \newline +Star game +\par} + +This is a puzzle game. It is actually a rewrite of Star, a game written +by CDK designed for the hp48 calculator. + +Rules: Take all of the ``o''s to go to the +next level. The on key allows you to switch between the filled circle, +which can take ``o''s, and the filled square, which is used as a mobile +wall to allow your filled circle to get to places on the screen it +could not otherwise reach. The block cannot take ``o''s. + +{\bfseries +Keys:} + +\begin{center}\begin{tabular}{|p{4.7780004cm}|p{4.321cm}|} +\hline +{\centering\bfseries\itshape +KEY +\par} +& +{\centering\bfseries\itshape +ACTION +\par} +\\\hline +{\centering +ON +\par} +& +Toggle control +\\\hline +{\centering +F1 +\par} +& +Previous level +\\\hline +{\centering +F2 +\par} +& +Reset level +\\\hline +{\centering +F3 +\par} +& +Next level +\\\hline +{\centering +OFF +\par} +& +Exit the game +\\\hline +\end{tabular}\end{center} + + diff --git a/manual/plugins/vumeter.tex b/manual/plugins/vumeter.tex new file mode 100644 index 0000000000..1694d5100f --- /dev/null +++ b/manual/plugins/vumeter.tex @@ -0,0 +1,82 @@ +\subsection{VU meter} +{\centering\itshape + [Warning: Image ignored] % Unhandled or unsupported graphics: +%\includegraphics[width=4.304cm,height=2.459cm]{images/rockbox-manual-img56.png} + \newline +VU meter +\par} + +This is a VU meter, which displays the volume of the left and right +audio channels. There are 3 types of meter selectable. The analogue +meter is a classic needle style. The digital meter is modelled after +LED volume displays, and the mini{}-meter option allows for the display +of small meters in addition to the main display (as above). From the +settings menu the decay time for the meter (its memory), the meter type +and the meter scale can be changed. + +\begin{tabular}[c]{|p{2.409cm}|p{2.908cm}|p{4.494cm}|} +\hline +{\centering\bfseries\itshape +RECORDER +\par} +& +{\centering\bfseries\itshape +ONDIO +\par} +& +{\centering\bfseries\itshape +FUNCTION +\par} +\\\hline +{\centering +OFF +\par} +& +{\centering +ONOFF +\par} +& +Save settings and quit +\\\hline +{\centering +ON +\par} +& +{\centering +MODE +\par} +& +Help +\\\hline +{\centering +F1 +\par} +& +{\centering +HOLD MODE +\par} +& +Settings +\\\hline +{\centering +UP +\par} +& +{\centering +UP +\par} +& +Raise Volume +\\\hline +{\centering +DOWN +\par} +& +{\centering +DOWN +\par} +& +Lower Volume +\\\hline +\end{tabular} + diff --git a/manual/plugins/wormlet.tex b/manual/plugins/wormlet.tex new file mode 100644 index 0000000000..5bff66b9f4 --- /dev/null +++ b/manual/plugins/wormlet.tex @@ -0,0 +1,287 @@ +\subsection{Wormlet} +{\centering\itshape + [Warning: Image ignored] % Unhandled or unsupported graphics: +%\includegraphics[width=4.15cm,height=2.35cm]{images/rockbox-manual-img47.png} + \newline +Wormlet game +\par} + +Wormlet is a multi{}-user multi{}-worm game on a multi{}-threaded +multi{}-functional Rockbox console. You navigate a hungry little worm. +Help your worm to find food and to avoid poisoned argh{}-tiles. The +goal is to turn your tiny worm into a big worm for as long as possible. + +For 2{}-player games a remote control is not necessary but recommended. +If you try to hold the Jukebox in the four hands of two players +you'll find out why. Games with three players are only +possible using a remote control. + +{\bfseries +Wormlet main menu controls:} + +\begin{center}\begin{tabular}{|p{2.55cm}|p{9.958cm}|} +\hline +{\centering\bfseries\itshape +KEY +\par} +& +{\centering\bfseries\itshape +ACTION +\par} +\\\hline +{\centering +UP/DOWN +\par} +& +Selects number of players +\\\hline +{\centering +LEFT/RIGHT +\par} +& +Controls number of worms on the game +\\\hline +{\centering +F1 +\par} +& +Selects game mode. +\\\hline +\end{tabular}\end{center} +{\bfseries +Game controls:} + +\begin{center}\begin{tabular}{|p{2.162cm}|p{1.67cm}|p{3.813cm}p{4.256cm}p{4.1000004cm}|} +\hline +{\centering\bfseries\itshape +Players +\par} +& +{\centering\bfseries\itshape +MODES +\par} +& +\multicolumn{1}{p{3.813cm}|}{{\centering\bfseries\itshape +PLAYER 1 +\par} +}& +\multicolumn{1}{p{4.256cm}|}{{\centering\bfseries\itshape +PLAYER 2 +\par} +}& +{\centering\bfseries\itshape +PLAYER 3 +\par} +\\\hline +{\centering +0 +\par} +& +{\centering +Out of control +\par} +& +\multicolumn{3}{p{12.569cm}|}{With no player taking part in the game all +worms are out of control and steered by artificial stupidity. +}\\\hline +\multicolumn{1}{|p{2.162cm}}{{\centering +1 +\par} +}& +\multicolumn{4}{p{14.439cm}}{\hspace*{-\tabcolsep}\begin{tabular}{|p{1.67cm}|p{3.813cm}|p{4.256cm}|p{4.1000004cm}|} + +{\centering +2 key control +\par} +& +on Jukebox\newline +LEFT: turn left\newline +RIGHT: turn right +& +{}- +& +{}- +\\\hline +{\centering +4 key control +\par} +& +on Jukebox\newline +LEFT: turn left\newline +UP: turn up\newline +RIGHT: turn right\newline +DOWN: turn down +& +{}- +& +{}- +\\\hline +\end{tabular}\hspace*{-\tabcolsep} +}\\\cline{1-1} +\multicolumn{1}{|p{2.162cm}}{{\centering +2 +\par} +}& +\multicolumn{4}{p{14.439cm}}{\hspace*{-\tabcolsep}\begin{tabular}{|p{1.67cm}|p{3.813cm}|p{4.256cm}|p{4.1000004cm}|} + +{\centering +Remote control +\par} +& +on Jukebox\newline +LEFT: turn left\newline +RIGHT: turn right +& +on remote control\newline +VOL DOWN: turn left\newline +VOL UP: turn right +& +{}- +\\\hline +{\centering +No remote control +\par} +& +on Jukebox\newline +LEFT: turn left\newline +RIGHT: turn right +& +on Jukebox\newline +F2: turn left\newline +F3: turn right +& +{}- +\\\hline +\end{tabular}\hspace*{-\tabcolsep} +}\\\cline{1-1} +{\centering +3 +\par} +& +{\centering +Remote control +\par} +& +\multicolumn{1}{p{3.813cm}|}{on Jukebox\newline +LEFT: turn left\newline +RIGHT: turn right +}& +\multicolumn{1}{p{4.256cm}|}{on remote control\newline +VOL DOWN: turn left\newline +VOL UP: turn right +}& +on Jukebox\newline +F2: turn left\newline +F3: turn right +\\\hline +\end{tabular}\end{center} + +\subsubsection{The game} +Use the control keys of your worm to navigate around obstacles and find +food. Worms do not stop moving except when dead. Dead worms are no fun. +Be careful as your worm will try to eat anything that you steer it +across. It won't distinguish whether it's edible or not. + +\begin{itemize} +\item \textbf{Food} +The small square hollow pieces are food. Move the worm over a food tile +to eat it. After eating the worm grows. Each time a piece of food has +been eaten a new piece of food will pop up somewhere. Unfortunately for +each new piece of food that appears two new ``argh'' pieces will +appear, too. +\item \textbf{Argh} +An ``argh'' is a black square poisoned piece {}- slightly bigger than +food {}- that makes a worm say ``Argh!'' when +run into. A worm that eats an ``argh'' is dead. Thus eating an +``argh'' must be avoided under any circumstances. ``Arghs'' have the +annoying tendency to accumulate. +\item \textbf{Worms} +Thou shall not eat worms. Neither other worms nor thyself. Eating worms +is blasphemous cannibalism, not healthy and causes instant +death. And it doesn't help anyway: the other worm +isn't hurt by the bite. It will go on creeping happily +and eat all the food you left on the table. +\item \textbf{Walls} +Don't crash into the walls. Walls are not edible. +Crashing a worm against a wall causes it a headache it +doesn't survive. +\item \textbf{Game over} + +The game is over when all worms are dead. The longest worm wins the +game. +\item \textbf{Pause the game} +Press the PLAY key to pause the game. Hit PLAY again to resume the game. + +\item \textbf{Stop the game} +There are two ways to stop a running game. + +\begin{itemize} +\item If you want to quit Wormlet entirely simply hit the OFF button. +The game will stop immediately and you will return to the game menu. +\item If you want to stop the game and still see the screen hit the ON +button. This freezes the game. If you hit the ON button again a new +game starts with the same configuration. To return to the games menu +you can hit the OFF button. A stopped game can not be resumed. +\end{itemize} +\end{itemize} + +\subsubsection{The scoreboard} +On the right side of the game field is the score board. For each worm it +displays its status and its length. The top most entry displays the +state of worm 1, the second worm 2 and the third worm 3. When a worm +dies it's entry on the score board turns black. + +\begin{itemize} +\item \textbf{Len:} +Here the current length of the worm is displayed. When a worm is eating +food it grows by one pixel for each step it moves. + +\item \textbf{Hungry:} +That's the normal state of a worm. Worms are always +hungry and want to eat. It's good to have a hungry +worm since it means that your worm is alive. But it's +better to get your worm growing. + +\item \textbf{Growing:} +When a worm has eaten a piece of food it starts growing. For each step +it moves over food it can grow by one pixel. One piece of food lasts +for 7 steps. After your worm has moved 7 steps the food is used up. If +another piece of food is eaten while growing it will increase the size +of the worm for another 7 steps. + +\item \textbf{Crashed:} +This indicates that a worm has crashed against a wall. + +\item \textbf{Argh:} +If the score board entry displays ``Argh!'' it +means the worm is dead because it tried to eat an ``argh''. Until we +can make the worm say ``Argh!'' it's your job to say ``Argh!'' aloud. + +\item \textbf{Wormed:} +The worm tried to eat another worm or even itself. +That's why it's dead now. Making traps for other players with a worm is a good way to get them out of the game. +\end{itemize} + + +\subsubsection{Hints} + +\begin{itemize} + +\item Initially you will be busy with controlling your worm. Try to +avoid other worms and crawl far away from them. Wait until they curl up +themselves and collect the food afterwards. Don't worry if the other worms grow longer than yours {}- you can catch up after they've died. + +\item When you are more experienced watch the tactics of other worms. +Those worms controlled by artificial stupidity head straight for the +nearest piece of food. Let the other worm have its next piece of food +and head for the food it would probably want next. Try to put yourself +between the opponent and that food. From now on you can 'control' the other worm by blocking it. You could trap it by making a 1 pixel wide U{}-turn. You also could move from food to food and make sure you keep between your opponent and +the food. So you can always reach it before your opponent. + +\item While playing the game the Jukebox can still play music. For +single player game use any music you like. For berserk games with 2 players use hard rock and for 3 player games use heavy metal or X{}-Phobie +(\url{http://www.x-phobie.de/}). +Play fair and don't kick your opponent in the toe or +poke him in the eye. That would be bad manners. +\end{itemize} + |