manual/plugins/doom.tex

   1 % $Id$ %
   2 \subsection{Doom}
   3 \screenshot{plugins/images/ss-doom}{Doom}{}
   4 This is the famous Doom game.
   5
   6 \subsubsection{Getting started}
   7 For the game to run you need \fname{.wad} game files located in
   8 \fname{/.rockbox/doom/} on your player. Create the directory and save the
   9 following files there:
  10 \begin{description}
  11 \item[rockdoom.wad.] The Rockbox \fname{.wad}, based on \fname{prboom.wad}
  12 from prboom-2.2.6
  13 \item[Your wad files.] Copy all Doom wads you wish to play into that directory.
  14 \end{description}
  15 The needed files can be found at
  16 \wikilink{PluginDoom}
  17
  18 To play addon wads create the \fname{addons} directory within the doom directory.
  19 Place \fname{wad} files in this directory. Currently doom only supports
  20 a maximum number of 10 addons.
  21
  22 A free alternative for Doom 2 is FreeDoom (\url{http://freedoom.sourceforge.net}).
  23 This can be used in place of \fname{doom2.wad}, or it may be used as an addon in
  24 Doom, by placing it in the \fname{addons} directory.
  25
  26 \subsubsection{Menus}
  27 \begin{description}
  28   \item[Rockdoom Menu. ] The Rockdoom menu is shown when Doom is first launched.
  29 This is the only time it can be accessed (before starting the game).  To re-adjust
  30 Rockdoom options, you will need to quit your current game and restart the plugin.
  31   \item[Main Menu. ]
  32   The Doom plugin has a main menu, which is brought up before a game is started. It
  33   has the following entries:
  34
  35   \emph{Game. } Select which (official) wad to launch\\
  36   \emph{Addon. } Select which unofficial addon wad to launch (From
  37   \fname{/.rockbox/doom/addons} directory)\\
  38   \emph{Demos. } Select which demo file to play on game start\\
  39   \emph{Options. } Configure low-level Doom options\\
  40   \emph{Play Game. } Launch the wad/addon/Demo chosen%\\
  41
  42   \item[Options Menu. ]This menu has the following options:
  43
  44   \emph{Sound. } Enable or Disable sound in Doom\\
  45   \emph{Set Keys. }  Change the game key configuration\\
  46   \emph{Time Demo. } Run a timed demo, to test game speed on a player (Only runs on Doom Shareware)\\
  47   \emph{Player Bobbing. } Enable or Disable player up/Down movement\\
  48   \emph{Translucency. } Enable or Disable sprite translucency (Fireballs, Plasma...)\\
  49   \emph{Fake Contrast.} Enable or Disable modified game lighting\\
  50   \emph{Always Run.} Make the player always run\\
  51   \emph{Headsup Display.} Show the player status when in fullscreen\\
  52   \emph{Statusbar Always Red.} Disable colour response statusbar%\\
  53
  54   \item[InGame Main Menu. ]This menu can only be accessed from within a running game, and is displayed by
  55     \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{pressing \ButtonOff}%
  56     \opt{IPOD_3G_PAD,IPOD_4G_PAD}{flipping your \ButtonHold{} switch a couple of times}%
  57     \opt{IAUDIO_X5_PAD,IRIVER_H10_PAD,SANSA_E200_PAD,SANSA_C200_PAD,SANSA_CLIP_PAD%
  58          ,GIGABEAT_PAD,GIGABEAT_S_PAD,COWON_D2_PAD}{pressing \ButtonPower}%
  59     \opt{SANSA_FUZE_PAD}{pressing \ButtonHome}
  60     \opt{PBELL_VIBE500_PAD}{pressing \ButtonRec}
  61
  62   \emph{New Game. } Start a new game\\
  63   \emph{Options. } In game options\\
  64   \emph{Load Game. } Load a saved game\\
  65   \emph{Save Game. } Save the current game\\
  66   \emph{Quit. } Quit the game%\\
  67
  68   \item[InGame Options Menu. ]This menu has the folloing options:
  69
  70   \emph{End Game. } Ends the current game\\
  71   \emph{Messages. }  Enable or Disable in game messages\\
  72   \emph{Screen Size. } Shrink or Enlarge the displayed portion of the game\\
  73   \emph{Gamma. } Change the brightness (Gamma) of the game\\
  74   \emph{Sound Volume. } Change the sound, music and system volume%\\
  75   \note{In game music is not currently supported}
  76
  77 \end{description}
  78
  79 \subsubsection{Keys}
  80 \begin{btnmap}
  81   \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD,SANSA_E200_PAD,SANSA_FUZE_PAD,SANSA_C200_PAD,SANSA_CLIP_PAD%
  82       ,GIGABEAT_PAD,GIGABEAT_S_PAD,MROBE100_PAD}{\ButtonUp}
  83   \opt{IPOD_3G_PAD,IPOD_4G_PAD}{\ButtonMenu}
  84   \opt{IRIVER_H10_PAD}{\ButtonScrollUp}
  85   \opt{COWON_D2_PAD}{\TouchTopMiddle}
  86   \opt{PBELL_VIBE500_PAD}{\ButtonOK}
  87        \opt{HAVEREMOTEKEYMAP}{& }
  88     & Move Forward \\
  89 %
  90   \nopt{IPOD_3G_PAD,IPOD_4G_PAD,COWON_D2_PAD}{
  91     \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD,SANSA_E200_PAD,SANSA_FUZE_PAD,SANSA_C200_PAD,SANSA_CLIP_PAD%
  92         ,GIGABEAT_PAD,GIGABEAT_S_PAD,MROBE100_PAD}{\ButtonDown}
  93     \opt{IRIVER_H10_PAD}{\ButtonScrollDown}
  94     \opt{COWON_D2_PAD}{\TouchBottomMiddle}
  95     \opt{PBELL_VIBE500_PAD}{\ButtonCancel}
  96        \opt{HAVEREMOTEKEYMAP}{& }
  97       & Down\\
  98   }
  99 %
 100   \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD,SANSA_E200_PAD,SANSA_CLIP_PAD%
 101       ,SANSA_FUZE_PAD,SANSA_C200_PAD,GIGABEAT_PAD,GIGABEAT_S_PAD,MROBE100_PAD%
 102       ,IPOD_3G_PAD,IPOD_4G_PAD,IRIVER_H10_PAD,PBELL_VIBE500_PAD}{\ButtonLeft}
 103   \opt{COWON_D2_PAD}{\TouchMidLeft}
 104       \opt{HAVEREMOTEKEYMAP}{& }
 105     & Turn Left \\
 106 %
 107   \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD,SANSA_E200_PAD,SANSA_CLIP_PAD%
 108       ,SANSA_FUZE_PAD,SANSA_C200_PAD,GIGABEAT_PAD,GIGABEAT_S_PAD,MROBE100_PAD%
 109       ,IPOD_3G_PAD,IPOD_4G_PAD,IRIVER_H10_PAD,PBELL_VIBE500_PAD}{\ButtonRight}
 110   \opt{COWON_D2_PAD}{\TouchMidRight}
 111       \opt{HAVEREMOTEKEYMAP}{& }
 112     & Turn Right \\
 113 %
 114   \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonRec}
 115   \opt{IPOD_3G_PAD,IPOD_4G_PAD,GIGABEAT_S_PAD}{\ButtonPlay}
 116   \opt{IAUDIO_X5_PAD,SANSA_E200_PAD,SANSA_FUZE_PAD,SANSA_C200_PAD,SANSA_CLIP_PAD}{\ButtonSelect}
 117   \opt{IRIVER_H10_PAD}{\ButtonRew}
 118   \opt{GIGABEAT_PAD}{\ButtonA}
 119   \opt{MROBE100_PAD}{\ButtonDisplay}
 120   \opt{COWON_D2_PAD}{\TouchBottomRight}
 121   \opt{PBELL_VIBE500_PAD}{\ButtonMenu}
 122        \opt{HAVEREMOTEKEYMAP}{& }
 123     & Shoot \\
 124 %
 125   \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonMode}
 126   \opt{IPOD_3G_PAD,IPOD_4G_PAD}{\ButtonMenu}
 127   \opt{IAUDIO_X5_PAD,IRIVER_H10_PAD}{\ButtonPlay}
 128   \opt{SANSA_E200_PAD,SANSA_C200_PAD}{\ButtonRec}
 129   \opt{SANSA_FUZE_PAD}{\ButtonPower}
 130   \opt{SANSA_CLIP_PAD}{\ButtonHome}
 131   \opt{GIGABEAT_PAD,GIGABEAT_S_PAD,MROBE100_PAD}{\ButtonMenu}
 132   \opt{PBELL_VIBE500_PAD}{\ButtonOK}
 133        \opt{HAVEREMOTEKEYMAP}{& }
 134     & Open \\
 135 %
 136   \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOff}
 137   \opt{IPOD_3G_PAD,IPOD_4G_PAD}{\ButtonHold{} switch}
 138   \opt{IAUDIO_X5_PAD,IRIVER_H10_PAD,SANSA_E200_PAD,SANSA_C200_PAD,GIGABEAT_PAD%
 139       ,GIGABEAT_S_PAD,MROBE100_PAD,SANSA_CLIP_PAD}{\ButtonPower}
 140   \opt{SANSA_FUZE_PAD}{\ButtonHome}
 141   \opt{COWON_D2_PAD}{\TouchTopLeft}
 142   \opt{PBELL_VIBE500_PAD}{\ButtonRec}
 143        \opt{HAVEREMOTEKEYMAP}{& }
 144     & InGame Menu \\
 145 %
 146   \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IPOD_3G_PAD,IPOD_4G_PAD,IAUDIO_X5_PAD%
 147       ,GIGABEAT_PAD,GIGABEAT_S_PAD,SANSA_E200_PAD,SANSA_FUZE_PAD,SANSA_C200_PAD%
 148       ,MROBE100_PAD,SANSA_CLIP_PAD}{\ButtonSelect}
 149   \opt{IRIVER_H10_PAD}{\ButtonRew}
 150   \opt{COWON_D2_PAD}{\TouchCenter}
 151   \opt{PBELL_VIBE500_PAD}{\ButtonPower}
 152        \opt{HAVEREMOTEKEYMAP}{& }
 153     & Enter \\
 154 %
 155   \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOn}
 156   \opt{IPOD_3G_PAD,IPOD_4G_PAD}{\ButtonSelect}
 157   \opt{IAUDIO_X5_PAD}{\ButtonRec}
 158   \opt{IRIVER_H10_PAD}{\ButtonFF}
 159   \opt{SANSA_E200_PAD,SANSA_FUZE_PAD}{\ButtonScrollFwd}
 160   \opt{SANSA_C200_PAD,SANSA_CLIP_PAD}{\ButtonVolUp}
 161   \opt{GIGABEAT_PAD,GIGABEAT_S_PAD}{\ButtonVolDown}
 162   \opt{COWON_D2_PAD}{\TouchBottomLeft}
 163   \opt{PBELL_VIBE500_PAD}{\ButtonPlay}
 164        \opt{HAVEREMOTEKEYMAP}{& }
 165     & Change Weapon \\
 166 %
 167 \end{btnmap}
 168
 169 \subsubsection{Playing the game}
 170 After installation of the \fname{wad} files is complete you can start the
 171 game.
 172 \fixme{more description is needed}