rockbox/manual/plugins/main.tex

% $Id$ %
\chapter{Plugins}\label{ref:plugins}
Plugins are little 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, a
plugin is loaded, run and then exited, which returns control to Rockbox. 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, chip8 games), or from the \setting{Open with} option on the
\setting{File Menu}.

\section{Games}
\opt{HAVE_LCD_BITMAP}
    {See also the Chip{}-8 emulator in \reference{ref:Chip8emulator}
    \opt{recorder,recorderv2fm,h1xx,h300,ipodcolor,ipodvideo,sansa}
    {and Rockboy in \reference{ref:Rockboy}}.}

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

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

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

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

\opt{SWCODEC}{\input{plugins/doom.tex}}

{\input{plugins/flipit.tex}}

\opt{player}{\input{plugins/jackpot.tex}}

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

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

\opt{player}{\input{plugins/nim.tex}}

\opt{h1xx,HAVE_LCD_COLOR}{\input{plugins/pacbox.tex}}

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

{\input{plugins/rockblox.tex}}

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

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

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

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

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

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

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

\opt{recorder,recorderv2fm,ondio,h1xx,ipod,HAVE_LCD_COLOR}{\input{plugins/sudoku.tex}}

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

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

\section{Demos}

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

{\input{plugins/credits.tex}}

{\input{plugins/cube.tex}}

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

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

{\input{plugins/logo.tex}}

\opt{HAVE_LCD_BITMAP}{\input{plugins/mandelbrot.tex}}

{\input{plugins/mosaic.tex}}

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

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

{\input{plugins/snow.tex}}

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

\opt{HAVE_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
\textbf{/.rockbox/viewers/ }directory.

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

\opt{HAVE_LCD_BITMAP}{\input{plugins/jpegviewer.tex}}

\opt{recorder,recorderv2fm,ondio}{\input{plugins/movieplayer.tex}}

\opt{recorder,recorderv2fm,ondio}{\input{plugins/rockbox_flash.tex}}

\opt{recorder,recorderv2fm,h1xx,h300,h10,h10_5gb,ipodcolor,ipodvideo,ipodnano,x5,sansa}{\input{plugins/rockboy.tex}}

{\input{plugins/search.tex}}

{\input{plugins/sort.tex}}

{\input{plugins/text_viewer.tex}}

{\input{plugins/vbrfix.tex}}

\opt{recorder,recorderv2fm,ondio}{\input{plugins/wavplay.tex}}

\section{Applications}

\opt{player,recorder,recorderv2fm}{\input{plugins/alpinecdc.tex}}

{\input{plugins/batterybenchmark.tex}}

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

\opt{recorder,recorderv2fm}{\input{plugins/calendar.tex}}

{\input{plugins/chess_clock.tex}}

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

{\input{plugins/dice.tex}}

{\input{plugins/disktidy.tex}}

\opt{player}{\input{plugins/euro_converter.tex}}

\opt{recorder,recorderv2fm,ondio}{\input{plugins/firmware_flash.tex}}

{\input{plugins/metronome.tex}}

\opt{recorder,recorderv2fm,ondio}{\input{plugins/split_editor.tex}}

{\input{plugins/stats.tex}}

{\input{plugins/stopwatch.tex}}

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