rockbox/manual/plugins/main.tex
Franklin Wei 1a6a8b52f7 Port of Simon Tatham's Puzzle Collection
Original revision: 5123b1bf68777ffa86e651f178046b26a87cf2d9

MIT Licensed. Some games still crash and others are unplayable due to
issues with controls. Still need a "real" polygon filling algorithm.

Currently builds one plugin per puzzle (about 40 in total, around 100K
each on ARM), but can easily be made to build a single monolithic
overlay (800K or so on ARM).

The following games are at least partially broken for various reasons,
and have been disabled on this commit:

Cube:     failed assertion with "Icosahedron" setting
Keen:     input issues
Mines:    weird stuff happens on target
Palisade: input issues
Solo:     input issues, occasional crash on target
Towers:   input issues
Undead:   input issues
Unequal:  input and drawing issues (concave polys)
Untangle: input issues

Features left to do:
 - In-game help system
 - Figure out the weird bugs

Change-Id: I7c69b6860ab115f973c8d76799502e9bb3d52368
2016-12-18 18:13:22 +01:00

295 lines
8.4 KiB
TeX

% $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{archosrecorder,archosfmrecorder,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}}}
{\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{archosplayer}{\input{plugins/nim.tex}}
\opt{iriverh100,iaudiom5,lcd_color}{\nopt{c200,c200v2,clipzip,samsungyh820}{\input{plugins/pacbox.tex}}}
\opt{lcd_bitmap}{\input{plugins/pegbox.tex}}
\opt{lcd_bitmap}{\input{plugins/pong.tex}}
\opt{lcd_bitmap}{\input{plugins/puzzles.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/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_bitmap}{\input{plugins/wormlet.tex}}
\opt{lcd_bitmap}{\input{plugins/xobox.tex}}
\opt{lcd_bitmap}{\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} & \\
Chip-8 Emulator & \fname{.ch8} & \\
Frotz & \fname{.z1 - .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{masf}{
\opt{lcd_bitmap}{
Movie Player & \fname{.rvf} & \\
}
}
\opt{lcd_bitmap}{
\nopt{ondio}{% not enough buttons
Rockboy & \fname{.gb, .gbc} & \\
}
}
Search & \fname{.m3u, .m3u8} & x \\
Sort & \fname{.*} & x \\
Text Viewer & \fname{.txt,.nfo, .*} & \\
VBRfix & \fname{.mp3} & x \\
\opt{masf}{
Wavplay & \fname{.wav} & \\
}
ZXBox & \fname{.tap, .tax, .sna, .z80} & \\
Shopping list & \fname{.shopper} & \\
\end{rbtabular}
\end{table}
{\input{plugins/shortcuts.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{archosrecorder,archosfmrecorder,ondio}{\input{plugins/movieplayer.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{archosrecorder,archosfmrecorder,ondio}{\input{plugins/rockbox_flash.tex}}
\opt{lcd_bitmap}{\nopt{%
ONDIO_PAD%,m200, % not enough buttons for keymap
,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}}
{\input{plugins/text_viewer.tex}}
{\input{plugins/theme_remove.tex}}
{\input{plugins/vbrfix.tex}}
\opt{archosrecorder,archosfmrecorder,ondio}{\input{plugins/wavplay.tex}}
\opt{lcd_bitmap}{\input{plugins/zxbox.tex}}
\section{Applications}
\opt{rtc}{\input{plugins/alarmclock.tex}}
\opt{archosplayer,archosrecorder,archosfmrecorder}{\input{plugins/alpinecdc.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}}
\opt{archosplayer}{\input{plugins/euro_converter.tex}}
\opt{archosrecorder,archosfmrecorder,ondio}{\input{plugins/firmware_flash.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}}
\opt{archosrecorder,archosfmrecorder,ondio}{\input{plugins/split_editor.tex}}
{\input{plugins/stats.tex}}
{\input{plugins/stopwatch.tex}}
\opt{lcd_bitmap}{\input{plugins/text_editor.tex}}