manual/plugins/main.tex

   1 % $Id$ %
   2 \chapter{Plugins}\label{ref:plugins}
   3 Plugins are little 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, a
   6 plugin is loaded, run and then exited, which returns control to Rockbox. Most
   7 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, chip8 games), or from the \setting{Open with} option on the
  13 \setting{Context Menu}.
  14
  15 \section{Games}
  16 \opt{lcd_bitmap}
  17     {See also the Chip{}-8 emulator in \reference{ref:Chip8emulator}
  18     \opt{recorder,recorderv2fm,h1xx,m5,lcd_color}
  19     {and Rockboy in \reference{ref:Rockboy}}.}
  20
  21 \opt{lcd_bitmap}{\input{plugins/blackjack.tex}}
  22
  23 \opt{lcd_bitmap}{\input{plugins/brickmania.tex}}
  24
  25 \opt{lcd_bitmap}{\input{plugins/bubbles.tex}}
  26
  27 \opt{lcd_bitmap}{\input{plugins/chessbox.tex}}
  28
  29 \opt{swcodec}{\input{plugins/doom.tex}}
  30
  31 {\input{plugins/flipit.tex}}
  32
  33 \opt{player}{\input{plugins/jackpot.tex}}
  34
  35 \opt{lcd_bitmap}{\input{plugins/jewels.tex}}
  36
  37 \opt{lcd_bitmap}{\input{plugins/minesweeper.tex}}
  38
  39 \opt{player}{\input{plugins/nim.tex}}
  40
  41 \opt{h1xx,m5,lcd_color}{\input{plugins/pacbox.tex}}
  42
  43 \opt{lcd_bitmap}{\input{plugins/pong.tex}}
  44
  45 \opt{lcd_bitmap}{\input{plugins/robotfindskitten.tex}}
  46
  47 {\input{plugins/rockblox.tex}}
  48
  49 \opt{lcd_bitmap}{\input{plugins/sliding.tex}}
  50
  51 \opt{lcd_bitmap}{\input{plugins/snake.tex}}
  52
  53 \opt{lcd_bitmap}{\input{plugins/snake2.tex}}
  54
  55 \opt{lcd_bitmap}{\input{plugins/sokoban.tex}}
  56
  57 \opt{lcd_bitmap}{\input{plugins/solitaire.tex}}
  58
  59 \opt{lcd_bitmap}{\input{plugins/spacerocks.tex}}
  60
  61 \opt{lcd_bitmap}{\input{plugins/star.tex}}
  62
  63 \opt{lcd_bitmap}{\input{plugins/sudoku.tex}}
  64
  65 \opt{lcd_bitmap}{\input{plugins/wormlet.tex}}
  66
  67 \opt{lcd_bitmap}{\input{plugins/xobox.tex}}
  68
  69 \section{Demos}
  70
  71 \opt{lcd_bitmap}{\input{plugins/bounce.tex}}
  72
  73 {\input{plugins/credits.tex}}
  74
  75 {\input{plugins/cube.tex}}
  76
  77 \opt{lcd_bitmap}{\input{plugins/demystify.tex}}
  78
  79 \opt{lcd_bitmap}{\input{plugins/fire.tex}}
  80
  81 {\input{plugins/logo.tex}}
  82
  83 \opt{lcd_bitmap}{\input{plugins/mandelbrot.tex}}
  84
  85 {\input{plugins/mosaic.tex}}
  86
  87 \opt{lcd_bitmap}{\input{plugins/oscilloscope.tex}}
  88
  89 \opt{lcd_bitmap}{\input{plugins/plasma.tex}}
  90
  91 {\input{plugins/snow.tex}}
  92
  93 \opt{lcd_bitmap}{\input{plugins/starfield.tex}}
  94
  95 \opt{lcd_bitmap}{\input{plugins/vumeter.tex}}
  96
  97 \section{\label{ref:Viewersplugins}Viewers}
  98
  99 Viewers are plugins which are associated with specific file extensions.
 100 They cannot be run directly but are started by ``playing''
 101 the associated file. Viewers are stored in the
 102 \textbf{/.rockbox/viewers/ }directory.
 103
 104 {\input{plugins/shortcuts.tex}}
 105
 106 \opt{lcd_bitmap}{\input{plugins/chip8emulator.tex}}
 107
 108 \opt{lcd_bitmap}{\input{plugins/jpegviewer.tex}}
 109
 110 \opt{recorder,recorderv2fm,ondio}{\input{plugins/movieplayer.tex}}
 111
 112 \opt{lcd_color}{\input{plugins/mpegplayer.tex}}
 113
 114 \opt{recorder,recorderv2fm,ondio}{\input{plugins/rockbox_flash.tex}}
 115
 116 \opt{recorder,recorderv2fm,h1xx,m5,lcd_color}{\input{plugins/rockboy.tex}}
 117
 118 {\input{plugins/search.tex}}
 119
 120 {\input{plugins/sort.tex}}
 121
 122 {\input{plugins/text_viewer.tex}}
 123
 124 {\input{plugins/vbrfix.tex}}
 125
 126 \opt{recorder,recorderv2fm,ondio}{\input{plugins/wavplay.tex}}
 127
 128 \section{Applications}
 129
 130 \opt{player,recorder,recorderv2fm}{\input{plugins/alpinecdc.tex}}
 131
 132 {\input{plugins/batterybenchmark.tex}}
 133
 134 \opt{lcd_bitmap}{\input{plugins/calculator.tex}}
 135
 136 \opt{recorder,recorderv2fm}{\input{plugins/calendar.tex}}
 137
 138 {\input{plugins/chess_clock.tex}}
 139
 140 \opt{rtc}{\input{plugins/clock.tex}}
 141
 142 {\input{plugins/dice.tex}}
 143
 144 {\input{plugins/disktidy.tex}}
 145
 146 \opt{player}{\input{plugins/euro_converter.tex}}
 147
 148 \opt{recorder,recorderv2fm,ondio}{\input{plugins/firmware_flash.tex}}
 149
 150 {\input{plugins/metronome.tex}}
 151
 152 \opt{recorder,recorderv2fm,ondio}{\input{plugins/split_editor.tex}}
 153
 154 {\input{plugins/stats.tex}}
 155
 156 {\input{plugins/stopwatch.tex}}
 157
 158 \opt{lcd_bitmap}{\input{plugins/text_editor.tex}}