rockbox/manual/plugins/doom.tex

% $Id$ %
\subsection{Doom}
\screenshot{plugins/images/ss-doom}{Doom}{}
This is the famous Doom game.

\subsubsection{Getting started}
For the game to run you need \fname{.wad} game files located in
\fname{/games/doom/} on your player. Create the directory and save the
following files there:
\begin{description}
\item[rockdoom.wad] The Rockbox \fname{.wad}, based on \fname{prboom.wad}
from prboom-2.2.6
\item[Your wad files] Copy all Doom wads you wish to play into that directory.
\end{description}
The needed files can be found at
\url{http://www.rockbox.org/twiki/bin/view/Main/PluginDoom}

To play addon wads create the \fname{addons} directory within doom. 
Place wad files in this directory. Currently doom only supports 10 addons 
in the directory.

A free alternative for Doom 2 is FreeDoom (\url{http://freedoom.sourceforge.net}).
This can be used in place of \fname{doom2.wad}, or it may be used as an addon in 
Doom, by placing it in the \fname{addons} directory.

\subsubsection{Menus}
\begin{description}
  \item[Rockdoom Menu: ] The Rockdoom menu is shown when Doom is first launched.  
This is the only time it can be accessed (before starting the game).  To re-adjust 
Rockdoom options, you will need to quit your current game and restart the plugin.
  \item[Main Menu: ]
  The Doom plugin has a main menu, which is brought up before a game is started. It 
  has the following entries:
  
  \emph{Game } Select which (official) wad to launch\\
  \emph{Addon } Select which unofficial addon wad to launch (From /games/doom/addons directory)\\
  \emph{Demos } Select which demo file to play on game start\\
  \emph{Options } Configure low-level Doom options\\
  \emph{Play Game } Launch the wad/addon/Demo chosen%\\
  
  \item[Options Menu: ]This menu has the following options:
  
  \emph{Sound } Enable or Disable sound in Doom\\
  \emph{Set Keys }  Change the game key configuration\\
  \emph{Time Demo } Run a timed demo, to test game speed on a player (Only runs on Doom Shareware)\\
  \emph{Player Bobbing } Enable or Disable player up/Down movement\\
  \emph{Translucency } Enable or Disable sprite translucency (Fireballs, Plasma...)\\
  \emph{Fake Contrast} Enable or Disable modified game lighting%\\

  \item[InGame Main Menu: ]This menu can only be accessed from within a running game, and is displayed by  \opt{h1xx,h300}{pressing \ButtonOff}\opt{IPOD_4G_PAD}{flipping your hold switch a couple of times}

  \emph{New Game } Start a new game\\
  \emph{Options } In game options\\
  \emph{Load Game } Load a saved game\\
  \emph{Save Game } Save the current game\\
  \emph{Quit } Quit the game%\\

  \item[InGame Options Menu: ]This menu has the folloing options:
  
  \emph{End Game } Ends the current game\\
  \emph{Messages }  Enable or Disable in game messages\\
  \emph{Screen Size } Shrink or Enlarge the displayed portion of the game\\
  \emph{Gamma } Change the brightness (Gamma) of the game\\
  \emph{Sound Volume } Change the sound, music and system volume%\\
  \note{In game music is not currently supported}

\end{description}

\subsubsection{Keys}
\begin{table}
\begin{btnmap}{}{}
\opt{h1xx,h300}{\ButtonUp}
\opt{ipod4g,ipodcolor,ipodvideo}{\ButtonMenu}
& Move Forward \\
\opt{h1xx,h300}{\ButtonDown}
\opt{ipod4g,ipodcolor,ipodvideo}{na}
& Down \\
\opt{h1xx,h300}{\ButtonLeft}
\opt{ipod4g,ipodcolor,ipodvideo}{\fixme{tbd}}
& Turn Left \\
\opt{h1xx,h300}{\ButtonRight}
\opt{ipod4g,ipodcolor,ipodvideo}{\fixme{tbd}}
& Turn Right \\
\opt{h1xx,h300}{\ButtonRec}
\opt{ipod4g,ipodcolor,ipodvideo}{\ButtonPlay}
& Shoot \\
\opt{h1xx,h300}{\ButtonMode}
\opt{ipod4g,ipodcolor,ipodvideo}{\ButtonMenu}
& Open \\
\opt{h1xx,h300}{\ButtonOff}
\opt{ipod4g,ipodcolor,ipodvideo}{\fixme{Hold switch}}
& Escape \\
\opt{h1xx,h300}{\ButtonSelect}
\opt{ipod4g,ipodcolor,ipodvideo}{\fixme{tbd}}
& Enter \\
\opt{h1xx,h300}{\ButtonOn}
\opt{ipod4g,ipodcolor,ipodvideo}{\ButtonSelect}
& Change Weapon \\
\end{btnmap}
\end{table}

\subsubsection{Playing the game}
After installation of the \fname{wad} files is complete you can start the
game.
\fixme{more description is needed}