manual/plugins/main.tex

   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}.\\
  10
  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}.
  15
  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}}.}
  21
  22 \opt{lcd_bitmap}{\input{plugins/blackjack.tex}}
  23
  24 \opt{lcd_bitmap}{\input{plugins/brickmania.tex}}
  25
  26 \opt{lcd_bitmap}{\input{plugins/bubbles.tex}}
  27
  28 \opt{lcd_bitmap}{\input{plugins/chessbox.tex}}
  29
  30 \opt{lcd_color}{\input{plugins/clix.tex}}
  31
  32 \opt{lcd_bitmap}{\input{plugins/chopper.tex}}
  33
  34 \opt{lcd_color}{\input{plugins/codebuster.tex}}
  35
  36 {\input{plugins/dice.tex}}
  37
  38 \opt{swcodec}{\nopt{lowmem}{\input{plugins/doom.tex}}}
  39
  40 {\input{plugins/flipit.tex}}
  41
  42 \opt{lcd_bitmap}{\input{plugins/goban.tex}}
  43
  44 \opt{lcd_non-mono}{\nopt{iriverh10_5gb,ipodmini1g,sansac200}{
  45   \input{plugins/invadrox.tex}}}
  46
  47 {\input{plugins/jackpot.tex}}
  48
  49 \opt{lcd_bitmap}{\input{plugins/jewels.tex}}
  50
  51 \opt{lcd_bitmap}{\input{plugins/mazezam.tex}}
  52
  53 \opt{lcd_bitmap}{\input{plugins/minesweeper.tex}}
  54
  55 \opt{archosplayer}{\input{plugins/nim.tex}}
  56
  57 \opt{iriverh100,iaudiom5,lcd_color}{\nopt{sansac200}{\input{plugins/pacbox.tex}}}
  58
  59 \opt{lcd_bitmap}{\input{plugins/pegbox.tex}}
  60
  61 \opt{lcd_bitmap}{\input{plugins/pong.tex}}
  62
  63 \opt{lcd_bitmap}{\input{plugins/reversi.tex}}
  64
  65 \opt{lcd_bitmap}{\input{plugins/robotfindskitten.tex}}
  66
  67 {\input{plugins/rockblox.tex}}
  68
  69 \opt{lcd_bitmap}{\input{plugins/rockblox1d.tex}}
  70
  71 \opt{lcd_bitmap}{\input{plugins/rocklife.tex}}
  72
  73 \opt{lcd_bitmap}{\input{plugins/sliding.tex}}
  74
  75 \opt{lcd_bitmap}{\input{plugins/snake.tex}}
  76
  77 \opt{lcd_bitmap}{\input{plugins/snake2.tex}}
  78
  79 \opt{lcd_bitmap}{\input{plugins/sokoban.tex}}
  80
  81 \opt{lcd_bitmap}{\input{plugins/solitaire.tex}}
  82
  83 \opt{lcd_bitmap}{\input{plugins/spacerocks.tex}}
  84
  85 \opt{lcd_bitmap}{\input{plugins/star.tex}}
  86
  87 \opt{lcd_bitmap}{\input{plugins/sudoku.tex}}
  88
  89 \opt{lcd_bitmap}{\input{plugins/wormlet.tex}}
  90
  91 \opt{lcd_bitmap}{\input{plugins/xobox.tex}}
  92
  93 \section{Demos}
  94
  95 \opt{lcd_bitmap}{\input{plugins/bounce.tex}}
  96
  97 {\input{plugins/credits.tex}}
  98
  99 {\input{plugins/cube.tex}}
 100
 101 \opt{lcd_bitmap}{\input{plugins/demystify.tex}}
 102
 103 \opt{lcd_bitmap}{\input{plugins/fire.tex}}
 104
 105 \opt{lcd_bitmap}{\input{plugins/fractals.tex}}
 106
 107 {\input{plugins/logo.tex}}
 108
 109 {\input{plugins/mosaic.tex}}
 110
 111 \opt{lcd_bitmap}{\input{plugins/oscilloscope.tex}}
 112
 113 \opt{tagcache}{\opt{lcd_bitmap}{\input{plugins/pictureflow.tex}}}
 114
 115 \opt{lcd_bitmap}{\input{plugins/plasma.tex}}
 116
 117 {\input{plugins/snow.tex}}
 118
 119 \opt{lcd_bitmap}{\input{plugins/starfield.tex}}
 120
 121 \opt{lcd_bitmap}{\input{plugins/vumeter.tex}}
 122
 123 \section{\label{ref:Viewersplugins}Viewers}
 124
 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}{\nopt{lowmem}{
 143         Midiplay          & \fname{.mid, .midi}              &   \\
 144         MPEG Player       & \fname{.mpg, .mpeg, .mpv, .m2v}  &   \\
 145     }}
 146     \opt{masf}{
 147         \opt{lcd_bitmap}{
 148             Movie Player  & \fname{.rvf}                     &   \\
 149         }
 150     }
 151     \opt{lcd_bitmap}{
 152         PNG viewer        & \fname{.png}                     &   \\
 153     }
 154     \opt{lcd_color}{
 155         PPM viewer        & \fname{.ppm}                     &   \\
 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/bmpviewer.tex}}
 177
 178 \opt{lcd_bitmap}{\input{plugins/chip8emulator.tex}}
 179
 180 \opt{lcd_bitmap}{\input{plugins/frotz.tex}}
 181
 182 \opt{lcd_bitmap}{\input{plugins/jpegviewer.tex}}
 183
 184 \opt{large_plugin_buffer}{\input{plugins/lua.tex}}
 185
 186 \opt{swcodec}{\nopt{lowmem}{\input{plugins/midiplay.tex}}}
 187
 188 \opt{archosrecorder,archosfmrecorder,ondio}{\input{plugins/movieplayer.tex}}
 189
 190 \opt{lcd_bitmap}{\opt{swcodec}{\nopt{lowmem}{\input{plugins/mpegplayer.tex}}}}
 191
 192 \opt{lcd_bitmap}{\input{plugins/pngviewer.tex}}
 193
 194 \opt{lcd_color}{\input{plugins/ppmviewer.tex}}
 195
 196 \opt{archosrecorder,archosfmrecorder,ondio}{\input{plugins/rockbox_flash.tex}}
 197
 198 \opt{lcd_bitmap}{\nopt{%
 199   ONDIO_PAD%,m200, % not enough buttons for keymap
 200   ,ipod1g2g,ipod3g,ipod4g,ipodmini% horizontal pixelformat not implemented
 201   ,iaudiom3%,mpiohd2000, % vertical interleaved pixelformat not implemented
 202   ,mrobe100% lcd size/depth not implemented
 203   }{
 204   \input{plugins/rockboy.tex}}}
 205
 206 {\input{plugins/search.tex}}
 207
 208 {\input{plugins/shopper.tex}}
 209
 210 {\input{plugins/sort.tex}}
 211
 212 {\input{plugins/text_viewer.tex}}
 213
 214 {\input{plugins/theme_remove.tex}}
 215
 216 {\input{plugins/vbrfix.tex}}
 217
 218 \opt{archosrecorder,archosfmrecorder,ondio}{\input{plugins/wavplay.tex}}
 219
 220 \opt{lcd_bitmap}{\input{plugins/zxbox.tex}}
 221
 222 \section{Applications}
 223
 224 \opt{rtc}{\input{plugins/alarmclock.tex}}
 225
 226 \opt{archosplayer,archosrecorder,archosfmrecorder}{\input{plugins/alpinecdc.tex}}
 227
 228 {\input{plugins/batterybenchmark.tex}}
 229
 230 \opt{lcd_bitmap}{\input{plugins/calculator.tex}}
 231
 232 \opt{rtc}{\input{plugins/calendar.tex}}
 233
 234 {\input{plugins/chess_clock.tex}}
 235
 236 \opt{rtc}{\input{plugins/clock.tex}}
 237
 238 {\input{plugins/disktidy.tex}}
 239
 240 \opt{archosplayer}{\input{plugins/euro_converter.tex}}
 241
 242 \opt{archosrecorder,archosfmrecorder,ondio}{\input{plugins/firmware_flash.tex}}
 243
 244 {\input{plugins/keybox.tex}}
 245
 246 \opt{HAVE_BACKLIGHT}{\input{plugins/lamp.tex}}
 247
 248 \opt{lcd_bitmap}{\input{plugins/lrcplayer.tex}}
 249
 250 {\input{plugins/md5sum.tex}}
 251
 252 {\input{plugins/metronome.tex}}
 253
 254 \opt{swcodec}{\opt{recording_mic}{\input{plugins/pitch_detector.tex}}}
 255
 256 {\input{plugins/random_folder_advance_config.tex}}
 257
 258 {\input{plugins/resistor.tex}}
 259
 260 \opt{lcd_color}{\input{plugins/rockpaint.tex}}
 261
 262 \opt{archosrecorder,archosfmrecorder,ondio}{\input{plugins/split_editor.tex}}
 263
 264 {\input{plugins/stats.tex}}
 265
 266 {\input{plugins/stopwatch.tex}}
 267
 268 \opt{lcd_bitmap}{\input{plugins/text_editor.tex}}