rockbox/manual/plugins/main.tex

% $Id$ %
\chapter{Plugins}\label{ref:plugins}
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}
    \opt{archosrecorder,archosfmrecorder,iriverh100,iaudiom5,lcd_color}
    {and Rockboy in \reference{ref:Rockboy}}.}

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

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

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

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

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

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

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

{\input{plugins/dice.tex}}

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

{\input{plugins/flipit.tex}}

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

\opt{lcd_non-mono}{\nopt{iriverh10_5gb,ipodmini1g,sansac200}{
  \input{plugins/invadrox.tex}}}

{\input{plugins/jackpot.tex}}

\opt{lcd_bitmap}{\input{plugins/jewels.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{sansac200}{\input{plugins/pacbox.tex}}}

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

\opt{lcd_bitmap}{\input{plugins/pong.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/rocklife.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_bitmap}{\input{plugins/wormlet.tex}}

\opt{lcd_bitmap}{\input{plugins/xobox.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{lcd_bitmap}{\input{plugins/fire.tex}}

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

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

{\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}}%
      {}{}
    BMP Viewer            & \fname{.bmp}                     &   \\
    Shortcuts             & \fname{.link}                    &   \\
    Chip-8 Emulator       & \fname{.ch8}                     &   \\
    Frotz                 & \fname{.z1 - .z8}                &   \\
    JPEG Viewer           & \fname{.jpg, .jpeg}              &   \\
    Lua scripting language& \fname{.lua}                     &   \\
    \opt{swcodec}{
        Midiplay          & \fname{.mid, .midi}              &   \\
        MPEG Player       & \fname{.mpg, .mpeg, .mpv, .m2v}  &   \\
    }
    \opt{masf}{
        \opt{lcd_bitmap}{
            Movie Player  & \fname{.rvf}                     &   \\
        }
    }
    \opt{lcd_color}{
        PNG viewer        & \fname{.png}                     &   \\
        PPM viewer        & \fname{.ppm}                     &   \\
    }
    \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}   &   \\
  \end{rbtabular}
\end{table}

{\input{plugins/shortcuts.tex}}

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

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

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

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

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

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

\opt{archosrecorder,archosfmrecorder,ondio}{\input{plugins/movieplayer.tex}}

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

\opt{lcd_bitmap}{\opt{lcd_color}{\input{plugins/pngviewer.tex}}}

\opt{lcd_color}{\input{plugins/ppmviewer.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,ipodmini1g% horizontal pixelformat not implemented
  ,iaudiom3%,mpiohd2000, % vertical interleaved pixelformat not implemented
  ,mrobe100% lcd size/depth not implemented
  }{
  \input{plugins/rockboy.tex}}}

{\input{plugins/search.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/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/md5sum.tex}}

{\input{plugins/metronome.tex}}

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

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