add link to homepage to about window.
[Rockbox.git] / manual / plugins / doom.tex
blob8eb5fa3c82be2ef3cebe038b5c848a038fc71ff7
1 % $Id$ %
2 \subsection{Doom}
3 \screenshot{plugins/images/ss-doom}{Doom}{}
4 This is the famous Doom game.
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}
18 To play addon wads create the \fname{addons} directory within the doom folder.
19 Place \fname{wad} files in this directory. Currently doom only supports
20 a maximum number of 10 addons
21 in the directory.
23 A free alternative for Doom 2 is FreeDoom (\url{http://freedoom.sourceforge.net}).
24 This can be used in place of \fname{doom2.wad}, or it may be used as an addon in
25 Doom, by placing it in the \fname{addons} directory.
27 \subsubsection{Menus}
28 \begin{description}
29 \item[Rockdoom Menu. ] The Rockdoom menu is shown when Doom is first launched.
30 This is the only time it can be accessed (before starting the game). To re-adjust
31 Rockdoom options, you will need to quit your current game and restart the plugin.
32 \item[Main Menu. ]
33 The Doom plugin has a main menu, which is brought up before a game is started. It
34 has the following entries:
36 \emph{Game. } Select which (official) wad to launch\\
37 \emph{Addon. } Select which unofficial addon wad to launch (From
38 \fname{/.rockbox/doom/addons} directory)\\
39 \emph{Demos. } Select which demo file to play on game start\\
40 \emph{Options. } Configure low-level Doom options\\
41 \emph{Play Game. } Launch the wad/addon/Demo chosen%\\
43 \item[Options Menu. ]This menu has the following options:
45 \emph{Sound. } Enable or Disable sound in Doom\\
46 \emph{Set Keys. } Change the game key configuration\\
47 \emph{Time Demo. } Run a timed demo, to test game speed on a player (Only runs on Doom Shareware)\\
48 \emph{Player Bobbing. } Enable or Disable player up/Down movement\\
49 \emph{Translucency. } Enable or Disable sprite translucency (Fireballs, Plasma...)\\
50 \emph{Fake Contrast.} Enable or Disable modified game lighting\\
51 \emph{Always Run.} Make the player always run\\
52 \emph{Headsup Display.} Show the player status when in fullscreen\\
53 \emph{Statusbar Always Red.} Disable color response statusbar%\\
55 \item[InGame Main Menu. ]This menu can only be accessed from within a running game, and is displayed by
56 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{pressing \ButtonOff}
57 \opt{IPOD_3G_PAD,IPOD_4G_PAD}{flipping your hold switch a couple of times}
58 \opt{IAUDIO_X5_PAD,IRIVER_H10_PAD,SANSA_E200_PAD}{pressing \ButtonPower}
60 \emph{New Game. } Start a new game\\
61 \emph{Options. } In game options\\
62 \emph{Load Game. } Load a saved game\\
63 \emph{Save Game. } Save the current game\\
64 \emph{Quit. } Quit the game%\\
66 \item[InGame Options Menu. ]This menu has the folloing options:
68 \emph{End Game. } Ends the current game\\
69 \emph{Messages. } Enable or Disable in game messages\\
70 \emph{Screen Size. } Shrink or Enlarge the displayed portion of the game\\
71 \emph{Gamma. } Change the brightness (Gamma) of the game\\
72 \emph{Sound Volume. } Change the sound, music and system volume%\\
73 \note{In game music is not currently supported}
75 \end{description}
77 \subsubsection{Keys}
78 \begin{table}
79 \begin{btnmap}{}{}
80 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD,SANSA_E200_PAD,GIGABEAT_PAD}{\ButtonUp}
81 \opt{IPOD_3G_PAD,IPOD_4G_PAD}{\ButtonMenu}
82 \opt{IRIVER_H10_PAD}{\ButtonScrollUp}
83 & Move Forward \\
85 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD,SANSA_E200_PAD,GIGABEAT_PAD}{\ButtonDown & Down\\}
86 \opt{IRIVER_H10_PAD}{\ButtonScrollDown & Down\\}
88 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IPOD_3G_PAD,IPOD_4G_PAD,IAUDIO_X5_PAD,IRIVER_H10_PAD,SANSA_E200_PAD,GIGABEAT_PAD}{\ButtonLeft}
89 & Turn Left \\
91 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IPOD_3G_PAD,IPOD_4G_PAD,IAUDIO_X5_PAD,IRIVER_H10_PAD,SANSA_E200_PAD,GIGABEAT_PAD}{\ButtonRight}
92 & Turn Right \\
94 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonRec}
95 \opt{IPOD_3G_PAD,IPOD_4G_PAD}{\ButtonPlay}
96 \opt{IAUDIO_X5_PAD,SANSA_E200_PAD}{\ButtonSelect}
97 \opt{IRIVER_H10_PAD}{\ButtonRew}
98 \opt{GIGABEAT_PAD}{\ButtonA}
99 & Shoot \\
101 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonMode}
102 \opt{IPOD_3G_PAD,IPOD_4G_PAD}{\ButtonMenu}
103 \opt{IAUDIO_X5_PAD,IRIVER_H10_PAD}{\ButtonPlay}
104 \opt{SANSA_E200_PAD}{\ButtonRec}
105 \opt{GIGABEAT_PAD}{\ButtonMenu}
106 & Open \\
108 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOff}
109 \opt{IPOD_3G_PAD,IPOD_4G_PAD}{Hold switch}
110 \opt{IAUDIO_X5_PAD,IRIVER_H10_PAD,SANSA_E200_PAD,GIGABEAT_PAD}{\ButtonPower}
111 & Escape \\
113 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IPOD_3G_PAD,IPOD_4G_PAD,IAUDIO_X5_PAD,GIGABEAT_PAD}
114 {\ButtonSelect}
115 \opt{IRIVER_H10_PAD}{\ButtonRew}
116 \opt{SANSA_E200_PAD}{\ButtonScrollUp}
117 & Enter \\
119 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOn}
120 \opt{IPOD_3G_PAD,IPOD_4G_PAD}{\ButtonSelect}
121 \opt{IAUDIO_X5_PAD}{\ButtonRec}
122 \opt{IRIVER_H10_PAD}{\ButtonFF}
123 \opt{SANSA_E200_PAD}{\ButtonScrollDown}
124 \opt{GIGABEAT_PAD}{\ButtonVolDown}
125 & Change Weapon \\
127 \end{btnmap}
128 \end{table}
130 \subsubsection{Playing the game}
131 After installation of the \fname{wad} files is complete you can start the
132 game.
133 \fixme{more description is needed}