1chocolate-hexen(6)               Games Manual               chocolate-hexen(6)
2
3
4

NAME

6       chocolate-hexen - historically compatible Hexen engine
7

SYNOPSIS

9       chocolate-hexen [OPTIONS]
10

DESCRIPTION

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

GENERAL OPTIONS

17       -artiskip
18              Don't allow artifacts to be used when the run key is held down.
19
20       -cdrom [windows only] Save configuration data and savegames in c:\hexn‐
21              data, allowing play from CD.
22
23       -config <file>
24              Load main configuration from the specified file, instead of  the
25              default.
26
27       -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
31       -extraconfig <file>
32              Load additional configuration from the specified  file,  instead
33              of the default.
34
35       -file <files>
36              Load the specified PWAD files.
37
38       -iwad <file>
39              Specify an IWAD file to use.
40
41       -loadgame <s>
42              Load the game in savegame slot s.
43
44       -mb <mb>
45              Specify the heap size, in MiB (default 16).
46
47       -mmap  Use  the OS's virtual memory subsystem to map WAD files directly
48              into memory.
49
50       -nomonsters
51              Disable monsters.
52
53       -nomusic
54              Disable music.
55
56       -nosfx Disable sound effects.
57
58       -nosound
59              Disable all sound output.
60
61       -ravpic
62              Take screenshots when F1 is pressed.
63
64       -respawn
65              Monsters respawn after being killed.
66
67       -savedir <directory>
68              Specify a path from which to load and save games. If the  direc‐
69              tory does not exist then it will automatically be created.
70
71       -scripts <path>
72              Development option to specify path to level scripts.
73
74       -skill <skill>
75              Set  the game skill, 1-5 (1: easiest, 5: hardest).  A skill of 0
76              disables all monsters.
77
78

DISPLAY OPTIONS

80       -1     Don't scale up the screen. Implies -window.
81
82       -2     Double up the screen to 2x its normal size. Implies -window.
83
84       -3     Double up the screen to 3x its normal size. Implies -window.
85
86       -fullscreen
87              Run in fullscreen mode.
88
89       -geometry <WxY>
90              Specify the dimensions of the window. Implies -window.
91
92       -height <y>
93              Specify the screen height, in pixels. Implies -window.
94
95       -noblit
96              Disable blitting the screen.
97
98       -nograbmouse
99              Don't grab the mouse when running in windowed mode.
100
101       -nomouse
102              Disable the mouse.
103
104       -width <x>
105              Specify the screen width, in pixels. Implies -window.
106
107       -window
108              Run in a window.
109
110

DEMO OPTIONS

112       -demoextend
113              Record or playback a demo without automatically  quitting  after
114              either level exit or player respawn.
115
116       -longtics
117              Record or playback a demo with high resolution turning.
118
119       -maxdemo <size>
120              Specify the demo buffer size (KiB)
121
122       -playdemo <demo>
123              Play back the demo named demo.lmp.
124
125       -shortticfix
126              Smooth out low resolution turning when recording a demo.
127
128       -strictdemos
129              When  recording or playing back demos, disable any extensions of
130              the vanilla demo format - record demos as vanilla would do,  and
131              play back demos as vanilla would do.
132
133       -timedemo <demo>
134              Play  back the demo named demo.lmp, determining the framerate of
135              the screen.
136
137

NETWORKING OPTIONS

139       -autojoin
140              Automatically search the local LAN for a multiplayer server  and
141              join it.
142
143       -class <n>
144              Specify player class: 0=fighter, 1=cleric, 2=mage, 3=pig.
145
146       -connect <address>
147              Connect to a multiplayer server running on the given address.
148
149       -deathmatch
150              Start a deathmatch game.
151
152       -dup <n>
153              Reduce the resolution of the game by a factor of n, reducing the
154              amount of network bandwidth needed.
155
156       -extratics <n>
157              Send n extra tics in every packet as insurance  against  dropped
158              packets.
159
160       -newsync
161              Use  new  network  client sync code rather than the classic sync
162              code. This is currently disabled by default because it has  some
163              bugs.
164
165       -nodes <n>
166              Autostart  the  netgame  when  n nodes (clients) have joined the
167              server.
168
169       -port <n>
170              Use the specified UDP port for communications,  instead  of  the
171              default (2342).
172
173       -privateserver
174              When  running  a  server,  don't register with the global master
175              server. Implies -server.
176
177       -randclass
178              In deathmatch mode, change a player's class each time the player
179              respawns.
180
181       -server
182              Start a multiplayer server, listening for connections.
183
184       -servername <name>
185              When starting a network server, specify a name for the server.
186
187       -solo-net
188              Start  the  game  playing  as  though in a netgame with a single
189              player.  This can also  be  used  to  play  back  single  player
190              netgame demos.
191
192       -timer <n>
193              For multiplayer games: exit each level after n minutes.
194
195

DEHACKED AND WAD MERGING

197       -aa <files>
198              Equivalent to "-af <files> -as <files>".
199
200       -af <files>
201              Simulates  the  behavior of NWT's -af option, merging flats into
202              the main IWAD directory.  Multiple files may be specified.
203
204       -as <files>
205              Simulates the behavior of NWT's -as option, merging sprites into
206              the main IWAD directory.  Multiple files may be specified.
207
208       -deh <files>
209              Load the given dehacked patch(es)
210
211       -merge <files>
212              Simulates the behavior of deutex's -merge option, merging a PWAD
213              into the main IWAD.  Multiple files may be specified.
214
215       -nocheats
216              Ignore cheats in dehacked files.
217
218       -nwtmerge <files>
219              Simulates the behavior of NWT's -merge option.   Multiple  files
220              may be specified.
221
222

