summaryrefslogtreecommitdiff
path: root/manual/plugins
diff options
context:
space:
mode:
authorTomer Shalev <shalev.tomer@gmail.com>2009-12-10 19:56:53 +0000
committerTomer Shalev <shalev.tomer@gmail.com>2009-12-10 19:56:53 +0000
commit5e84f4a8c256d25ad9c786c32b4bd355e4a8d094 (patch)
treea2536d6405c1fa79be8367dc0dbfa55cb8e566ef /manual/plugins
parentf5c705264fc279acabd4deb19b74f70baf0f450e (diff)
downloadrockbox-5e84f4a8c256d25ad9c786c32b4bd355e4a8d094.zip
rockbox-5e84f4a8c256d25ad9c786c32b4bd355e4a8d094.tar.gz
rockbox-5e84f4a8c256d25ad9c786c32b4bd355e4a8d094.tar.bz2
rockbox-5e84f4a8c256d25ad9c786c32b4bd355e4a8d094.tar.xz
Manual: Apply dos2unix to replace CR+LF end-of-line with LF
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@23924 a1c6a512-1295-4272-9138-f99709370657
Diffstat (limited to 'manual/plugins')
-rw-r--r--manual/plugins/pegbox.tex232
-rw-r--r--manual/plugins/rockpaint.tex312
2 files changed, 272 insertions, 272 deletions
diff --git a/manual/plugins/pegbox.tex b/manual/plugins/pegbox.tex
index 13eb511..1f3db5f 100644
--- a/manual/plugins/pegbox.tex
+++ b/manual/plugins/pegbox.tex
@@ -1,116 +1,116 @@
-% $Id: pegbox.tex 16693 2008-03-18 09:24:35Z roolku $ %
-\subsection{Pegbox}
-\screenshot{plugins/images/ss-pegbox}{pegbox}{img:pegbox}
-To beat each level, you must destroy all of the pegs. If two like pegs are
-pushed into each other they disappear except for triangles which form a solid
-block and crosses which allow you to choose a replacement block.
-
-\begin{table}
- \begin{btnmap}{}{}
- \multicolumn{2}{c}{\textbf{In game}}\\\hline
-
- \opt{RECORDER_PAD}{\ButtonUp, \ButtonDown, }
- \opt{ONDIO_PAD}{\ButtonUp, \ButtonDown, }
- \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonUp, \ButtonDown, }
- \opt{IPOD_4G_PAD,IPOD_3G_PAD,IPOD_1G2G_PAD}{\ButtonMenu, \ButtonPlay, }
- \opt{IAUDIO_X5_PAD}{\ButtonUp, \ButtonDown, }
- \opt{IRIVER_H10_PAD}{\ButtonScrollUp, \ButtonScrollDown, }
- \opt{SANSA_E200_PAD}{\ButtonUp, \ButtonDown, }
- \opt{SANSA_FUZE_PAD}{\ButtonUp, \ButtonDown, }
- \opt{GIGABEAT_PAD}{\ButtonUp, \ButtonDown, }
- \opt{GIGABEAT_S_PAD}{\ButtonUp, \ButtonDown, }
- \opt{MROBE100_PAD}{\ButtonUp, \ButtonDown, }
- \opt{SANSA_C200_PAD}{\ButtonUp, \ButtonDown, }
-
- \opt{RECORDER_PAD}{\ButtonLeft, \ButtonRight}
- \opt{ONDIO_PAD}{\ButtonLeft, \ButtonRight}
- \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonLeft, \ButtonRight}
- \opt{IPOD_4G_PAD,IPOD_3G_PAD,IPOD_1G2G_PAD}{\ButtonLeft, \ButtonRight}
- \opt{IAUDIO_X5_PAD}{\ButtonLeft, \ButtonRight}
- \opt{IRIVER_H10_PAD}{\ButtonLeft, \ButtonRight}
- \opt{SANSA_E200_PAD}{\ButtonLeft, \ButtonRight}
- \opt{SANSA_FUZE_PAD}{\ButtonLeft, \ButtonRight}
- \opt{GIGABEAT_PAD}{\ButtonLeft, \ButtonRight}
- \opt{GIGABEAT_S_PAD}{\ButtonLeft, \ButtonRight}
- \opt{MROBE100_PAD}{\ButtonLeft, \ButtonRight}
- \opt{SANSA_C200_PAD}{\ButtonLeft, \ButtonRight}
-
- \opt{HAVEREMOTEKEYMAP}{& }
- & to move around\\
-
- \opt{RECORDER_PAD}{\ButtonOn}
- \opt{ONDIO_PAD}{\ButtonOff}
- \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonSelect}
- \opt{IPOD_4G_PAD,IPOD_3G_PAD,IPOD_1G2G_PAD}{\ButtonSelect + \ButtonRight}
- \opt{IAUDIO_X5_PAD}{\ButtonSelect}
- \opt{IRIVER_H10_PAD}{\ButtonPlay}
- \opt{SANSA_E200_PAD}{\ButtonSelect}
- \opt{SANSA_FUZE_PAD}{\ButtonSelect}
- \opt{GIGABEAT_PAD}{\ButtonSelect}
- \opt{GIGABEAT_S_PAD}{\ButtonSelect}
- \opt{MROBE100_PAD}{\ButtonSelect}
- \opt{SANSA_C200_PAD}{\ButtonSelect}
- \opt{HAVEREMOTEKEYMAP}{& }
- & to choose peg\\
-
- \opt{RECORDER_PAD}{\ButtonFTwo}
- \opt{ONDIO_PAD}{\ButtonMenu + \ButtonRight}
- \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOn}
- \opt{IPOD_4G_PAD,IPOD_3G_PAD,IPOD_1G2G_PAD}{\ButtonSelect + \ButtonLeft}
- \opt{IAUDIO_X5_PAD}{\ButtonRec}
- \opt{IRIVER_H10_PAD}{Long \ButtonFF}
- \opt{SANSA_E200_PAD}{\ButtonRec}
- \opt{SANSA_FUZE_PAD}{\ButtonSelect+\ButtonLeft}
- \opt{GIGABEAT_PAD}{\ButtonA}
- \opt{GIGABEAT_S_PAD}{\ButtonMenu}
- \opt{MROBE100_PAD}{\ButtonPlay}
- \opt{SANSA_C200_PAD}{\ButtonRec}
- \opt{HAVEREMOTEKEYMAP}{& }
- & to restart level\\
-
- \opt{RECORDER_PAD}{\ButtonFOne}
- \opt{ONDIO_PAD}{\ButtonMenu + \ButtonUp}
- \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonMode}
- \opt{IPOD_4G_PAD,IPOD_3G_PAD,IPOD_1G2G_PAD}{\ButtonSelect + \ButtonMenu}
- \opt{IAUDIO_X5_PAD}{\ButtonPlay}
- \opt{IRIVER_H10_PAD}{\ButtonFF + \ButtonScrollUp}
- \opt{SANSA_E200_PAD}{\ButtonScrollBack}
- \opt{SANSA_E200_PAD}{\ButtonSelect+\ButtonUp}
- \opt{GIGABEAT_PAD}{\ButtonVolUp}
- \opt{GIGABEAT_S_PAD}{\ButtonVolUp}
- \opt{MROBE100_PAD}{\ButtonMenu}
- \opt{SANSA_C200_PAD}{\ButtonVolUp}
- \opt{HAVEREMOTEKEYMAP}{& }
- & to go up a level\\
-
- \nopt{IPOD_4G_PAD,IPOD_3G_PAD,IPOD_1G2G_PAD,IAUDIO_X5_PAD}{
- \opt{RECORDER_PAD}{\ButtonFThree}
- \opt{ONDIO_PAD}{\ButtonMenu + \ButtonDown}
- \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonRec}
- \opt{IRIVER_H10_PAD}{\ButtonFF + \ButtonScrollDown}
- \opt{SANSA_E200_PAD}{\ButtonScrollFwd}
- \opt{SANSA_FUZE_PAD}{\ButtonSelect+\ButtonDown}
- \opt{SANSA_C200_PAD,GIGABEAT_PAD,GIGABEAT_S_PAD}{\ButtonVolDown}
- \opt{MROBE100_PAD}{\ButtonDisplay}
- \opt{HAVEREMOTEKEYMAP}{& }
- & to go down a level\\
- }
-
- \opt{RECORDER_PAD}{\ButtonOff}
- \opt{ONDIO_PAD}{\ButtonMenu + \ButtonOff}
- \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOff}
- \opt{IPOD_4G_PAD,IPOD_3G_PAD,IPOD_1G2G_PAD}{\ButtonSelect + \ButtonPlay}
- \opt{IAUDIO_X5_PAD}{\ButtonPower}
- \opt{IRIVER_H10_PAD}{\ButtonPower}
- \opt{SANSA_E200_PAD}{\ButtonPower}
- \opt{SANSA_FUZE_PAD}{Long \ButtonHome}
- \opt{GIGABEAT_PAD}{\ButtonPower}
- \opt{GIGABEAT_S_PAD}{\ButtonBack}
- \opt{MROBE100_PAD}{\ButtonPower}
- \opt{SANSA_C200_PAD}{\ButtonPower}
- \opt{HAVEREMOTEKEYMAP}{& }
- & to quit\\
-
- \end{btnmap}
-\end{table}
-
+% $Id: pegbox.tex 16693 2008-03-18 09:24:35Z roolku $ %
+\subsection{Pegbox}
+\screenshot{plugins/images/ss-pegbox}{pegbox}{img:pegbox}
+To beat each level, you must destroy all of the pegs. If two like pegs are
+pushed into each other they disappear except for triangles which form a solid
+block and crosses which allow you to choose a replacement block.
+
+\begin{table}
+ \begin{btnmap}{}{}
+ \multicolumn{2}{c}{\textbf{In game}}\\\hline
+
+ \opt{RECORDER_PAD}{\ButtonUp, \ButtonDown, }
+ \opt{ONDIO_PAD}{\ButtonUp, \ButtonDown, }
+ \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonUp, \ButtonDown, }
+ \opt{IPOD_4G_PAD,IPOD_3G_PAD,IPOD_1G2G_PAD}{\ButtonMenu, \ButtonPlay, }
+ \opt{IAUDIO_X5_PAD}{\ButtonUp, \ButtonDown, }
+ \opt{IRIVER_H10_PAD}{\ButtonScrollUp, \ButtonScrollDown, }
+ \opt{SANSA_E200_PAD}{\ButtonUp, \ButtonDown, }
+ \opt{SANSA_FUZE_PAD}{\ButtonUp, \ButtonDown, }
+ \opt{GIGABEAT_PAD}{\ButtonUp, \ButtonDown, }
+ \opt{GIGABEAT_S_PAD}{\ButtonUp, \ButtonDown, }
+ \opt{MROBE100_PAD}{\ButtonUp, \ButtonDown, }
+ \opt{SANSA_C200_PAD}{\ButtonUp, \ButtonDown, }
+
+ \opt{RECORDER_PAD}{\ButtonLeft, \ButtonRight}
+ \opt{ONDIO_PAD}{\ButtonLeft, \ButtonRight}
+ \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonLeft, \ButtonRight}
+ \opt{IPOD_4G_PAD,IPOD_3G_PAD,IPOD_1G2G_PAD}{\ButtonLeft, \ButtonRight}
+ \opt{IAUDIO_X5_PAD}{\ButtonLeft, \ButtonRight}
+ \opt{IRIVER_H10_PAD}{\ButtonLeft, \ButtonRight}
+ \opt{SANSA_E200_PAD}{\ButtonLeft, \ButtonRight}
+ \opt{SANSA_FUZE_PAD}{\ButtonLeft, \ButtonRight}
+ \opt{GIGABEAT_PAD}{\ButtonLeft, \ButtonRight}
+ \opt{GIGABEAT_S_PAD}{\ButtonLeft, \ButtonRight}
+ \opt{MROBE100_PAD}{\ButtonLeft, \ButtonRight}
+ \opt{SANSA_C200_PAD}{\ButtonLeft, \ButtonRight}
+
+ \opt{HAVEREMOTEKEYMAP}{& }
+ & to move around\\
+
+ \opt{RECORDER_PAD}{\ButtonOn}
+ \opt{ONDIO_PAD}{\ButtonOff}
+ \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonSelect}
+ \opt{IPOD_4G_PAD,IPOD_3G_PAD,IPOD_1G2G_PAD}{\ButtonSelect + \ButtonRight}
+ \opt{IAUDIO_X5_PAD}{\ButtonSelect}
+ \opt{IRIVER_H10_PAD}{\ButtonPlay}
+ \opt{SANSA_E200_PAD}{\ButtonSelect}
+ \opt{SANSA_FUZE_PAD}{\ButtonSelect}
+ \opt{GIGABEAT_PAD}{\ButtonSelect}
+ \opt{GIGABEAT_S_PAD}{\ButtonSelect}
+ \opt{MROBE100_PAD}{\ButtonSelect}
+ \opt{SANSA_C200_PAD}{\ButtonSelect}
+ \opt{HAVEREMOTEKEYMAP}{& }
+ & to choose peg\\
+
+ \opt{RECORDER_PAD}{\ButtonFTwo}
+ \opt{ONDIO_PAD}{\ButtonMenu + \ButtonRight}
+ \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOn}
+ \opt{IPOD_4G_PAD,IPOD_3G_PAD,IPOD_1G2G_PAD}{\ButtonSelect + \ButtonLeft}
+ \opt{IAUDIO_X5_PAD}{\ButtonRec}
+ \opt{IRIVER_H10_PAD}{Long \ButtonFF}
+ \opt{SANSA_E200_PAD}{\ButtonRec}
+ \opt{SANSA_FUZE_PAD}{\ButtonSelect+\ButtonLeft}
+ \opt{GIGABEAT_PAD}{\ButtonA}
+ \opt{GIGABEAT_S_PAD}{\ButtonMenu}
+ \opt{MROBE100_PAD}{\ButtonPlay}
+ \opt{SANSA_C200_PAD}{\ButtonRec}
+ \opt{HAVEREMOTEKEYMAP}{& }
+ & to restart level\\
+
+ \opt{RECORDER_PAD}{\ButtonFOne}
+ \opt{ONDIO_PAD}{\ButtonMenu + \ButtonUp}
+ \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonMode}
+ \opt{IPOD_4G_PAD,IPOD_3G_PAD,IPOD_1G2G_PAD}{\ButtonSelect + \ButtonMenu}
+ \opt{IAUDIO_X5_PAD}{\ButtonPlay}
+ \opt{IRIVER_H10_PAD}{\ButtonFF + \ButtonScrollUp}
+ \opt{SANSA_E200_PAD}{\ButtonScrollBack}
+ \opt{SANSA_E200_PAD}{\ButtonSelect+\ButtonUp}
+ \opt{GIGABEAT_PAD}{\ButtonVolUp}
+ \opt{GIGABEAT_S_PAD}{\ButtonVolUp}
+ \opt{MROBE100_PAD}{\ButtonMenu}
+ \opt{SANSA_C200_PAD}{\ButtonVolUp}
+ \opt{HAVEREMOTEKEYMAP}{& }
+ & to go up a level\\
+
+ \nopt{IPOD_4G_PAD,IPOD_3G_PAD,IPOD_1G2G_PAD,IAUDIO_X5_PAD}{
+ \opt{RECORDER_PAD}{\ButtonFThree}
+ \opt{ONDIO_PAD}{\ButtonMenu + \ButtonDown}
+ \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonRec}
+ \opt{IRIVER_H10_PAD}{\ButtonFF + \ButtonScrollDown}
+ \opt{SANSA_E200_PAD}{\ButtonScrollFwd}
+ \opt{SANSA_FUZE_PAD}{\ButtonSelect+\ButtonDown}
+ \opt{SANSA_C200_PAD,GIGABEAT_PAD,GIGABEAT_S_PAD}{\ButtonVolDown}
+ \opt{MROBE100_PAD}{\ButtonDisplay}
+ \opt{HAVEREMOTEKEYMAP}{& }
+ & to go down a level\\
+ }
+
+ \opt{RECORDER_PAD}{\ButtonOff}
+ \opt{ONDIO_PAD}{\ButtonMenu + \ButtonOff}
+ \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOff}
+ \opt{IPOD_4G_PAD,IPOD_3G_PAD,IPOD_1G2G_PAD}{\ButtonSelect + \ButtonPlay}
+ \opt{IAUDIO_X5_PAD}{\ButtonPower}
+ \opt{IRIVER_H10_PAD}{\ButtonPower}
+ \opt{SANSA_E200_PAD}{\ButtonPower}
+ \opt{SANSA_FUZE_PAD}{Long \ButtonHome}
+ \opt{GIGABEAT_PAD}{\ButtonPower}
+ \opt{GIGABEAT_S_PAD}{\ButtonBack}
+ \opt{MROBE100_PAD}{\ButtonPower}
+ \opt{SANSA_C200_PAD}{\ButtonPower}
+ \opt{HAVEREMOTEKEYMAP}{& }
+ & to quit\\
+
+ \end{btnmap}
+\end{table}
+
diff --git a/manual/plugins/rockpaint.tex b/manual/plugins/rockpaint.tex
index 63440fc..b583769 100644
--- a/manual/plugins/rockpaint.tex
+++ b/manual/plugins/rockpaint.tex
@@ -1,156 +1,156 @@
-% $Id$ %
-\subsection{Rockpaint}
-\screenshot{plugins/images/ss-rockpaint}{Rockpaint}%
-{img:Rockpaint}
-Rockpaint is a bitmap (\fname{.bmp}) editor for Rockbox. It can open any \fname{.bmp} file
-whose dimensions are the same size as your device's screen or smaller; it can
-also create empty bitmaps for you to work with.\\
-
-\subsubsection{Opening A File}
-To open a file, you may use either the context menu option "Open With" in the
-File Browser, or you may enter Rockpaint first using the Plugins menu and open
-a file from there. To perform the latter, simply press Rockpaint's Menu button
-or move the cursor beyond the bottom of the screen; then move the cursor onto
-"Menu" and select it. Finally, select "Load" and navigate to the image you
-wish to open.\\
-
-\subsubsection{Tools}
-Rockpaint offers several tools to aid you in editing; you can view them by
-either pressing Rockpaint's "Menu" key or by attempting to move the cursor
-beyond the bottom of the screen. From top to bottom and left to right, and
-by section, they are as follows:
-\begin{description}
- \item[Colour Picker]
- The top left tool shows your colours that are at the ready. To
- swap them, "click" on the background colour. To edit the foreground colour,
- click on it.
- \item[Preset Pallete]
- Several preset colours are availible. Clicking on one changes
- the foreground of the Colour Picker to the selected colour.
- \item[Pencil]
- Draws as you move the cursor. You can change the brush size with the
- Menu option "Brush Size". Use the Select key to toggle the tool while editing
- the image.
- \item[Selection tool]
- Allows you to select a rectangular region; once you do, you
- will be shown a menu of options (including "cancel" if you make a mistake).
- \item[Line tool]
- Draws a straight line.
- \item[Curve tool]
- Allows you to draw a line and curve it.
- \item[Rectangle tool]
- Draws an unfilled rectangle.
- \item[Circle tool]
- Draws an unfilled circle.
- \item[Gradient fill]
- To use this tool, click at the starting and ending points.
- Starting with the background and going to the foreground colour, Rockpaint
- will fill the region with a gradual colour change.
- \item[Bucket fill]
- Fills an same-colour or empty region with a colour.
- \item[Dropper]
- Click on a colour in the image to change the foreground colour to it.
- \item[Eraser]
- The opposite of the pencil; it changes painted pixels to white.
- \item[Text tool]
- "Draws" text on the image.
- \item[Filled rectangle]
- Same as the Rectangle tool, but fills it with colour.
- \item[Filled circle]
- Same as the Circle tool, but fills it with colour.
- \item[Curved Gradient Fill]
- Same as Gradient fill, but you must draw two lines.
- Rockpaint will draw a curved, gradual change of colour in the region.
- \item[Menu]
- This opens the Main Menu. You can also press the Menu key to open it.
-\end{description}
-
-\subsubsection{Main Menu}
-The main menu consists of the following:
-\begin{description}
- \item[Resume]
- Closes the Main Menu.
- \item[New]
- Creates a new canvas and discards the current file. BE CAREFUL.
- You will lose any unsaved changes in the file that is currently open.
- \item[Load]
- Loads a bitmap file. Simply navigate to the file as you
- would in the file browser.
- \item[Save]
- Saves the current file. If it has not been saved before,
- you will be given a chance to name it and choose the saving location.
- \item[Brush speed]
- Changes the speed at which the selection cursor
- moves when you hold down a movement button.
- \item[Brush size]
- Allows you to adjust the drawing size of the pencil tool.
- \item[Choose colour]
- Allows you to manually edit the foreground colour.
- You can edit the RBG and/or the HSV values.
- \item[Grid size]
- Allows you to show or hide a grid over the canvas,
- and to specify its size.
- \item[Exit]
- Exits Rockpaint.
-\end{description}
-
-\warn{BE CAREFUL. Rockpaint will NOT prompt you to save
-if you select Exit, so any unsaved changes will be lost.}
-
-\begin{table}
-\begin{btnmap}{}{}
- \nopt{IPOD_4G_PAD,IPOD_3G_PAD,IPOD_1G2G_PAD}{
- \nopt{IRIVER_H300_PAD,GIGABEAT_S_PAD,SANSA_FUZE_PAD}{\ButtonPower}
- \opt{IRIVER_H300_PAD}{\ButtonOff}
- \opt{GIGABEAT_S_PAD}{\ButtonBack}
- \opt{SANSA_FUZE_PAD}{Long \ButtonHome}
- \opt{HAVEREMOTEKEYMAP}{& }
- & Quits Rockpaint immediately.\\
- }
-
- \ButtonLeft
- \opt{HAVEREMOTEKEYMAP}{& }
- & Moves the cursor to the left.\\
-
- \ButtonRight
- \opt{HAVEREMOTEKEYMAP}{& }
- & Moves the cursor to the right.\\
-
- \nopt{IPOD_4G_PAD,IPOD_3G_PAD,IPOD_1G2G_PAD,IRIVER_H10_PAD}{\ButtonUp}
- \opt{IPOD_4G_PAD,IPOD_3G_PAD,IPOD_1G2G_PAD}{\ButtonMenu}
- \opt{IRIVER_H10_PAD}{\ButtonScrollUp}
- \opt{HAVEREMOTEKEYMAP}{& }
- & Moves the cursor up.\\
-
- \nopt{IPOD_4G_PAD,IPOD_3G_PAD,IPOD_1G2G_PAD,IRIVER_H10_PAD}{\ButtonDown}
- \opt{IPOD_4G_PAD,IPOD_3G_PAD,IPOD_1G2G_PAD}{\ButtonPlay}
- \opt{IRIVER_H10_PAD}{\ButtonScrollDown}
- \opt{HAVEREMOTEKEYMAP}{& }
- & Moves the cursor down.\\
-
- \opt{IRIVER_H300_PAD}{\ButtonOn}%
- \opt{IPOD_4G_PAD,IPOD_3G_PAD,IPOD_1G2G_PAD}{\ButtonSelect+\ButtonMenu}%
- \opt{SANSA_C200_PAD,SANSA_E200_PAD}{\ButtonSelect+\ButtonPower}%
- \opt{SANSA_FUZE_PAD}{\ButtonSelect+\ButtonDown}%
- \opt{IAUDIO_X5_PAD}{\ButtonPlay}%
- \opt{GIGABEAT_PAD,GIGABEAT_S_PAD}{\ButtonMenu}%
- \opt{IRIVER_H10_PAD}{\ButtonPlay}%
- \opt{HAVEREMOTEKEYMAP}{& }
- & Displays the Main Menu.\\
-
- \opt{IRIVER_H300_PAD,IAUDIO_X5_PAD,SANSA_C200_PAD,SANSA_E200_PAD}{\ButtonRec}
- \opt{SANSA_FUZE_PAD}{\ButtonSelect+\ButtonLeft}
- \opt{IPOD_4G_PAD,IPOD_3G_PAD,IPOD_1G2G_PAD}{\ButtonMenu+\ButtonLeft}
- \opt{GIGABEAT_PAD}{\ButtonA}
- \opt{IRIVER_H10_PAD}{\ButtonRew}
- \opt{GIGABEAT_S_PAD}{\ButtonPlay}
- \opt{HAVEREMOTEKEYMAP}{& }
- & Displays the toolbar.\\
-
- \nopt{IRIVER_H10_PAD}{\ButtonSelect}%
- \opt{IRIVER_H10_PAD}{\ButtonFF}%
- \opt{HAVEREMOTEKEYMAP}{& }
- & Toggles the brush and selects objects.\\
-
- \end{btnmap}
-\end{table}
+% $Id$ %
+\subsection{Rockpaint}
+\screenshot{plugins/images/ss-rockpaint}{Rockpaint}%
+{img:Rockpaint}
+Rockpaint is a bitmap (\fname{.bmp}) editor for Rockbox. It can open any \fname{.bmp} file
+whose dimensions are the same size as your device's screen or smaller; it can
+also create empty bitmaps for you to work with.\\
+
+\subsubsection{Opening A File}
+To open a file, you may use either the context menu option "Open With" in the
+File Browser, or you may enter Rockpaint first using the Plugins menu and open
+a file from there. To perform the latter, simply press Rockpaint's Menu button
+or move the cursor beyond the bottom of the screen; then move the cursor onto
+"Menu" and select it. Finally, select "Load" and navigate to the image you
+wish to open.\\
+
+\subsubsection{Tools}
+Rockpaint offers several tools to aid you in editing; you can view them by
+either pressing Rockpaint's "Menu" key or by attempting to move the cursor
+beyond the bottom of the screen. From top to bottom and left to right, and
+by section, they are as follows:
+\begin{description}
+ \item[Colour Picker]
+ The top left tool shows your colours that are at the ready. To
+ swap them, "click" on the background colour. To edit the foreground colour,
+ click on it.
+ \item[Preset Pallete]
+ Several preset colours are availible. Clicking on one changes
+ the foreground of the Colour Picker to the selected colour.
+ \item[Pencil]
+ Draws as you move the cursor. You can change the brush size with the
+ Menu option "Brush Size". Use the Select key to toggle the tool while editing
+ the image.
+ \item[Selection tool]
+ Allows you to select a rectangular region; once you do, you
+ will be shown a menu of options (including "cancel" if you make a mistake).
+ \item[Line tool]
+ Draws a straight line.
+ \item[Curve tool]
+ Allows you to draw a line and curve it.
+ \item[Rectangle tool]
+ Draws an unfilled rectangle.
+ \item[Circle tool]
+ Draws an unfilled circle.
+ \item[Gradient fill]
+ To use this tool, click at the starting and ending points.
+ Starting with the background and going to the foreground colour, Rockpaint
+ will fill the region with a gradual colour change.
+ \item[Bucket fill]
+ Fills an same-colour or empty region with a colour.
+ \item[Dropper]
+ Click on a colour in the image to change the foreground colour to it.
+ \item[Eraser]
+ The opposite of the pencil; it changes painted pixels to white.
+ \item[Text tool]
+ "Draws" text on the image.
+ \item[Filled rectangle]
+ Same as the Rectangle tool, but fills it with colour.
+ \item[Filled circle]
+ Same as the Circle tool, but fills it with colour.
+ \item[Curved Gradient Fill]
+ Same as Gradient fill, but you must draw two lines.
+ Rockpaint will draw a curved, gradual change of colour in the region.
+ \item[Menu]
+ This opens the Main Menu. You can also press the Menu key to open it.
+\end{description}
+
+\subsubsection{Main Menu}
+The main menu consists of the following:
+\begin{description}
+ \item[Resume]
+ Closes the Main Menu.
+ \item[New]
+ Creates a new canvas and discards the current file. BE CAREFUL.
+ You will lose any unsaved changes in the file that is currently open.
+ \item[Load]
+ Loads a bitmap file. Simply navigate to the file as you
+ would in the file browser.
+ \item[Save]
+ Saves the current file. If it has not been saved before,
+ you will be given a chance to name it and choose the saving location.
+ \item[Brush speed]
+ Changes the speed at which the selection cursor
+ moves when you hold down a movement button.
+ \item[Brush size]
+ Allows you to adjust the drawing size of the pencil tool.
+ \item[Choose colour]
+ Allows you to manually edit the foreground colour.
+ You can edit the RBG and/or the HSV values.
+ \item[Grid size]
+ Allows you to show or hide a grid over the canvas,
+ and to specify its size.
+ \item[Exit]
+ Exits Rockpaint.
+\end{description}
+
+\warn{BE CAREFUL. Rockpaint will NOT prompt you to save
+if you select Exit, so any unsaved changes will be lost.}
+
+\begin{table}
+\begin{btnmap}{}{}
+ \nopt{IPOD_4G_PAD,IPOD_3G_PAD,IPOD_1G2G_PAD}{
+ \nopt{IRIVER_H300_PAD,GIGABEAT_S_PAD,SANSA_FUZE_PAD}{\ButtonPower}
+ \opt{IRIVER_H300_PAD}{\ButtonOff}
+ \opt{GIGABEAT_S_PAD}{\ButtonBack}
+ \opt{SANSA_FUZE_PAD}{Long \ButtonHome}
+ \opt{HAVEREMOTEKEYMAP}{& }
+ & Quits Rockpaint immediately.\\
+ }
+
+ \ButtonLeft
+ \opt{HAVEREMOTEKEYMAP}{& }
+ & Moves the cursor to the left.\\
+
+ \ButtonRight
+ \opt{HAVEREMOTEKEYMAP}{& }
+ & Moves the cursor to the right.\\
+
+ \nopt{IPOD_4G_PAD,IPOD_3G_PAD,IPOD_1G2G_PAD,IRIVER_H10_PAD}{\ButtonUp}
+ \opt{IPOD_4G_PAD,IPOD_3G_PAD,IPOD_1G2G_PAD}{\ButtonMenu}
+ \opt{IRIVER_H10_PAD}{\ButtonScrollUp}
+ \opt{HAVEREMOTEKEYMAP}{& }
+ & Moves the cursor up.\\
+
+ \nopt{IPOD_4G_PAD,IPOD_3G_PAD,IPOD_1G2G_PAD,IRIVER_H10_PAD}{\ButtonDown}
+ \opt{IPOD_4G_PAD,IPOD_3G_PAD,IPOD_1G2G_PAD}{\ButtonPlay}
+ \opt{IRIVER_H10_PAD}{\ButtonScrollDown}
+ \opt{HAVEREMOTEKEYMAP}{& }
+ & Moves the cursor down.\\
+
+ \opt{IRIVER_H300_PAD}{\ButtonOn}%
+ \opt{IPOD_4G_PAD,IPOD_3G_PAD,IPOD_1G2G_PAD}{\ButtonSelect+\ButtonMenu}%
+ \opt{SANSA_C200_PAD,SANSA_E200_PAD}{\ButtonSelect+\ButtonPower}%
+ \opt{SANSA_FUZE_PAD}{\ButtonSelect+\ButtonDown}%
+ \opt{IAUDIO_X5_PAD}{\ButtonPlay}%
+ \opt{GIGABEAT_PAD,GIGABEAT_S_PAD}{\ButtonMenu}%
+ \opt{IRIVER_H10_PAD}{\ButtonPlay}%
+ \opt{HAVEREMOTEKEYMAP}{& }
+ & Displays the Main Menu.\\
+
+ \opt{IRIVER_H300_PAD,IAUDIO_X5_PAD,SANSA_C200_PAD,SANSA_E200_PAD}{\ButtonRec}
+ \opt{SANSA_FUZE_PAD}{\ButtonSelect+\ButtonLeft}
+ \opt{IPOD_4G_PAD,IPOD_3G_PAD,IPOD_1G2G_PAD}{\ButtonMenu+\ButtonLeft}
+ \opt{GIGABEAT_PAD}{\ButtonA}
+ \opt{IRIVER_H10_PAD}{\ButtonRew}
+ \opt{GIGABEAT_S_PAD}{\ButtonPlay}
+ \opt{HAVEREMOTEKEYMAP}{& }
+ & Displays the toolbar.\\
+
+ \nopt{IRIVER_H10_PAD}{\ButtonSelect}%
+ \opt{IRIVER_H10_PAD}{\ButtonFF}%
+ \opt{HAVEREMOTEKEYMAP}{& }
+ & Toggles the brush and selects objects.\\
+
+ \end{btnmap}
+\end{table}