summaryrefslogtreecommitdiffstats
path: root/manual/plugins/main.tex
blob: 33bdb13b0583ba4b24401e3076c2827a2246d264 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
% $Id$ %
\chapter{Plugins}\label{ref:plugins}
\opt{mpiohd200}{%
\fixme{The manual for MPIO HD200 is incomplete. Keymap definitions for plugins are missing.}\\

}
Plugins are programs that Rockbox can load and run. Only one plugin can
be loaded at a time. Plugins have exclusive control over the user interface.
This means you cannot switch back and forth between a plugin and Rockbox. When
a plugin is loaded, you need to exit it to return to the Rockbox interface.
Most plugins will not interfere with music playback but some of them will stop
playback while running. Plugins have the file extension \fname{.rock}. Most of
them can be started from \setting{Browse Plugins} in the \setting{Main Menu}.\\

Viewer plugins get started automatically by opening an associated file (i.e.
text files%
\opt{lcd_bitmap}{, chip8 games}%
), or from the \setting{Open with} option on the \setting{Context Menu}.

\section{Games}
\opt{lcd_bitmap}
    {See also the Chip{}-8 emulator in \reference{ref:Chip8emulator},
    Frotz in \reference{ref:Frotz},
    \opt{iriverh100,iaudiom5,lcd_color}
    {Rockboy in \reference{ref:Rockboy}}
    and ZXBox in \reference{ref:ZXBox}.}

\opt{lcd_bitmap}{\input{plugins/2048.tex}}

\opt{lcd_bitmap}{\input{plugins/blackjack.tex}}

\opt{large_plugin_buffer}{\input{plugins/boomshine.tex}}

\opt{lcd_bitmap}{\input{plugins/brickmania.tex}}

\opt{lcd_bitmap}{\input{plugins/bubbles.tex}}

\opt{lcd_bitmap}{\input{plugins/chessbox.tex}}

\opt{lcd_bitmap}{\input{plugins/chopper.tex}}

\opt{lcd_color}{\input{plugins/clix.tex}}

\opt{lcd_color}{\input{plugins/codebuster.tex}}

{\input{plugins/dice.tex}}

\opt{swcodec}{\nopt{lowmem}{\input{plugins/doom.tex}}}

\opt{lcd_color}{\nopt{lowmem,iaudiox5,iriverh300}{\input{plugins/duke3d.tex}}}

{\input{plugins/flipit.tex}}

\opt{lcd_bitmap}{\input{plugins/goban.tex}}

\opt{lcd_non-mono}{\nopt{iriverh10_5gb,ipodmini1g,c200,c200v2,mpiohd200,clipzip,samsungyh820}{
  \input{plugins/invadrox.tex}}}

{\input{plugins/jackpot.tex}}

\opt{lcd_bitmap}{\input{plugins/jewels.tex}}

\opt{lcd_bitmap}{\input{plugins/maze.tex}}

\opt{lcd_bitmap}{\input{plugins/mazezam.tex}}

\opt{lcd_bitmap}{\input{plugins/minesweeper.tex}}

\opt{iriverh100,iaudiom5,lcd_color}{\nopt{c200,c200v2}{\input{plugins/pacbox.tex}}}

\opt{lcd_bitmap}{\input{plugins/pegbox.tex}}

\opt{lcd_color}{\opt{large_plugin_buffer}{\input{plugins/pixelpainter.tex}}}

\opt{lcd_bitmap}{\input{plugins/pong.tex}}

\opt{lcd_color}{\nopt{lowmem,iaudiox5,iriverh300}{\input{plugins/quake.tex}}}

\opt{lcd_bitmap}{\input{plugins/reversi.tex}}

\opt{lcd_bitmap}{\input{plugins/robotfindskitten.tex}}

{\input{plugins/rockblox.tex}}

\opt{lcd_bitmap}{\input{plugins/rockblox1d.tex}}

\opt{lcd_bitmap}{\input{plugins/sgt-puzzles.tex}}

\opt{lcd_bitmap}{\input{plugins/sliding.tex}}

\opt{lcd_bitmap}{\input{plugins/snake.tex}}

\opt{lcd_bitmap}{\input{plugins/snake2.tex}}

\opt{lcd_bitmap}{\input{plugins/sokoban.tex}}

\opt{lcd_bitmap}{\input{plugins/solitaire.tex}}

\opt{lcd_bitmap}{\input{plugins/spacerocks.tex}}

\opt{lcd_bitmap}{\input{plugins/star.tex}}

\opt{lcd_bitmap}{\input{plugins/sudoku.tex}}

\opt{lcd_non-mono}{\nopt{iriverh10_5gb,ipodmini1g,c200,c200v2,mpiohd200,clipzip,samsungyh820}{
  \input{plugins/superdom.tex}}}

\opt{lcd_color}{\nopt{lowmem,iaudiox5,iriverh300}{\input{plugins/wolf3d.tex}}}

\opt{lcd_bitmap}{\input{plugins/wormlet.tex}}

\opt{lcd_bitmap}{\input{plugins/xobox.tex}}

\opt{lcd_color}{\input{plugins/xworld.tex}}

\section{Demos}

\opt{lcd_bitmap}{\input{plugins/bounce.tex}}

{\input{plugins/credits.tex}}

{\input{plugins/cube.tex}}

\opt{lcd_bitmap}{\input{plugins/demystify.tex}}

\opt{swcodec}{\input{plugins/fft.tex}}

\opt{lcd_bitmap}{\input{plugins/fire.tex}}

\opt{lcd_bitmap}{\input{plugins/fractals.tex}}

{\input{plugins/logo.tex}}

\opt{lcd_bitmap}{\input{plugins/matrix.tex}}

{\input{plugins/mosaic.tex}}