COMPATIBILITY

224       -setmem <version>
225              Specify DOS version to emulate for NULL pointer dereference emu‐
226              lation.  Supported versions  are:  dos622,  dos71,  dosbox.  The
227              default is to emulate DOS 7.1 (Windows 98).
228
229       -v10override
230              If  provided, the check for the v1.0 IWAD file is disabled, even
231              though it will almost certainly cause the game to crash.
232

IWAD SEARCH PATHS

234       To play, an IWAD file is needed. This is a large file containing all of
235       the levels, graphics, sound effects, music and other material that make
236       up the game. IWAD files are named according to the game;  the  standard
237       names are:
238
239       doom.wad, doom1.wad, doom2.wad, tnt.wad, plutonia.wad
240              Doom, Doom II, Final Doom
241
242       heretic.wad, heretic1.wad, hexen.wad, strife1.wad
243              Heretic, Hexen and Strife (commercial Doom engine games).
244
245       hacx.wad, chex.wad
246              Hacx  and  Chex  Quest  -  more  obscure games based on the Doom
247              engine.
248
249       freedm.wad, freedoom1.wad, freedoom2.wad
250              The Freedoom open content IWAD files.
251
252       The following directory paths are searched in order to find an IWAD:
253
254       Current working directory
255              Any IWAD files found in the current working  directory  will  be
256              used in preference to IWADs found in any other directories.
257
258       DOOMWADDIR
259              This environment variable can be set to contain a path to a sin‐
260              gle directory in which to look for IWAD files. This  environment
261              variable is supported by most Doom source ports.
262
263       DOOMWADPATH
264              This environment variable, if set, can contain a colon-separated
265              list of directories in which to look for IWAD files, or alterna‐
266              tively full paths to specific IWAD files.
267
268       $HOME/.local/share/games/doom
269              Writeable  directory  in the user's home directory. The path can
270              be overridden using the XDG_DATA_HOME environment variable  (see
271              the XDG Base Directory Specification).
272
273       /usr/local/share/games/doom, /usr/share/games/doom
274              System-wide  locations  that  can  be accessed by all users. The
275              path /usr/share/games/doom is a standard path that is  supported
276              by  most  Doom source ports. These paths can be overridden using
277              the XDG_DATA_DIRS environment variable (see the XDG Base  Direc‐
278              tory Specification).
279
280       The above can be overridden on a one-time basis by using the -iwad com‐
281       mand line parameter to provide the path to an IWAD file  to  use.  This
282       parameter  can also be used to specify the name of a particular IWAD to
283       use from one of the above paths. For  example,  '-iwad  doom.wad'  will
284       search the above paths for the file doom.wad to use.
285

ENVIRONMENT

287       This  section  describes  environment  variables that control Chocolate
288       Hexen's behavior.
289
290       DOOMWADDIR, DOOMWADPATH
291              See the section, IWAD SEARCH PATHS above.
292
293       PCSOUND_DRIVER
294              When running in PC speaker sound effect mode,  this  environment
295              variable  specifies  a PC speaker driver to use for sound effect
296              playback.  Valid options are "Linux" for the Linux console  mode
297              driver,  "BSD"  for  the  NetBSD/OpenBSD  PC speaker driver, and
298              "SDL" for SDL-based emulated PC speaker playback (using the dig‐
299              ital output).
300
301       OPL_DRIVER
302              When  using  OPL MIDI playback, this environment variable speci‐
303              fies an OPL backend driver to use.  Valid options are "SDL"  for
304              an  SDL-based  software emulated OPL chip, "Linux" for the Linux
305              hardware OPL driver, and "OpenBSD" for the OpenBSD/NetBSD  hard‐
306              ware OPL driver.
307
308              Generally  speaking, a real hardware OPL chip sounds better than
309              software  emulation;  however,  modern  machines  do  not  often
310              include  one. If present, it may still require extra work to set
311              up and elevated security privileges to access.
312
313

FILES

315       $HOME/.local/share/chocolate-doom/hexen.cfg
316              The  main  configuration  file   for   Chocolate   Hexen.    See
317              hexen.cfg(5).
318
319       $HOME/.local/share/chocolate-doom/chocolate-hexen.cfg
320              Extra  configuration values that are specific to Chocolate Hexen
321              and not present in Vanilla Hexen.  See chocolate-hexen.cfg(5).
322

SEE ALSO

324       chocolate-doom(6),  chocolate-heretic(6),  chocolate-server(6),  choco‐
325       late-setup(6)
326

AUTHOR

328       Chocolate  Hexen  is  part  of  the Chocolate Doom project, written and
329       maintained by Simon Howard. It is  based  on  the  Hexen  source  code,
330       released by Raven Software.
331
333       Copyright  ©  id  Software Inc.  Copyright © Raven Software Inc.  Copy‐
334       right © 2005-2013 Simon Howard.
335       This is free software.  You may redistribute copies  of  it  under  the
336       terms       of       the      GNU      General      Public      License
337       <http://www.gnu.org/licenses/gpl.html>.  There is NO WARRANTY,  to  the
338       extent permitted by law.
339
340
341
342
343                                                            chocolate-hexen(6)
Impressum