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{recorder,recorderv2fm,h100,m5,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 {\input{plugins/dice.tex}}
  35
  36 \opt{swcodec}{\input{plugins/doom.tex}}
  37
  38 {\input{plugins/flipit.tex}}
  39
  40 \opt{lcd_bitmap}{\input{plugins/goban.tex}}
  41
  42 \opt{lcd_non-mono}{\nopt{h10_5gb,ipodmini,c200}{
  43   \input{plugins/invadrox.tex}}}
  44
  45 {\input{plugins/jackpot.tex}}
  46
  47 \opt{lcd_bitmap}{\input{plugins/jewels.tex}}
  48
  49 \opt{lcd_bitmap}{\input{plugins/mazezam.tex}}
  50
  51 \opt{lcd_bitmap}{\input{plugins/minesweeper.tex}}
  52
  53 \opt{player}{\input{plugins/nim.tex}}
  54
  55 \opt{h100,m5,lcd_color}{\nopt{c200}{\input{plugins/pacbox.tex}}}
  56
  57 \opt{lcd_bitmap}{\input{plugins/pegbox.tex}}
  58
  59 \opt{lcd_bitmap}{\input{plugins/pong.tex}}
  60
  61 \opt{lcd_bitmap}{\input{plugins/robotfindskitten.tex}}
  62
  63 {\input{plugins/rockblox.tex}}
  64
  65 \opt{lcd_bitmap}{\input{plugins/rockblox1d.tex}}
  66
  67 \opt{lcd_bitmap}{\input{plugins/rocklife.tex}}
  68
  69 \opt{lcd_bitmap}{\input{plugins/sliding.tex}}
  70
  71 \opt{lcd_bitmap}{\input{plugins/snake.tex}}
  72
  73 \opt{lcd_bitmap}{\input{plugins/snake2.tex}}
  74
  75 \opt{lcd_bitmap}{\input{plugins/sokoban.tex}}
  76
  77 \opt{lcd_bitmap}{\input{plugins/solitaire.tex}}
  78
  79 \opt{lcd_bitmap}{\input{plugins/spacerocks.tex}}
  80
  81 \opt{lcd_bitmap}{\input{plugins/star.tex}}
  82
  83 \opt{lcd_bitmap}{\input{plugins/sudoku.tex}}
  84
  85 \opt{lcd_bitmap}{\input{plugins/wormlet.tex}}
  86
  87 \opt{lcd_bitmap}{\input{plugins/xobox.tex}}
  88
  89 \section{Demos}
  90
  91 \opt{lcd_bitmap}{\input{plugins/bounce.tex}}
  92
  93 {\input{plugins/credits.tex}}
  94
  95 {\input{plugins/cube.tex}}
  96
  97 \opt{lcd_bitmap}{\input{plugins/demystify.tex}}
  98
  99 \opt{lcd_bitmap}{\input{plugins/fire.tex}}
 100
 101 {\input{plugins/logo.tex}}
 102
 103 \opt{lcd_bitmap}{\input{plugins/mandelbrot.tex}}
 104
 105 {\input{plugins/mosaic.tex}}
 106
 107 \opt{lcd_bitmap}{\input{plugins/oscilloscope.tex}}
 108
 109 \opt{tagcache}{\opt{lcd_bitmap}{\input{plugins/pictureflow.tex}}}
 110
 111 \opt{lcd_bitmap}{\input{plugins/plasma.tex}}
 112
 113 {\input{plugins/snow.tex}}
 114
 115 \opt{lcd_bitmap}{\input{plugins/starfield.tex}}
 116
 117 \opt{lcd_bitmap}{\input{plugins/vumeter.tex}}
 118
 119 \section{\label{ref:Viewersplugins}Viewers}
 120
 121 Viewers are plugins which are associated with specific file extensions.
 122 They cannot be run directly but are started by ``playing''
 123 the associated file. Viewers are stored in the
 124 \textbf{/.rockbox/rocks/viewers/ }directory.
 125
 126 {\input{plugins/shortcuts.tex}}
 127
 128 \opt{lcd_bitmap}{\input{plugins/chip8emulator.tex}}
 129
 130 \opt{lcd_bitmap}{\input{plugins/jpegviewer.tex}}
 131
 132 \opt{large_plugin_buffer}{\input{plugins/lua.tex}}
 133
 134 \opt{swcodec}{\input{plugins/midiplay.tex}}
 135
 136 \opt{recorder,recorderv2fm,ondio}{\input{plugins/movieplayer.tex}}
 137
 138 \opt{lcd_bitmap}{\opt{swcodec}{\input{plugins/mpegplayer.tex}}}
 139
 140 \opt{lcd_bitmap}{\opt{lcd_color}{\input{plugins/pngviewer.tex}}}
 141
 142 \opt{lcd_color}{\input{plugins/ppmviewer.tex}}
 143
 144 \opt{recorder,recorderv2fm,ondio}{\input{plugins/rockbox_flash.tex}}
 145
 146 \opt{recorder,recorderv2fm,h100,m5,lcd_color}{\input{plugins/rockboy.tex}}
 147
 148 {\input{plugins/search.tex}}
 149
 150 {\input{plugins/sort.tex}}
 151
 152 {\input{plugins/text_viewer.tex}}
 153
 154 {\input{plugins/vbrfix.tex}}
 155
 156 \opt{recorder,recorderv2fm,ondio}{\input{plugins/wavplay.tex}}
 157
 158 \opt{lcd_bitmap}{\input{plugins/zxbox.tex}}
 159
 160 \section{Applications}
 161
 162 \opt{player,recorder,recorderv2fm}{\input{plugins/alpinecdc.tex}}
 163
 164 {\input{plugins/batterybenchmark.tex}}
 165
 166 \opt{lcd_bitmap}{\input{plugins/calculator.tex}}
 167
 168 \opt{rtc}{\input{plugins/calendar.tex}}
 169
 170 {\input{plugins/chess_clock.tex}}
 171
 172 \opt{rtc}{\input{plugins/clock.tex}}
 173
 174 {\input{plugins/disktidy.tex}}
 175
 176 \opt{player}{\input{plugins/euro_converter.tex}}
 177
 178 \opt{recorder,recorderv2fm,ondio}{\input{plugins/firmware_flash.tex}}
 179
 180 {\input{plugins/keybox.tex}}
 181
 182 \opt{HAVE_BACKLIGHT}{\input{plugins/lamp.tex}}
 183
 184 {\input{plugins/md5sum.tex}}
 185
 186 {\input{plugins/metronome.tex}}
 187
 188 {\input{plugins/random_folder_advance_config.tex}}
 189
 190 \opt{lcd_color}{\input{plugins/rockpaint.tex}}
 191
 192 \opt{recorder,recorderv2fm,ondio}{\input{plugins/split_editor.tex}}
 193
 194 {\input{plugins/stats.tex}}
 195
 196 {\input{plugins/stopwatch.tex}}
 197
 198 \opt{lcd_bitmap}{\input{plugins/text_editor.tex}}