Theme Editor: Implemented document load functionality
[kugel-rb.git] / manual / plugins / main.tex
blobc18d9ccbb798769bdb79ec42d1a3cdb7db072dfe
1 % $Id$ %
2 \chapter{Plugins}\label{ref:plugins}
3 Plugins are programs that Rockbox can load and run. Only one plugin can
4 be loaded at a time. Plugins have exclusive control over the user interface.
5 This means you cannot switch back and forth between a plugin and Rockbox. When
6 a plugin is loaded, you need to exit it to return to the Rockbox interface.
7 Most plugins will not interfere with music playback but some of them will stop
8 playback while running. Plugins have the file extension \fname{.rock}. Most of
9 them can be started from \setting{Browse Plugins} in the \setting{Main Menu}.\\
11 Viewer plugins get started automatically by opening an associated file (i.e.
12 text files%
13 \opt{lcd_bitmap}{, chip8 games}%
14 ), or from the \setting{Open with} option on the \setting{Context Menu}.
16 \section{Games}
17 \opt{lcd_bitmap}
18 {See also the Chip{}-8 emulator in \reference{ref:Chip8emulator}
19 \opt{archosrecorder,archosfmrecorder,iriverh100,iaudiom5,lcd_color}
20 {and Rockboy in \reference{ref:Rockboy}}.}
22 \opt{lcd_bitmap}{\input{plugins/blackjack.tex}}
24 \opt{lcd_bitmap}{\input{plugins/brickmania.tex}}
26 \opt{lcd_bitmap}{\input{plugins/bubbles.tex}}
28 \opt{lcd_bitmap}{\input{plugins/chessbox.tex}}
30 \opt{lcd_color}{\input{plugins/clix.tex}}
32 \opt{lcd_bitmap}{\input{plugins/chopper.tex}}
34 \opt{lcd_color}{\input{plugins/codebuster.tex}}
36 {\input{plugins/dice.tex}}
38 \opt{swcodec}{\input{plugins/doom.tex}}
40 {\input{plugins/flipit.tex}}
42 \opt{lcd_bitmap}{\input{plugins/goban.tex}}
44 \opt{lcd_non-mono}{\nopt{iriverh10_5gb,ipodmini1g,sansac200}{
45 \input{plugins/invadrox.tex}}}
47 {\input{plugins/jackpot.tex}}
49 \opt{lcd_bitmap}{\input{plugins/jewels.tex}}
51 \opt{lcd_bitmap}{\input{plugins/mazezam.tex}}
53 \opt{lcd_bitmap}{\input{plugins/minesweeper.tex}}
55 \opt{archosplayer}{\input{plugins/nim.tex}}
57 \opt{iriverh100,iaudiom5,lcd_color}{\nopt{sansac200}{\input{plugins/pacbox.tex}}}
59 \opt{lcd_bitmap}{\input{plugins/pegbox.tex}}
61 \opt{lcd_bitmap}{\input{plugins/pong.tex}}
63 \opt{lcd_bitmap}{\input{plugins/reversi.tex}}
65 \opt{lcd_bitmap}{\input{plugins/robotfindskitten.tex}}
67 {\input{plugins/rockblox.tex}}
69 \opt{lcd_bitmap}{\input{plugins/rockblox1d.tex}}
71 \opt{lcd_bitmap}{\input{plugins/rocklife.tex}}
73 \opt{lcd_bitmap}{\input{plugins/sliding.tex}}
75 \opt{lcd_bitmap}{\input{plugins/snake.tex}}
77 \opt{lcd_bitmap}{\input{plugins/snake2.tex}}
79 \opt{lcd_bitmap}{\input{plugins/sokoban.tex}}
81 \opt{lcd_bitmap}{\input{plugins/solitaire.tex}}
83 \opt{lcd_bitmap}{\input{plugins/spacerocks.tex}}
85 \opt{lcd_bitmap}{\input{plugins/star.tex}}
87 \opt{lcd_bitmap}{\input{plugins/sudoku.tex}}
89 \opt{lcd_bitmap}{\input{plugins/wormlet.tex}}
91 \opt{lcd_bitmap}{\input{plugins/xobox.tex}}
93 \section{Demos}
95 \opt{lcd_bitmap}{\input{plugins/bounce.tex}}
97 {\input{plugins/credits.tex}}
99 {\input{plugins/cube.tex}}
101 \opt{lcd_bitmap}{\input{plugins/demystify.tex}}
103 \opt{lcd_bitmap}{\input{plugins/fire.tex}}
105 \opt{lcd_bitmap}{\input{plugins/fractals.tex}}
107 {\input{plugins/logo.tex}}
109 {\input{plugins/mosaic.tex}}
111 \opt{lcd_bitmap}{\input{plugins/oscilloscope.tex}}
113 \opt{tagcache}{\opt{lcd_bitmap}{\input{plugins/pictureflow.tex}}}
115 \opt{lcd_bitmap}{\input{plugins/plasma.tex}}
117 {\input{plugins/snow.tex}}
119 \opt{lcd_bitmap}{\input{plugins/starfield.tex}}
121 \opt{lcd_bitmap}{\input{plugins/vumeter.tex}}
123 \section{\label{ref:Viewersplugins}Viewers}
125 Viewers are plugins which are associated with specific file extensions.
126 They cannot be run directly but are started by ``playing'' the associated file.
127 Viewers are stored in the \fname{/.rockbox/rocks/viewers/} directory.
128 \par
129 \note{
130 Some viewer plugins can only be used by selecting the \setting{Open With...}
131 option from the \setting{Context Menu} (see \reference{ref:Contextmenu}).}
132 \begin{table}
133 \begin{rbtabular}{.92\textwidth}{Xlc}%
134 {\textbf{Viewer Plugin}& \textbf{Associated filetype(s)} & \textbf{Context Menu only}}%
135 {}{}
136 BMP Viewer & \fname{.bmp} & \\
137 Shortcuts & \fname{.link} & \\
138 Chip-8 Emulator & \fname{.ch8} & \\
139 Frotz & \fname{.z1 - .z8} & \\
140 JPEG Viewer & \fname{.jpg, .jpeg} & \\
141 Lua scripting language& \fname{.lua} & \\
142 \opt{swcodec}{
143 Midiplay & \fname{.mid, .midi} & \\
144 MPEG Player & \fname{.mpg, .mpeg, .mpv, .m2v} & \\
146 \opt{masf}{
147 \opt{lcd_bitmap}{
148 Movie Player & \fname{.rvf} & \\
151 \opt{lcd_color}{
152 PNG viewer & \fname{.png} & \\
153 PPM viewer & \fname{.ppm} & \\
155 \opt{lcd_bitmap}{
156 \nopt{ondio}{% not enough buttons
157 Rockboy & \fname{.gb, .gbc} & \\
160 Search & \fname{.m3u, .m3u8} & x \\
161 Sort & \fname{.*} & x \\
162 Text Viewer & \fname{.txt,.nfo, .*} & \\
163 VBRfix & \fname{.mp3} & x \\
164 \opt{masf}{
165 Wavplay & \fname{.wav} & \\
167 ZXBox & \fname{.tap, .tax, .sna, .z80} & \\
168 \end{rbtabular}
169 \end{table}
171 {\input{plugins/shortcuts.tex}}
173 \opt{lcd_bitmap}{\input{plugins/bmpviewer.tex}}
175 \opt{lcd_bitmap}{\input{plugins/chip8emulator.tex}}
177 \opt{lcd_bitmap}{\input{plugins/frotz.tex}}
179 \opt{lcd_bitmap}{\input{plugins/jpegviewer.tex}}
181 \opt{large_plugin_buffer}{\input{plugins/lua.tex}}
183 \opt{swcodec}{\input{plugins/midiplay.tex}}
185 \opt{archosrecorder,archosfmrecorder,ondio}{\input{plugins/movieplayer.tex}}
187 \opt{lcd_bitmap}{\opt{swcodec}{\input{plugins/mpegplayer.tex}}}
189 \opt{lcd_bitmap}{\opt{lcd_color}{\input{plugins/pngviewer.tex}}}
191 \opt{lcd_color}{\input{plugins/ppmviewer.tex}}
193 \opt{archosrecorder,archosfmrecorder,ondio}{\input{plugins/rockbox_flash.tex}}
195 \opt{archosrecorder,archosfmrecorder,iriverh100,iaudiom5,lcd_color}{\input{plugins/rockboy.tex}}
197 {\input{plugins/search.tex}}
199 {\input{plugins/sort.tex}}
201 {\input{plugins/text_viewer.tex}}
203 {\input{plugins/theme_remove.tex}}
205 {\input{plugins/vbrfix.tex}}
207 \opt{archosrecorder,archosfmrecorder,ondio}{\input{plugins/wavplay.tex}}
209 \opt{lcd_bitmap}{\input{plugins/zxbox.tex}}
211 \section{Applications}
213 \opt{rtc}{\input{plugins/alarmclock.tex}}
215 \opt{archosplayer,archosrecorder,archosfmrecorder}{\input{plugins/alpinecdc.tex}}
217 {\input{plugins/batterybenchmark.tex}}
219 \opt{lcd_bitmap}{\input{plugins/calculator.tex}}
221 \opt{rtc}{\input{plugins/calendar.tex}}
223 {\input{plugins/chess_clock.tex}}
225 \opt{rtc}{\input{plugins/clock.tex}}
227 {\input{plugins/disktidy.tex}}
229 \opt{archosplayer}{\input{plugins/euro_converter.tex}}
231 \opt{archosrecorder,archosfmrecorder,ondio}{\input{plugins/firmware_flash.tex}}
233 {\input{plugins/keybox.tex}}
235 \opt{HAVE_BACKLIGHT}{\input{plugins/lamp.tex}}
237 \opt{lcd_bitmap}{\input{plugins/lrcplayer.tex}}
239 {\input{plugins/md5sum.tex}}
241 {\input{plugins/metronome.tex}}
243 \opt{swcodec}{\opt{recording_mic}{\input{plugins/pitch_detector.tex}}}
245 {\input{plugins/random_folder_advance_config.tex}}
247 \opt{lcd_color}{\input{plugins/rockpaint.tex}}
249 \opt{archosrecorder,archosfmrecorder,ondio}{\input{plugins/split_editor.tex}}
251 {\input{plugins/stats.tex}}
253 {\input{plugins/stopwatch.tex}}
255 \opt{lcd_bitmap}{\input{plugins/text_editor.tex}}