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