manual/plugins/main.tex

   1 % $Id$ %
   2 \chapter{Plugins}\label{ref:plugins}
   3 \opt{mpiohd200}{%
   4 \fixme{The manual for MPIO HD200 is incomplete. Keymap definitions for plugins are missing.}\\
   5
   6 }
   7 Plugins are programs that Rockbox can load and run. Only one plugin can
   8 be loaded at a time. Plugins have exclusive control over the user interface.
   9 This means you cannot switch back and forth between a plugin and Rockbox. When
  10 a plugin is loaded, you need to exit it to return to the Rockbox interface.
  11 Most plugins will not interfere with music playback but some of them will stop
  12 playback while running. Plugins have the file extension \fname{.rock}. Most of
  13 them can be started from \setting{Browse Plugins} in the \setting{Main Menu}.\\
  14
  15 Viewer plugins get started automatically by opening an associated file (i.e.
  16 text files%
  17 \opt{lcd_bitmap}{, chip8 games}%
  18 ), or from the \setting{Open with} option on the \setting{Context Menu}.
  19
  20 \section{Games}
  21 \opt{lcd_bitmap}
  22     {See also the Chip{}-8 emulator in \reference{ref:Chip8emulator}
  23     \opt{archosrecorder,archosfmrecorder,iriverh100,iaudiom5,lcd_color}
  24     {and Rockboy in \reference{ref:Rockboy}}.}
  25
  26 \opt{lcd_bitmap}{\input{plugins/blackjack.tex}}
  27
  28 \opt{lcd_bitmap}{\input{plugins/brickmania.tex}}
  29
  30 \opt{lcd_bitmap}{\input{plugins/bubbles.tex}}
  31
  32 \opt{lcd_bitmap}{\input{plugins/chessbox.tex}}
  33
  34 \opt{lcd_color}{\input{plugins/clix.tex}}
  35
  36 \opt{lcd_bitmap}{\input{plugins/chopper.tex}}
  37
  38 \opt{lcd_color}{\input{plugins/codebuster.tex}}
  39
  40 {\input{plugins/dice.tex}}
  41
  42 \opt{swcodec}{\nopt{lowmem}{\input{plugins/doom.tex}}}
  43
  44 {\input{plugins/flipit.tex}}
  45
  46 \opt{lcd_bitmap}{\input{plugins/goban.tex}}
  47
  48 \opt{lcd_non-mono}{\nopt{iriverh10_5gb,ipodmini1g,sansac200,mpiohd200}{
  49   \input{plugins/invadrox.tex}}}
  50
  51 {\input{plugins/jackpot.tex}}
  52
  53 \opt{lcd_bitmap}{\input{plugins/jewels.tex}}
  54
  55 \opt{lcd_bitmap}{\input{plugins/mazezam.tex}}
  56
  57 \opt{lcd_bitmap}{\input{plugins/minesweeper.tex}}
  58
  59 \opt{archosplayer}{\input{plugins/nim.tex}}
  60
  61 \opt{iriverh100,iaudiom5,lcd_color}{\nopt{sansac200}{\input{plugins/pacbox.tex}}}
  62
  63 \opt{lcd_bitmap}{\input{plugins/pegbox.tex}}
  64
  65 \opt{lcd_bitmap}{\input{plugins/pong.tex}}
  66
  67 \opt{lcd_bitmap}{\input{plugins/reversi.tex}}
  68
  69 \opt{lcd_bitmap}{\input{plugins/robotfindskitten.tex}}
  70
  71 {\input{plugins/rockblox.tex}}
  72
  73 \opt{lcd_bitmap}{\input{plugins/rockblox1d.tex}}
  74
  75 \opt{lcd_bitmap}{\input{plugins/rocklife.tex}}
  76
  77 \opt{lcd_bitmap}{\input{plugins/sliding.tex}}
  78
  79 \opt{lcd_bitmap}{\input{plugins/snake.tex}}
  80
  81 \opt{lcd_bitmap}{\input{plugins/snake2.tex}}
  82
  83 \opt{lcd_bitmap}{\input{plugins/sokoban.tex}}
  84
  85 \opt{lcd_bitmap}{\input{plugins/solitaire.tex}}
  86
  87 \opt{lcd_bitmap}{\input{plugins/spacerocks.tex}}
  88
  89 \opt{lcd_bitmap}{\input{plugins/star.tex}}
  90
  91 \opt{lcd_bitmap}{\input{plugins/sudoku.tex}}
  92
  93 \opt{lcd_bitmap}{\input{plugins/wormlet.tex}}
  94
  95 \opt{lcd_bitmap}{\input{plugins/xobox.tex}}
  96
  97 \section{Demos}
  98
  99 \opt{lcd_bitmap}{\input{plugins/bounce.tex}}
 100
 101 {\input{plugins/credits.tex}}
 102
 103 {\input{plugins/cube.tex}}
 104
 105 \opt{lcd_bitmap}{\input{plugins/demystify.tex}}
 106
 107 \opt{lcd_bitmap}{\input{plugins/fire.tex}}
 108
 109 \opt{lcd_bitmap}{\input{plugins/fractals.tex}}
 110
 111 {\input{plugins/logo.tex}}
 112
 113 {\input{plugins/mosaic.tex}}
 114
 115 \opt{lcd_bitmap}{\input{plugins/oscilloscope.tex}}
 116
 117 \opt{tagcache}{\opt{lcd_bitmap}{\input{plugins/pictureflow.tex}}}
 118
 119 \opt{lcd_bitmap}{\input{plugins/plasma.tex}}
 120
 121 {\input{plugins/snow.tex}}
 122
 123 \opt{lcd_bitmap}{\input{plugins/starfield.tex}}
 124
 125 \opt{lcd_bitmap}{\input{plugins/vumeter.tex}}
 126
 127 \section{\label{ref:Viewersplugins}Viewers}
 128
 129 Viewers are plugins which are associated with specific file extensions.
 130 They cannot be run directly but are started by ``playing'' the associated file.
 131 Viewers are stored in the \fname{/.rockbox/rocks/viewers/} directory.
 132 \par
 133 \note{
 134 Some viewer plugins can only be used by selecting the \setting{Open With...}
 135 option from the \setting{Context Menu} (see \reference{ref:Contextmenu}).}
 136 \begin{table}
 137   \begin{rbtabular}{.92\textwidth}{Xlc}%
 138       {\textbf{Viewer Plugin}& \textbf{Associated filetype(s)} & \textbf{Context Menu only}}%
 139       {}{}
 140     Shortcuts             & \fname{.link}                    &   \\
 141     Chip-8 Emulator       & \fname{.ch8}                     &   \\
 142     Frotz                 & \fname{.z1 - .z8}                &   \\
 143     Image Viewer          & \fname{.bmp, .jpg, .jpeg, .png\opt{lcd_color}{, .ppm}}  &   \\
 144     Lua scripting language& \fname{.lua}                     &   \\
 145     \opt{swcodec}{\nopt{lowmem}{
 146         Midiplay          & \fname{.mid, .midi}              &   \\
 147         MPEG Player       & \fname{.mpg, .mpeg, .mpv, .m2v}  &   \\
 148     }}
 149     \opt{swcodec}{
 150         MP3 Encoder       & \fname{.wav}                     & x \\
 151     }
 152     \opt{masf}{
 153         \opt{lcd_bitmap}{
 154             Movie Player  & \fname{.rvf}                     &   \\
 155         }
 156     }
 157     \opt{lcd_bitmap}{
 158         \nopt{ondio}{% not enough buttons
 159             Rockboy       & \fname{.gb, .gbc}                &   \\
 160         }
 161     }
 162     Search                & \fname{.m3u, .m3u8}              & x \\
 163     Sort                  & \fname{.*}                       & x \\
 164     Text Viewer           & \fname{.txt,.nfo, .*}            &   \\
 165     VBRfix                & \fname{.mp3}                     & x \\
 166     \opt{masf}{
 167         Wavplay           & \fname{.wav}                     &   \\
 168     }
 169     ZXBox                 & \fname{.tap, .tax, .sna, .z80}   &   \\
 170     Shopping list         & \fname{.shopper}   &   \\
 171   \end{rbtabular}
 172 \end{table}
 173
 174 {\input{plugins/shortcuts.tex}}
 175
 176 \opt{lcd_bitmap}{\input{plugins/chip8emulator.tex}}
 177
 178 \opt{lcd_bitmap}{\input{plugins/frotz.tex}}
 179
 180 \opt{lcd_bitmap}{\input{plugins/imageviewer.tex}}
 181
 182 \opt{large_plugin_buffer}{\input{plugins/lua.tex}}
 183
 184 \opt{swcodec}{\nopt{lowmem}{\input{plugins/midiplay.tex}}}
 185
 186 \opt{archosrecorder,archosfmrecorder,ondio}{\input{plugins/movieplayer.tex}}
 187
 188 \opt{lcd_bitmap}{\opt{swcodec}{\nopt{lowmem}{\input{plugins/mpegplayer.tex}}}}
 189
 190 \opt{swcodec}{\nopt{lowmem}{\input{plugins/mp3_encoder.tex}}}
 191
 192
 193 \opt{archosrecorder,archosfmrecorder,ondio}{\input{plugins/rockbox_flash.tex}}
 194
 195 \opt{lcd_bitmap}{\nopt{%
 196   ONDIO_PAD%,m200, % not enough buttons for keymap
 197   ,ipod1g2g,ipod3g,ipod4g,ipodmini% horizontal pixelformat not implemented
 198   ,iaudiom3,mpiohd200, % vertical interleaved pixelformat not implemented
 199   ,mrobe100% lcd size/depth not implemented
 200   }{
 201   \input{plugins/rockboy.tex}}}
 202
 203 {\input{plugins/search.tex}}
 204
 205 {\input{plugins/shopper.tex}}
 206
 207 {\input{plugins/sort.tex}}
 208
 209 {\input{plugins/text_viewer.tex}}
 210
 211 {\input{plugins/theme_remove.tex}}
 212
 213 {\input{plugins/vbrfix.tex}}
 214
 215 \opt{archosrecorder,archosfmrecorder,ondio}{\input{plugins/wavplay.tex}}
 216
 217 \opt{lcd_bitmap}{\input{plugins/zxbox.tex}}
 218
 219 \section{Applications}
 220
 221 \opt{rtc}{\input{plugins/alarmclock.tex}}
 222
 223 \opt{archosplayer,archosrecorder,archosfmrecorder}{\input{plugins/alpinecdc.tex}}
 224
 225 {\input{plugins/batterybenchmark.tex}}
 226
 227 \opt{lcd_bitmap}{\input{plugins/calculator.tex}}
 228
 229 \opt{rtc}{\input{plugins/calendar.tex}}
 230
 231 {\input{plugins/chess_clock.tex}}
 232
 233 \opt{rtc}{\input{plugins/clock.tex}}
 234
 235 {\input{plugins/disktidy.tex}}
 236
 237 \opt{archosplayer}{\input{plugins/euro_converter.tex}}
 238
 239 \opt{archosrecorder,archosfmrecorder,ondio}{\input{plugins/firmware_flash.tex}}
 240
 241 {\input{plugins/keybox.tex}}
 242
 243 \opt{HAVE_BACKLIGHT}{\input{plugins/lamp.tex}}
 244
 245 \opt{lcd_bitmap}{\input{plugins/lrcplayer.tex}}
 246
 247 {\input{plugins/md5sum.tex}}
 248
 249 {\input{plugins/metronome.tex}}
 250
 251 \opt{swcodec}{\opt{recording_mic}{\input{plugins/pitch_detector.tex}}}
 252
 253 {\input{plugins/random_folder_advance_config.tex}}
 254
 255 {\input{plugins/resistor.tex}}
 256
 257 \opt{lcd_color}{\input{plugins/rockpaint.tex}}
 258
 259 \opt{archosrecorder,archosfmrecorder,ondio}{\input{plugins/split_editor.tex}}
 260
 261 {\input{plugins/stats.tex}}
 262
 263 {\input{plugins/stopwatch.tex}}
 264
 265 \opt{lcd_bitmap}{\input{plugins/text_editor.tex}}