manual/plugins/main.tex

% $Id$ %
\chapter{Plugins}\label{ref:plugins}
Plugins are little programs that Rockbox can load and run. Plugins have
the file extension .rock.  Most of them can be started from the main
menu if you put them in the \textbf{/.rockbox/rocks} directory. Press
PLAY on them to start them.

Viewer plugins get started automatically by
``playing'' an associated file (i.e. text
files, chip8 games), or from the ``Open with'' option on the File menu.\\

\textbf{The plugin loader}
Only one plugin can be loaded at a time. Plugins run in the GUI thread
and 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.  Music
will carry on playing whilst plugins are being run.

\section{Games}
\opt{HAVE_LCD_BITMAP}
    {See also the Chip{}-8 emulator on page \pageref{ref:Chip8emulator}
    \opt{recorder,recorderv2fm,ondio,h1xx,h300,ipodcolor,ipodvideo}
    {and Rockboy on page \pageref{ref:Rockboy}}.}

\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{h1xx,h300,ipodcolor,ipodnano,ipodvideo}{\input{plugins/doom.tex}}

\opt{HAVE_LCD_BITMAP}{\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}}

\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,h300,ipod4g,ipodcolor,ipodnano,ipodvideo,x5}{\input{plugins/sudoku.tex}}

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

\opt{recorder,recorderv2fm,ondio,h1xx,h300,IPOD_4G_PAD}{\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{recorder,recorderv2fm,ondio,h1xx,HAVE_LCD_COLOR}{\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{recorder,recorderv2fm,ondio,h1xx,HAVE_LCD_COLOR}{\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,ipodcolor,ipodvideo}{\input{plugins/rockboy.tex}}

{\input{plugins/search.tex}}

{\input{plugins/sort.tex}}

{\input{plugins/text_viewer.tex}}

{\input{plugins/vbrfix.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}}

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

{\input{plugins/favorites.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}}