Remove unnecessary (and incorrect) acks after stalling the control endpoint
[kugel-rb.git] / manual / plugins / doom.tex
blob9cd9729feee4f1798a08cf941e75f625d23854d1
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 directory.
19 Place \fname{wad} files in this directory. Currently doom only supports
20 a maximum number of 10 addons.
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.
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:
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%\\
42 \item[Options Menu. ]This menu has the following options:
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%\\
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%
58 ,GIGABEAT_PAD,GIGABEAT_S_PAD,COWON_D2_PAD}{pressing \ButtonPower}%
59 \opt{SANSA_FUZE_PAD}{pressing \ButtonHome}
61 \emph{New Game. } Start a new game\\
62 \emph{Options. } In game options\\
63 \emph{Load Game. } Load a saved game\\
64 \emph{Save Game. } Save the current game\\
65 \emph{Quit. } Quit the game%\\
67 \item[InGame Options Menu. ]This menu has the folloing options:
69 \emph{End Game. } Ends the current game\\
70 \emph{Messages. } Enable or Disable in game messages\\
71 \emph{Screen Size. } Shrink or Enlarge the displayed portion of the game\\
72 \emph{Gamma. } Change the brightness (Gamma) of the game\\
73 \emph{Sound Volume. } Change the sound, music and system volume%\\
74 \note{In game music is not currently supported}
76 \end{description}
78 \subsubsection{Keys}
79 \begin{table}
80 \begin{btnmap}{}{}
81 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD,SANSA_E200_PAD,SANSA_FUZE_PAD,SANSA_C200_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{HAVEREMOTEKEYMAP}{& }
87 & Move Forward \\
89 \nopt{IPOD_3G_PAD,IPOD_4G_PAD,COWON_D2_PAD}{
90 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD,SANSA_E200_PAD,SANSA_FUZE_PAD,SANSA_C200_PAD%
91 ,GIGABEAT_PAD,GIGABEAT_S_PAD,MROBE100_PAD}{\ButtonDown}
92 \opt{IRIVER_H10_PAD}{\ButtonScrollDown}
93 \opt{COWON_D2_PAD}{\TouchBottomMiddle}
94 \opt{HAVEREMOTEKEYMAP}{& }
95 & Down\\
98 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD,SANSA_E200_PAD%
99 ,SANSA_FUZE_PAD,SANSA_C200_PAD,GIGABEAT_PAD,GIGABEAT_S_PAD,MROBE100_PAD%
100 ,IPOD_3G_PAD,IPOD_4G_PAD,IRIVER_H10_PAD}{\ButtonLeft}
101 \opt{COWON_D2_PAD}{\TouchMidLeft}
102 \opt{HAVEREMOTEKEYMAP}{& }
103 & Turn Left \\
105 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD,SANSA_E200_PAD%
106 ,SANSA_FUZE_PAD,SANSA_C200_PAD,GIGABEAT_PAD,GIGABEAT_S_PAD,MROBE100_PAD%
107 ,IPOD_3G_PAD,IPOD_4G_PAD,IRIVER_H10_PAD}{\ButtonRight}
108 \opt{COWON_D2_PAD}{\TouchMidRight}
109 \opt{HAVEREMOTEKEYMAP}{& }
110 & Turn Right \\
112 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonRec}
113 \opt{IPOD_3G_PAD,IPOD_4G_PAD,GIGABEAT_S_PAD}{\ButtonPlay}
114 \opt{IAUDIO_X5_PAD,SANSA_E200_PAD,SANSA_FUZE_PAD,SANSA_C200_PAD}{\ButtonSelect}
115 \opt{IRIVER_H10_PAD}{\ButtonRew}
116 \opt{GIGABEAT_PAD}{\ButtonA}
117 \opt{MROBE100_PAD}{\ButtonDisplay}
118 \opt{COWON_D2_PAD}{\TouchBottomRight}
119 \opt{HAVEREMOTEKEYMAP}{& }
120 & Shoot \\
122 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonMode}
123 \opt{IPOD_3G_PAD,IPOD_4G_PAD}{\ButtonMenu}
124 \opt{IAUDIO_X5_PAD,IRIVER_H10_PAD}{\ButtonPlay}
125 \opt{SANSA_E200_PAD,SANSA_C200_PAD}{\ButtonRec}
126 \opt{SANSA_FUZE_PAD}{\ButtonPower}
127 \opt{GIGABEAT_PAD,GIGABEAT_S_PAD,MROBE100_PAD}{\ButtonMenu}
128 \opt{HAVEREMOTEKEYMAP}{& }
129 & Open \\
131 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOff}
132 \opt{IPOD_3G_PAD,IPOD_4G_PAD}{\ButtonHold{} switch}
133 \opt{IAUDIO_X5_PAD,IRIVER_H10_PAD,SANSA_E200_PAD,SANSA_C200_PAD,GIGABEAT_PAD%
134 ,GIGABEAT_S_PAD,MROBE100_PAD}{\ButtonPower}
135 \opt{SANSA_FUZE_PAD}{\ButtonHome}
136 \opt{COWON_D2_PAD}{\TouchTopLeft}
137 \opt{HAVEREMOTEKEYMAP}{& }
138 & InGame Menu \\
140 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IPOD_3G_PAD,IPOD_4G_PAD,IAUDIO_X5_PAD%
141 ,GIGABEAT_PAD,GIGABEAT_S_PAD,SANSA_E200_PAD,SANSA_FUZE_PAD,SANSA_C200_PAD%
142 ,MROBE100_PAD}{\ButtonSelect}
143 \opt{IRIVER_H10_PAD}{\ButtonRew}
144 \opt{COWON_D2_PAD}{\TouchCenter}
145 \opt{HAVEREMOTEKEYMAP}{& }
146 & Enter \\
148 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOn}
149 \opt{IPOD_3G_PAD,IPOD_4G_PAD}{\ButtonSelect}
150 \opt{IAUDIO_X5_PAD}{\ButtonRec}
151 \opt{IRIVER_H10_PAD}{\ButtonFF}
152 \opt{SANSA_E200_PAD,SANSA_FUZE_PAD}{\ButtonScrollFwd}
153 \opt{SANSA_C200_PAD}{\ButtonVolUp}
154 \opt{GIGABEAT_PAD,GIGABEAT_S_PAD}{\ButtonVolDown}
155 \opt{COWON_D2_PAD}{\TouchBottomLeft}
156 \opt{HAVEREMOTEKEYMAP}{& }
157 & Change Weapon \\
159 \end{btnmap}
160 \end{table}
162 \subsubsection{Playing the game}
163 After installation of the \fname{wad} files is complete you can start the
164 game.
165 \fixme{more description is needed}