1chocolate-heretic(6) Games Manual chocolate-heretic(6)
2
6 chocolate-heretic - historically compatible Heretic engine
7
9 chocolate-heretic [OPTIONS]
10
12 Chocolate Heretic is a port of Raven Software's 1994 game "Heretic"
13 that aims to behave as similar to the original DOS version of Heretic
14 as possible.
15
17 -cdrom [windows only] Save configuration data and savegames in
18 c:\heretic.cd, allowing play from CD.
19 -config <file>
21 Load main configuration from the specified file, instead of the
22 default.
23 -dumpsubstconfig <filename>
25 Read all MIDI files from loaded WAD files, dump an example sub‐
26 stitution music config file to the specified filename and quit.
27 -episode <n>
29 Start playing on episode n (1-4)
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 -noartiskip
51 Allow artifacts to be used when the run key is held down.
52 -nomonsters
54 Disable monsters.
55 -nomusic
57 Disable music.
58 -nosfx Disable sound effects.
60 -nosound
62 Disable all sound output.
63 -ravpic
65 Take screenshots when F1 is pressed.
66 -respawn
68 Monsters respawn after being killed.
69 -skill <skill>
71 Set the game skill, 1-5 (1: easiest, 5: hardest). A skill of 0
72 disables all monsters.
73 -warp <x> <y>
75 Start a game immediately, warping to level ExMy.
76
79 -setmem <version>
80 Specify DOS version to emulate for NULL pointer dereference emu‐
81 lation. Supported versions are: dos622, dos71, dosbox. The
82 default is to emulate DOS 7.1 (Windows 98).
83
86 -demoextend
87 Record or playback a demo without automatically quitting after
88 either level exit or player respawn.
89 -longtics
91 Record or playback a demo with high resolution turning.
92 -maxdemo <size>
94 Specify the demo buffer size (KiB)
95 -playdemo <demo>
97 Play back the demo named demo.lmp.
98 -record <x>
100 Record a demo named x.lmp.
101 -recordfrom <savenum> <demofile>
103 Record a demo, loading from the given filename. Equivalent to
104 -loadgame <savenum> -record <demofile>.
105 -shortticfix
107 Smooth out low resolution turning when recording a demo.
108 -strictdemos
110 When recording or playing back demos, disable any extensions of
111 the vanilla demo format - record demos as vanilla would do, and
112 play back demos as vanilla would do.
113 -timedemo <demo>
115 Play back the demo named demo.lmp, determining the framerate of
116 the screen.
117
120 -1 Don't scale up the screen.
121 -2 Double up the screen to 2x its normal size.
123 -3 Double up the screen to 3x its normal size.
125 -8in32 Set the color depth of the screen to 32 bits per pixel.
127 -bpp <bpp>
129 Specify the color depth of the screen, in bits per pixel.
130 -fullscreen
132 Run in fullscreen mode.
133 -geometry <WxY>[wf]
135 Specify the dimensions of the window or fullscreen mode. An
136 optional letter of w or f appended to the dimensions selects
137 windowed or fullscreen mode.
138 -grabmouse
140 Grab the mouse when running in windowed mode.
141 -height <y>
143 Specify the screen height, in pixels.
144 -noblit
146 Disable blitting the screen.
147 -nograbmouse
149 Don't grab the mouse when running in windowed mode.
150 -nomouse
152 Disable the mouse.
153 -nonovert
155 Enable vertical mouse movement.
156 -novert
158 Disable vertical mouse movement.
159 -width <x>
161 Specify the screen width, in pixels.
162 -window
164 Run in a window.
165
168 -autojoin
169 Automatically search the local LAN for a multiplayer server and
170 join it.
171 -connect <address>
173 Connect to a multiplayer server running on the given address.
174 -deathmatch
176 Start a deathmatch game.
177 -dup <n>
179 Reduce the resolution of the game by a factor of n, reducing the
180 amount of network bandwidth needed.
181 -extratics <n>
183 Send n extra tics in every packet as insurance against dropped
184 packets.
185 -ignoreversion
187 When running a netgame server, ignore version mismatches between
188 the server and the client. Using this option may cause game
189 desyncs to occur, or differences in protocol may mean the
190 netgame will simply not function at all.
191 -newsync
193 Use new network client sync code rather than the classic sync
194 code. This is currently disabled by default because it has some
195 bugs.
196 -nodes <n>
198 Autostart the netgame when n nodes (clients) have joined the
199 server.
200 -port <n>
202 Use the specified UDP port for communications, instead of the
203 default (2342).
204 -privateserver
206 When running a server, don't register with the global master
207 server. Implies -server.
208 -server
210 Start a multiplayer server, listening for connections.
211 -servername <name>
213 When starting a network server, specify a name for the server.
214 -solo-net
216 Start the game playing as though in a netgame with a single
217 player. This can also be used to play back single player
218 netgame demos.
219 -timer <n>
221 For multiplayer games: exit each level after n minutes.
222
225 -aa <files>
226 Equivalent to "-af <files> -as <files>".
227 -af <files>
229 Simulates the behavior of NWT's -af option, merging flats into
230 the main IWAD directory. Multiple files may be specified.
231 -as <files>
233 Simulates the behavior of NWT's -as option, merging sprites into
234 the main IWAD directory. Multiple files may be specified.
235 -deh <files>
237 Load the given dehacked patch(es)
238 -hhever <version>
240 Select the Heretic version number that was used to generate the
241 HHE patch to be loaded. Patches for each of the Vanilla Heretic
242 versions (1.0, 1.2, 1.3) can be loaded, but the correct version
243 number must be specified.
244 -merge <files>
246 Simulates the behavior of deutex's -merge option, merging a PWAD
247 into the main IWAD. Multiple files may be specified.
248 -nocheats
250 Ignore cheats in dehacked files.
251 -nwtmerge <files>
253 Simulates the behavior of NWT's -merge option. Multiple files
254 may be specified.
255
257 To play, an IWAD file is needed. This is a large file containing all of
258 the levels, graphics, sound effects, music and other material that make
259 up the game. IWAD files are named according to the game; the standard
260 names are:
261 doom.wad, doom1.wad, doom2.wad, tnt.wad, plutonia.wad
263 Doom, Doom II, Final Doom
264 heretic.wad, heretic1.wad, hexen.wad, strife1.wad
266 Heretic, Hexen and Strife (commercial Doom engine games).
267 hacx.wad, chex.wad
269 Hacx and Chex Quest - more obscure games based on the Doom
270 engine.
271 freedm.wad, freedoom1.wad, freedoom2.wad
273 The Freedoom open content IWAD files.
274 The following directory paths are searched in order to find an IWAD:
276 Current working directory
278 Any IWAD files found in the current working directory will be
279 used in preference to IWADs found in any other directories.
280 DOOMWADDIR
282 This environment variable can be set to contain a path to a sin‐
283 gle directory in which to look for IWAD files. This environment
284 variable is supported by most Doom source ports.
285 DOOMWADPATH
287 This environment variable, if set, can contain a colon-separated
288 list of directories in which to look for IWAD files, or alterna‐
289 tively full paths to specific IWAD files.
290 $HOME/.local/share/games/doom
292 Writeable directory in the user's home directory. The path can
293 be overridden using the XDG_DATA_HOME environment variable (see
294 the XDG Base Directory Specification).
295 /usr/local/share/games/doom, /usr/share/games/doom
297 System-wide locations that can be accessed by all users. The
298 path /usr/share/games/doom is a standard path that is supported
299 by most Doom source ports. These paths can be overridden using
300 the XDG_DATA_DIRS environment variable (see the XDG Base Direc‐
301 tory Specification).
302 The above can be overridden on a one-time basis by using the -iwad com‐
304 mand line parameter to provide the path to an IWAD file to use. This
305 parameter can also be used to specify the name of a particular IWAD to
306 use from one of the above paths. For example, '-iwad doom.wad' will
307 search the above paths for the file doom.wad to use.
308
310 This section describes environment variables that control Chocolate
311 Heretic's behavior.
312 DOOMWADDIR, DOOMWADPATH
314 See the section, IWAD SEARCH PATHS above.
315 PCSOUND_DRIVER
317 When running in PC speaker sound effect mode, this environment
318 variable specifies a PC speaker driver to use for sound effect
319 playback. Valid options are "Linux" for the Linux console mode
320 driver, "BSD" for the NetBSD/OpenBSD PC speaker driver, and
321 "SDL" for SDL-based emulated PC speaker playback (using the dig‐
322 ital output).
323 OPL_DRIVER
325 When using OPL MIDI playback, this environment variable speci‐
326 fies an OPL backend driver to use. Valid options are "SDL" for
327 an SDL-based software emulated OPL chip, "Linux" for the Linux
328 hardware OPL driver, and "OpenBSD" for the OpenBSD/NetBSD hard‐
329 ware OPL driver.
330 Generally speaking, a real hardware OPL chip sounds better than
332 software emulation; however, modern machines do not often
333 include one. If present, it may still require extra work to set
334 up and elevated security privileges to access.
335
338 $HOME/.chocolate-doom/heretic.cfg
339 The main configuration file for Chocolate Heretic. See
340 heretic.cfg(5).
341 $HOME/.chocolate-doom/chocolate-heretic.cfg
343 Extra configuration values that are specific to Chocolate
344 Heretic and not present in Vanilla Heretic. See chocolate-
345 heretic.cfg(5).
346
348 chocolate-doom(6), chocolate-hexen(6), chocolate-server(6), chocolate-
349 setup(6)
350
352 Chocolate Heretic is part of the Chocolate Doom project, written and
353 maintained by Simon Howard. It is based on the Heretic source code,
354 released by Raven Software.
355
357 Copyright © id Software Inc. Copyright © Raven Software Inc. Copy‐
358 right © 2005-2013 Simon Howard.
359 This is free software. You may redistribute copies of it under the
360 terms of the GNU General Public License
361 <http://www.gnu.org/licenses/gpl.html>. There is NO WARRANTY, to the
362 extent permitted by law.
363 chocolate-heretic(6)