\opt{lcd_bitmap}{\input{plugins/oscilloscope.tex}}

\opt{tagcache}{\opt{lcd_bitmap}{\input{plugins/pictureflow.tex}}}

\opt{lcd_bitmap}{\input{plugins/plasma.tex}}

\opt{lcd_bitmap}{\input{plugins/rocklife.tex}}

{\input{plugins/snow.tex}}

\opt{lcd_bitmap}{\input{plugins/starfield.tex}}

\opt{lcd_bitmap}{\input{plugins/vumeter.tex}}

\section{\label{ref:Viewersplugins}Viewers}

Viewers are plugins which are associated with specific file extensions.
They cannot be run directly but are started by ``playing'' the associated file.
Viewers are stored in the \fname{/.rockbox/rocks/viewers/} directory.
\par
\note{
Some viewer plugins can only be used by selecting the \setting{Open With...}
option from the \setting{Context Menu} (see \reference{ref:Contextmenu}).}
\begin{table}
  \begin{rbtabular}{.92\textwidth}{Xlc}%
      {\textbf{Viewer Plugin}& \textbf{Associated filetype(s)} & \textbf{Context Menu only}}%
      {}{}
    Shortcuts             & \fname{.link}                    &   \\
    MS Windows shortcuts  & \fname{.lnk}                     &   \\
    Chip-8 Emulator       & \fname{.ch8}                     &   \\
    Frotz                 & \fname{.z1} to \fname{.z8}       &   \\
    Image Viewer          & \fname{.bmp, .jpg, .jpeg, .png\opt{lcd_color}{, .ppm}}  &   \\
    Lua scripting language& \fname{.lua}                     &   \\
    \opt{swcodec}{\nopt{lowmem}{
        Midiplay          & \fname{.mid, .midi}              &   \\
        MPEG Player       & \fname{.mpg, .mpeg, .mpv, .m2v}  &   \\
    }}
    \opt{swcodec}{
        MP3 Encoder       & \fname{.wav}                     & x \\
    }
    \opt{lcd_bitmap}{
        Rockboy       & \fname{.gb, .gbc}                &   \\
    }
    Search                & \fname{.m3u, .m3u8}              & x \\
    Shopping list         & \fname{.shopper}                 &   \\
    Sort                  & \fname{.*}                       & x \\
    Text Viewer           & \fname{.txt,.nfo, .*}            &   \\
    VBRfix                & \fname{.mp3}                     & x \\
    ZXBox                 & \fname{.tap, .tax, .sna, .z80}   &   \\
  \end{rbtabular}
\end{table}

{\input{plugins/shortcuts.tex}}

{\input{plugins/winshortcuts.tex}}

\opt{lcd_bitmap}{\input{plugins/chip8emulator.tex}}

\opt{lcd_bitmap}{\input{plugins/frotz.tex}}

\opt{lcd_bitmap}{\input{plugins/imageviewer.tex}}

\opt{large_plugin_buffer}{\input{plugins/lua.tex}}

\opt{swcodec}{\nopt{lowmem}{\input{plugins/midiplay.tex}}}

\opt{lcd_bitmap}{\opt{swcodec}{\nopt{lowmem}{\input{plugins/mpegplayer.tex}}}}

\opt{swcodec}{\input{plugins/mp3_encoder.tex}}

\opt{iriverh300,iriverh100,SANSA_FUZE_PAD,SANSA_E200_PAD,IPOD_4G_PAD,IPOD_3G_PAD%
    ,IPOD_1G2G_PAD,SAMSUNG_YPR0_PAD}{
  \input{plugins/pdbox.tex}}

\opt{lcd_bitmap}{\nopt{%
  ipod1g2g,ipod3g,ipod4g,ipodmini% horizontal pixelformat not implemented
  ,iaudiom3,mpiohd200, % vertical interleaved pixelformat not implemented
  ,mrobe100% lcd size/depth not implemented
  }{
  \input{plugins/rockboy.tex}}}

{\input{plugins/search.tex}}

{\input{plugins/shopper.tex}}

{\input{plugins/sort.tex}}

\opt{lcd_non-mono}{\input{plugins/speedread.tex}}

{\input{plugins/text_viewer.tex}}

{\input{plugins/theme_remove.tex}}

{\input{plugins/vbrfix.tex}}

\opt{lcd_bitmap}{\input{plugins/zxbox.tex}}

\section{Applications}

\opt{rtc}{\input{plugins/alarmclock.tex}}

{\input{plugins/batterybenchmark.tex}}

\opt{lcd_bitmap}{\input{plugins/calculator.tex}}

\opt{rtc}{\input{plugins/calendar.tex}}

{\input{plugins/chess_clock.tex}}

\opt{rtc}{\input{plugins/clock.tex}}

{\input{plugins/dict.tex}}

{\input{plugins/disktidy.tex}}

{\input{plugins/keybox.tex}}

\opt{HAVE_BACKLIGHT}{\input{plugins/lamp.tex}}

\opt{lcd_bitmap}{\input{plugins/lrcplayer.tex}}

{\input{plugins/main_menu_config.tex}}

{\input{plugins/md5sum.tex}}

{\input{plugins/metronome.tex}}

{\input{plugins/otp.tex}}

\opt{lcd_bitmap}{\input{plugins/periodic_table.tex}}

\opt{swcodec}{\opt{recording_mic}{\input{plugins/pitch_detector.tex}}}

{\input{plugins/random_folder_advance_config.tex}}

{\input{plugins/resistor.tex}}

\opt{lcd_color}{\input{plugins/rockpaint.tex}}

{\input{plugins/stats.tex}}

{\input{plugins/stopwatch.tex}}

\opt{lcd_bitmap}{\input{plugins/text_editor.tex}}