1chocolate-hexen(6) Games Manual chocolate-hexen(6)
2
6 chocolate-hexen - historically compatible Hexen engine
7
9 chocolate-hexen [OPTIONS]
10
12 Chocolate Hexen is a port of Raven Software's 1995 game "Hexen" that
13 aims to behave as similar to the original DOS version of Hexen as pos‐
14 sible.
15
17 -artiskip
18 Don't allow artifacts to be used when the run key is held down.
19 -cdrom [windows only] Save configuration data and savegames in c:\hexn‐
21 data, allowing play from CD.
22 -config <file>
24 Load main configuration from the specified file, instead of the
25 default.
26 -dumpsubstconfig <filename>
28 Read all MIDI files from loaded WAD files, dump an example sub‐
29 stitution music config file to the specified filename and quit.
30 -extraconfig <file>
32 Load additional configuration from the specified file, instead
33 of the default.
34 -file <files>
36 Load the specified PWAD files.
37 -iwad <file>
39 Specify an IWAD file to use.
40 -loadgame <s>
42 Load the game in savegame slot s.
43 -mb <mb>
45 Specify the heap size, in MiB (default 16).
46 -mmap Use the OS's virtual memory subsystem to map WAD files directly
48 into memory.
49 -nomonsters
51 Disable monsters.
52 -nomusic
54 Disable music.
55 -nosfx Disable sound effects.
57 -nosound
59 Disable all sound output.
60 -ravpic
62 Take screenshots when F1 is pressed.
63 -respawn
65 Monsters respawn after being killed.
66 -scripts <path>
68 Development option to specify path to level scripts.
69 -skill <skill>
71 Set the game skill, 1-5 (1: easiest, 5: hardest). A skill of 0
72 disables all monsters.
73
76 -setmem <version>
77 Specify DOS version to emulate for NULL pointer dereference emu‐
78 lation. Supported versions are: dos622, dos71, dosbox. The
79 default is to emulate DOS 7.1 (Windows 98).
80 -v10override
82 If provided, the check for the v1.0 IWAD file is disabled, even
83 though it will almost certainly cause the game to crash.
84
87 -demoextend
88 Record or playback a demo without automatically quitting after
89 either level exit or player respawn.
90 -longtics
92 Record or playback a demo with high resolution turning.
93 -maxdemo <size>
95 Specify the demo buffer size (KiB)
96 -playdemo <demo>
98 Play back the demo named demo.lmp.
99 -shortticfix
101 Smooth out low resolution turning when recording a demo.
102 -strictdemos
104 When recording or playing back demos, disable any extensions of
105 the vanilla demo format - record demos as vanilla would do, and
106 play back demos as vanilla would do.
107 -timedemo <demo>
109 Play back the demo named demo.lmp, determining the framerate of
110 the screen.
111
114 -1 Don't scale up the screen.
115 -2 Double up the screen to 2x its normal size.
117 -3 Double up the screen to 3x its normal size.
119 -8in32 Set the color depth of the screen to 32 bits per pixel.
121 -bpp <bpp>
123 Specify the color depth of the screen, in bits per pixel.
124 -fullscreen
126 Run in fullscreen mode.
127 -geometry <WxY>[wf]
129 Specify the dimensions of the window or fullscreen mode. An
130 optional letter of w or f appended to the dimensions selects
131 windowed or fullscreen mode.
132 -grabmouse
134 Grab the mouse when running in windowed mode.
135 -height <y>
137 Specify the screen height, in pixels.
138 -noblit
140 Disable blitting the screen.
141 -nograbmouse
143 Don't grab the mouse when running in windowed mode.
144 -nomouse
146 Disable the mouse.
147 -nonovert
149 Enable vertical mouse movement.
150 -novert
152 Disable vertical mouse movement.
153 -width <x>
155 Specify the screen width, in pixels.
156 -window
158 Run in a window.
159
162 -autojoin
163 Automatically search the local LAN for a multiplayer server and
164 join it.
165 -class <n>
167 Specify player class: 0=fighter, 1=cleric, 2=mage, 3=pig.
168 -connect <address>
170 Connect to a multiplayer server running on the given address.
171 -deathmatch
173 Start a deathmatch game.
174 -dup <n>
176 Reduce the resolution of the game by a factor of n, reducing the
177 amount of network bandwidth needed.
178 -extratics <n>
180 Send n extra tics in every packet as insurance against dropped
181 packets.
182 -ignoreversion
184 When running a netgame server, ignore version mismatches between
185 the server and the client. Using this option may cause game
186 desyncs to occur, or differences in protocol may mean the
187 netgame will simply not function at all.
188 -newsync
190 Use new network client sync code rather than the classic sync
191 code. This is currently disabled by default because it has some
192 bugs.
193 -nodes <n>
195 Autostart the netgame when n nodes (clients) have joined the
196 server.
197 -port <n>
199 Use the specified UDP port for communications, instead of the
200 default (2342).
201 -privateserver
203 When running a server, don't register with the global master
204 server. Implies -server.
205 -randclass
207 In deathmatch mode, change a player's class each time the player
208 respawns.
209 -server
211 Start a multiplayer server, listening for connections.
212 -servername <name>
214 When starting a network server, specify a name for the server.
215 -solo-net
217 Start the game playing as though in a netgame with a single
218 player. This can also be used to play back single player
219 netgame demos.
220 -timer <n>
222 For multiplayer games: exit each level after n minutes.
223
226 -aa <files>
227 Equivalent to "-af <files> -as <files>".
228 -af <files>
230 Simulates the behavior of NWT's -af option, merging flats into
231 the main IWAD directory. Multiple files may be specified.
232 -as <files>
234 Simulates the behavior of NWT's -as option, merging sprites into
235 the main IWAD directory. Multiple files may be specified.
236 -deh <files>
238 Load the given dehacked patch(es)
239 -merge <files>
241 Simulates the behavior of deutex's -merge option, merging a PWAD
242 into the main IWAD. Multiple files may be specified.
243 -nocheats
245 Ignore cheats in dehacked files.
246 -nwtmerge <files>
248 Simulates the behavior of NWT's -merge option. Multiple files
249 may be specified.
250
252 To play, an IWAD file is needed. This is a large file containing all of
253 the levels, graphics, sound effects, music and other material that make
254 up the game. IWAD files are named according to the game; the standard
255 names are:
256 doom.wad, doom1.wad, doom2.wad, tnt.wad, plutonia.wad
258 Doom, Doom II, Final Doom
259 heretic.wad, heretic1.wad, hexen.wad, strife1.wad
261 Heretic, Hexen and Strife (commercial Doom engine games).
262 hacx.wad, chex.wad
264 Hacx and Chex Quest - more obscure games based on the Doom
265 engine.
266 freedm.wad, freedoom1.wad, freedoom2.wad
268 The Freedoom open content IWAD files.
269 The following directory paths are searched in order to find an IWAD:
271 Current working directory
273 Any IWAD files found in the current working directory will be
274 used in preference to IWADs found in any other directories.
275 DOOMWADDIR
277 This environment variable can be set to contain a path to a sin‐
278 gle directory in which to look for IWAD files. This environment
279 variable is supported by most Doom source ports.
280 DOOMWADPATH
282 This environment variable, if set, can contain a colon-separated
283 list of directories in which to look for IWAD files, or alterna‐
284 tively full paths to specific IWAD files.
285 $HOME/.local/share/games/doom
287 Writeable directory in the user's home directory. The path can
288 be overridden using the XDG_DATA_HOME environment variable (see
289 the XDG Base Directory Specification).
290 /usr/local/share/games/doom, /usr/share/games/doom
292 System-wide locations that can be accessed by all users. The
293 path /usr/share/games/doom is a standard path that is supported
294 by most Doom source ports. These paths can be overridden using
295 the XDG_DATA_DIRS environment variable (see the XDG Base Direc‐
296 tory Specification).
297 The above can be overridden on a one-time basis by using the -iwad com‐
299 mand line parameter to provide the path to an IWAD file to use. This
300 parameter can also be used to specify the name of a particular IWAD to
301 use from one of the above paths. For example, '-iwad doom.wad' will
302 search the above paths for the file doom.wad to use.
303
305 This section describes environment variables that control Chocolate
306 Hexen's behavior.
307 DOOMWADDIR, DOOMWADPATH
309 See the section, IWAD SEARCH PATHS above.
310 PCSOUND_DRIVER
312 When running in PC speaker sound effect mode, this environment
313 variable specifies a PC speaker driver to use for sound effect
314 playback. Valid options are "Linux" for the Linux console mode
315 driver, "BSD" for the NetBSD/OpenBSD PC speaker driver, and
316 "SDL" for SDL-based emulated PC speaker playback (using the dig‐
317 ital output).
318 OPL_DRIVER
320 When using OPL MIDI playback, this environment variable speci‐
321 fies an OPL backend driver to use. Valid options are "SDL" for
322 an SDL-based software emulated OPL chip, "Linux" for the Linux
323 hardware OPL driver, and "OpenBSD" for the OpenBSD/NetBSD hard‐
324 ware OPL driver.
325 Generally speaking, a real hardware OPL chip sounds better than
327 software emulation; however, modern machines do not often
328 include one. If present, it may still require extra work to set
329 up and elevated security privileges to access.
330
333 $HOME/.chocolate-doom/hexen.cfg
334 The main configuration file for Chocolate Hexen. See
335 hexen.cfg(5).
336 $HOME/.chocolate-doom/chocolate-hexen.cfg
338 Extra configuration values that are specific to Chocolate Hexen
339 and not present in Vanilla Hexen. See chocolate-hexen.cfg(5).
340
342 chocolate-doom(6), chocolate-heretic(6), chocolate-server(6), choco‐
343 late-setup(6)
344
346 Chocolate Hexen is part of the Chocolate Doom project, written and
347 maintained by Simon Howard. It is based on the Hexen source code,
348 released by Raven Software.
349
351 Copyright © id Software Inc. Copyright © Raven Software Inc. Copy‐
352 right © 2005-2013 Simon Howard.
353 This is free software. You may redistribute copies of it under the
354 terms of the GNU General Public License
355 <http://www.gnu.org/licenses/gpl.html>. There is NO WARRANTY, to the
356 extent permitted by law.
357 chocolate-hexen(6)