tsiry-sandratraina.com
A modern Music Player Daemon based on Rockbox open source high quality audio player
libadwaita
audio
rust
zig
deno
mpris
rockbox
mpd
1% $Id$ %
2\chapter{Plugins}\label{ref:plugins}
3\opt{mpiohd200}{%
4\fixme{The manual for MPIO HD200 is incomplete. Keymap definitions for plugins are missing.}\\
5
6}
7Plugins are programs that Rockbox can load and run. Only one plugin can
8be loaded at a time. Plugins have exclusive control over the user interface.
9This means you cannot switch back and forth between a plugin and Rockbox. When
10a plugin is loaded, you need to exit it to return to the Rockbox interface.
11Most plugins will not interfere with music playback but some of them will stop
12playback while running. Plugins have the file extension \fname{.rock}. Most of
13them can be started from \setting{Browse Plugins} in the \setting{Main Menu}.\\
14
15Viewer plugins get started automatically by opening an associated file (i.e.
16text files%
17, chip8 games), or from the \setting{Open with} option on the \setting{Context Menu}.
18
19\section{Games}
20 See also the Chip{}-8 emulator in \reference{ref:Chip8emulator},
21 Frotz in \reference{ref:Frotz},
22 \opt{iriverh100,iaudiom5,lcd_color}
23 {Rockboy in \reference{ref:Rockboy}}
24 and ZXBox in \reference{ref:ZXBox}.
25
26\input{plugins/2048.tex}
27
28\nopt{lowmem}{\input{plugins/amaze.tex}}
29
30\input{plugins/blackjack.tex}
31
32\opt{large_plugin_buffer}{\input{plugins/boomshine.tex}}
33
34\input{plugins/brickmania.tex}
35
36\input{plugins/bubbles.tex}
37
38\input{plugins/chessbox.tex}
39
40\input{plugins/chopper.tex}
41
42\opt{lcd_color}{\input{plugins/clix.tex}}
43
44\opt{lcd_color}{\input{plugins/codebuster.tex}}
45
46\input{plugins/dice.tex}
47
48\nopt{xduoox3}{\nopt{lowmem}{\input{plugins/doom.tex}}}
49
50\opt{lcd_color}{\nopt{lowmem,iaudiox5,iriverh300,rgnano}{\input{plugins/duke3d.tex}}}
51
52\input{plugins/flipit.tex}
53
54\input{plugins/goban.tex}
55
56\opt{lcd_non-mono}{\nopt{iriverh10_5gb,ipodmini1g,c200,c200v2,mpiohd200,clipzip,samsungyh820}{
57 \input{plugins/invadrox.tex}}}
58
59\input{plugins/jackpot.tex}
60
61\input{plugins/jewels.tex}
62
63\input{plugins/maze.tex}
64
65\input{plugins/mazezam.tex}
66
67\input{plugins/minesweeper.tex}
68
69\opt{iriverh100,iaudiom5,lcd_color}{\nopt{c200,c200v2}{\input{plugins/pacbox.tex}}}
70
71\input{plugins/pegbox.tex}
72
73\opt{lcd_color}{\opt{large_plugin_buffer}{\input{plugins/pixelpainter.tex}}}
74
75\input{plugins/pong.tex}
76
77\opt{lcd_color}{\nopt{lowmem,iaudiox5,iriverh300,rgnano}{\input{plugins/quake.tex}}}
78
79\input{plugins/reversi.tex}
80
81\input{plugins/robotfindskitten.tex}
82
83\input{plugins/rockblox.tex}
84
85\input{plugins/rockblox1d.tex}
86
87\opt{lcd_color}{\input{plugins/sgt-puzzles.tex}}
88
89\input{plugins/sliding.tex}
90
91\input{plugins/snake.tex}
92
93\input{plugins/snake2.tex}
94
95\input{plugins/sokoban.tex}
96
97\input{plugins/solitaire.tex}
98
99\input{plugins/spacerocks.tex}
100
101\input{plugins/star.tex}
102
103\input{plugins/sudoku.tex}
104
105\opt{lcd_non-mono}{\nopt{iriverh10_5gb,ipodmini1g,c200,c200v2,mpiohd200,clipzip,samsungyh820}{
106 \input{plugins/superdom.tex}}}
107
108\opt{lcd_color}{\nopt{lowmem,iaudiox5,iriverh300,rgnano}{\input{plugins/wolf3d.tex}}}
109
110\input{plugins/wormlet.tex}
111
112\input{plugins/xobox.tex}
113
114\opt{lcd_non-mono}{\input{plugins/xrick.tex}}
115
116\opt{lcd_color}{\input{plugins/xworld.tex}}
117
118
119
120
121\section{Demos}
122
123\input{plugins/announce_status.tex}
124
125\input{plugins/bounce.tex}
126
127\input{plugins/credits.tex}
128
129\input{plugins/cube.tex}
130
131\input{plugins/demystify.tex}
132
133\input{plugins/fft.tex}
134
135\input{plugins/fire.tex}
136
137\input{plugins/fractals.tex}
138
139\input{plugins/logo.tex}
140
141\nopt{xduoox3,clip,clipplus}{\input{plugins/matrix.tex}}
142
143\input{plugins/mosaic.tex}
144
145\input{plugins/oscilloscope.tex}
146
147\opt{tagcache}{\input{plugins/pictureflow.tex}}
148
149\input{plugins/plasma.tex}
150
151\input{plugins/rocklife.tex}
152
153\input{plugins/snow.tex}
154
155\input{plugins/starfield.tex}
156
157\input{plugins/vumeter.tex}
158
159\section{\label{ref:Viewersplugins}Viewers}
160
161Viewers are plugins which are associated with specific file extensions.
162They cannot be run directly but are started by ``playing'' the associated file.
163Viewers are stored in the \fname{/.rockbox/rocks/viewers/} directory.
164\par
165\note{
166Some viewer plugins can only be used by selecting the \setting{Open With...}
167option from the \setting{Context Menu} (see \reference{ref:Contextmenu}).}
168\begin{table}
169 \begin{rbtabular}{.92\textwidth}{Xlc}%
170 {\textbf{Viewer Plugin}& \textbf{Associated filetype(s)} & \textbf{Context Menu only}}%
171 {}{}
172 Shortcuts & \fname{.link} & \\
173 MS Windows shortcuts & \fname{.lnk} & \\
174 Chip-8 Emulator & \fname{.ch8} & \\
175 Frotz & \fname{.z1} to \fname{.z8} & \\
176 Image Viewer & \fname{.bmp, .jpg, .jpeg, .png\opt{lcd_color}{, .ppm}} & \\
177 Lua scripting language& \fname{.lua} & \\
178 \nopt{lowmem}{
179 Midiplay & \fname{.mid, .midi} & \\
180 Mikmod & \fname{.669, .amf, .asy, .dsm,} & \\
181 & \fname{.far, .gdm, imf, .it,} & \\
182 & \fname{.m15, .med, .mod, .okt,} & \\
183 & \fname{.s3m, .stm, .stx, .ult,} & \\
184 & \fname{.uni, .umx, .xm} & \\
185 MPEG Player & \fname{.mpg, .mpeg, .mpv, .m2v} & \\
186 }
187 MP3 Encoder & \fname{.wav} & x \\
188 Rockboy & \fname{.gb, .gbc} & \\
189 Search & \fname{.m3u, .m3u8} & x \\
190 Shopping list & \fname{.shopper} & \\
191 Sort & \fname{.*} & x \\
192 Text Viewer & \fname{.txt,.nfo, .md,.*} & \\
193 VBRfix & \fname{.mp3} & x \\
194 ZXBox & \fname{.tap, .tax, .sna, .z80} & \\
195 \end{rbtabular}
196\end{table}
197
198\input{plugins/shortcuts.tex}
199
200\input{plugins/winshortcuts.tex}
201
202\input{plugins/chip8emulator.tex}
203
204\input{plugins/frotz.tex}
205
206\input{plugins/imageviewer.tex}
207
208\opt{large_plugin_buffer}{\input{plugins/lua.tex}}
209
210\nopt{lowmem}{\input{plugins/midiplay.tex}}
211\nopt{lowmem}{\input{plugins/mikmod.tex}}
212
213\nopt{lowmem}{\input{plugins/mpegplayer.tex}}
214
215\input{plugins/mp3_encoder.tex}
216
217\opt{iriverh300,iriverh100,SANSA_FUZE_PAD,SANSA_E200_PAD,IPOD_4G_PAD,IPOD_3G_PAD%
218 ,IPOD_1G2G_PAD,SAMSUNG_YPR0_PAD}{
219 \input{plugins/pdbox.tex}}
220
221\nopt{%
222 ipod1g2g,ipod3g,ipod4g,ipodmini% horizontal pixelformat not implemented
223 ,iaudiom3,mpiohd200, % vertical interleaved pixelformat not implemented
224 ,mrobe100% lcd size/depth not implemented
225 }{
226 \input{plugins/rockboy.tex}}
227
228\input{plugins/search.tex}
229
230\input{plugins/shopper.tex}
231
232\input{plugins/sort.tex}
233
234\opt{lcd_non-mono}{\input{plugins/speedread.tex}}
235
236\input{plugins/text_viewer.tex}
237
238\input{plugins/theme_remove.tex}
239
240\input{plugins/vbrfix.tex}
241
242\input{plugins/zxbox.tex}
243
244
245\section{Applications}
246
247\opt{rtc}{\input{plugins/alarmclock.tex}}
248
249\input{plugins/batterybenchmark.tex}
250
251\input{plugins/calculator.tex}
252
253\opt{rtc}{\input{plugins/calendar.tex}}
254
255\input{plugins/chess_clock.tex}
256
257\opt{rtc}{\input{plugins/clock.tex}}
258
259\input{plugins/dart_scorer.tex}
260
261\input{plugins/dict.tex}
262
263\input{plugins/disktidy.tex}
264
265\input{plugins/keybox.tex}
266
267\opt{HAVE_BACKLIGHT}{\input{plugins/lamp.tex}}
268
269\input{plugins/lastfm_scrobbler.tex}
270
271\input{plugins/lrcplayer.tex}
272
273\input{plugins/main_menu_config.tex}
274
275\opt{multi_boot}{\input{plugins/multiboot_select.tex}}
276
277\input{plugins/md5sum.tex}
278
279\input{plugins/metronome.tex}
280
281\input{plugins/open_plugins.tex}
282
283\input{plugins/otp.tex}
284
285\input{plugins/periodic_table.tex}
286
287\opt{recording_mic}{\input{plugins/pitch_detector.tex}}
288
289\input{plugins/random_folder_advance_config.tex}
290
291\input{plugins/resistor.tex}
292
293\opt{lcd_color}{\input{plugins/rockpaint.tex}}
294
295\input{plugins/stats.tex}
296
297\input{plugins/stopwatch.tex}
298
299\input{plugins/text_editor.tex}