summaryrefslogtreecommitdiff
path: root/manual/plugins/doom.tex
blob: da0fd44319848074c5e6a9532e3fb5280733070c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
% $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{/.rockbox/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
\wikilink{PluginDoom}

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

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 
  \fname{/.rockbox/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\\
  \emph{Always Run.} Make the player always run\\
  \emph{Headsup Display.} Show the player status when in fullscreen\\
  \emph{Statusbar Always Red.} Disable colour response statusbar%\\

  \item[InGame Main Menu. ]This menu can only be accessed from within a running game, and is displayed by
    \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{pressing \ButtonOff}%
    \opt{IPOD_3G_PAD,IPOD_4G_PAD}{flipping your \ButtonHold{} switch a couple of times}%
    \opt{IAUDIO_X5_PAD,IRIVER_H10_PAD,SANSA_E200_PAD,SANSA_C200_PAD,SANSA_CLIP_PAD%
         ,GIGABEAT_PAD,GIGABEAT_S_PAD,COWON_D2_PAD}{pressing \ButtonPower}%
    \opt{SANSA_FUZE_PAD}{pressing \ButtonHome}
    \opt{PBELL_VIBE500_PAD}{pressing \ButtonRec}

  \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 following 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{btnmap}
  \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD,SANSA_E200_PAD,SANSA_FUZE_PAD,SANSA_C200_PAD,SANSA_CLIP_PAD%
      ,GIGABEAT_PAD,GIGABEAT_S_PAD,MROBE100_PAD}{\ButtonUp}
  \opt{IPOD_3G_PAD,IPOD_4G_PAD}{\ButtonMenu}
  \opt{IRIVER_H10_PAD}{\ButtonScrollUp}
  \opt{COWON_D2_PAD}{\TouchTopMiddle}
  \opt{PBELL_VIBE500_PAD}{\ButtonOK}
       \opt{HAVEREMOTEKEYMAP}{& }
    & Move Forward \\
%
  \nopt{IPOD_3G_PAD,IPOD_4G_PAD,COWON_D2_PAD}{
    \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD,SANSA_E200_PAD,SANSA_FUZE_PAD,SANSA_C200_PAD,SANSA_CLIP_PAD%
        ,GIGABEAT_PAD,GIGABEAT_S_PAD,MROBE100_PAD}{\ButtonDown}
    \opt{IRIVER_H10_PAD}{\ButtonScrollDown}
    \opt{COWON_D2_PAD}{\TouchBottomMiddle}
    \opt{PBELL_VIBE500_PAD}{\ButtonCancel}
       \opt{HAVEREMOTEKEYMAP}{& }
      & Down\\
  }
%
  \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD,SANSA_E200_PAD,SANSA_CLIP_PAD%
      ,SANSA_FUZE_PAD,SANSA_C200_PAD,GIGABEAT_PAD,GIGABEAT_S_PAD,MROBE100_PAD%
      ,IPOD_3G_PAD,IPOD_4G_PAD,IRIVER_H10_PAD,PBELL_VIBE500_PAD}{\ButtonLeft}
  \opt{COWON_D2_PAD}{\TouchMidLeft}
      \opt{HAVEREMOTEKEYMAP}{& }
    & Turn Left \\
%
  \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD,SANSA_E200_PAD,SANSA_CLIP_PAD%
      ,SANSA_FUZE_PAD,SANSA_C200_PAD,GIGABEAT_PAD,GIGABEAT_S_PAD,MROBE100_PAD%
      ,IPOD_3G_PAD,IPOD_4G_PAD,IRIVER_H10_PAD,PBELL_VIBE500_PAD}{\ButtonRight}
  \opt{COWON_D2_PAD}{\TouchMidRight}
      \opt{HAVEREMOTEKEYMAP}{& }
    & Turn Right \\
%
  \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonRec}
  \opt{IPOD_3G_PAD,IPOD_4G_PAD,GIGABEAT_S_PAD}{\ButtonPlay}
  \opt{IAUDIO_X5_PAD,SANSA_E200_PAD,SANSA_FUZE_PAD,SANSA_C200_PAD,SANSA_CLIP_PAD}{\ButtonSelect}
  \opt{IRIVER_H10_PAD}{\ButtonRew}
  \opt{GIGABEAT_PAD}{\ButtonA}
  \opt{MROBE100_PAD}{\ButtonDisplay}
  \opt{COWON_D2_PAD}{\TouchBottomRight}
  \opt{PBELL_VIBE500_PAD}{\ButtonMenu}
       \opt{HAVEREMOTEKEYMAP}{& }
    & Shoot \\
%
  \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonMode}
  \opt{IPOD_3G_PAD,IPOD_4G_PAD}{\ButtonMenu}
  \opt{IAUDIO_X5_PAD,IRIVER_H10_PAD}{\ButtonPlay}
  \opt{SANSA_E200_PAD,SANSA_C200_PAD}{\ButtonRec}
  \opt{SANSA_FUZE_PAD}{\ButtonPower}
  \opt{SANSA_CLIP_PAD}{\ButtonHome}
  \opt{GIGABEAT_PAD,GIGABEAT_S_PAD,MROBE100_PAD}{\ButtonMenu}
  \opt{PBELL_VIBE500_PAD}{\ButtonOK}
       \opt{HAVEREMOTEKEYMAP}{& }
    & Open \\
%
  \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOff}
  \opt{IPOD_3G_PAD,IPOD_4G_PAD}{\ButtonHold{} switch}
  \opt{IAUDIO_X5_PAD,IRIVER_H10_PAD,SANSA_E200_PAD,SANSA_C200_PAD,GIGABEAT_PAD%
      ,GIGABEAT_S_PAD,MROBE100_PAD,SANSA_CLIP_PAD}{\ButtonPower}
  \opt{SANSA_FUZE_PAD}{\ButtonHome}
  \opt{COWON_D2_PAD}{\TouchTopLeft}
  \opt{PBELL_VIBE500_PAD}{\ButtonRec}
       \opt{HAVEREMOTEKEYMAP}{& }
    & InGame Menu \\
%
  \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IPOD_3G_PAD,IPOD_4G_PAD,IAUDIO_X5_PAD%
      ,GIGABEAT_PAD,GIGABEAT_S_PAD,SANSA_E200_PAD,SANSA_FUZE_PAD,SANSA_C200_PAD%
      ,MROBE100_PAD,SANSA_CLIP_PAD}{\ButtonSelect}
  \opt{IRIVER_H10_PAD}{\ButtonRew}
  \opt{COWON_D2_PAD}{\TouchCenter}
  \opt{PBELL_VIBE500_PAD}{\ButtonPower}
       \opt{HAVEREMOTEKEYMAP}{& }
    & Enter \\
%
  \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOn}
  \opt{IPOD_3G_PAD,IPOD_4G_PAD}{\ButtonSelect}
  \opt{IAUDIO_X5_PAD}{\ButtonRec}
  \opt{IRIVER_H10_PAD}{\ButtonFF}
  \opt{SANSA_E200_PAD,SANSA_FUZE_PAD}{\ButtonScrollFwd}
  \opt{SANSA_C200_PAD,SANSA_CLIP_PAD}{\ButtonVolUp}
  \opt{GIGABEAT_PAD,GIGABEAT_S_PAD}{\ButtonVolDown}
  \opt{COWON_D2_PAD}{\TouchBottomLeft}
  \opt{PBELL_VIBE500_PAD}{\ButtonPlay}
       \opt{HAVEREMOTEKEYMAP}{& }
    & Change Weapon \\
%
\end{btnmap}

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