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 -savedir <directory>
71 Specify a path from which to load and save games. If the direc‐
72 tory does not exist then it will automatically be created.
73 -skill <skill>
75 Set the game skill, 1-5 (1: easiest, 5: hardest). A skill of 0
76 disables all monsters.
77 -warp <x> <y>
79 Start a game immediately, warping to level ExMy.
80
83 -setmem <version>
84 Specify DOS version to emulate for NULL pointer dereference emu‐
85 lation. Supported versions are: dos622, dos71, dosbox. The
86 default is to emulate DOS 7.1 (Windows 98).
87
90 -demoextend
91 Record or playback a demo without automatically quitting after
92 either level exit or player respawn.
93 -longtics
95 Record or playback a demo with high resolution turning.
96 -maxdemo <size>
98 Specify the demo buffer size (KiB)
99 -playdemo <demo>
101 Play back the demo named demo.lmp.
102 -record <x>
104 Record a demo named x.lmp.
105 -recordfrom <savenum> <demofile>
107 Record a demo, loading from the given filename. Equivalent to
108 -loadgame <savenum> -record <demofile>.
109 -shortticfix
111 Smooth out low resolution turning when recording a demo.
112 -strictdemos
114 When recording or playing back demos, disable any extensions of
115 the vanilla demo format - record demos as vanilla would do, and
116 play back demos as vanilla would do.
117 -timedemo <demo>
119 Play back the demo named demo.lmp, determining the framerate of
120 the screen.
121
124 -1 Don't scale up the screen. Implies -window.
125 -2 Double up the screen to 2x its normal size. Implies -window.
127 -3 Double up the screen to 3x its normal size. Implies -window.
129 -fullscreen
131 Run in fullscreen mode.
132 -geometry <WxY>
134 Specify the dimensions of the window. Implies -window.
135 -height <y>
137 Specify the screen height, in pixels. Implies -window.
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 -width <x>
149 Specify the screen width, in pixels. Implies -window.
150 -window
152 Run in a window.
153
156 -autojoin
157 Automatically search the local LAN for a multiplayer server and
158 join it.
159 -connect <address>
161 Connect to a multiplayer server running on the given address.
162 -deathmatch
164 Start a deathmatch game.
165 -dup <n>
167 Reduce the resolution of the game by a factor of n, reducing the
168 amount of network bandwidth needed.
169 -extratics <n>
171 Send n extra tics in every packet as insurance against dropped
172 packets.
173 -newsync
175 Use new network client sync code rather than the classic sync
176 code. This is currently disabled by default because it has some
177 bugs.
178 -nodes <n>
180 Autostart the netgame when n nodes (clients) have joined the
181 server.
182 -port <n>
184 Use the specified UDP port for communications, instead of the
185 default (2342).
186 -privateserver
188 When running a server, don't register with the global master
189 server. Implies -server.
190 -server
192 Start a multiplayer server, listening for connections.
193 -servername <name>
195 When starting a network server, specify a name for the server.
196 -solo-net
198 Start the game playing as though in a netgame with a single
199 player. This can also be used to play back single player
200 netgame demos.
201 -timer <n>
203 For multiplayer games: exit each level after n minutes.
204
207 -aa <files>
208 Equivalent to "-af <files> -as <files>".
209 -af <files>
211 Simulates the behavior of NWT's -af option, merging flats into
212 the main IWAD directory. Multiple files may be specified.
213 -as <files>
215 Simulates the behavior of NWT's -as option, merging sprites into
216 the main IWAD directory. Multiple files may be specified.
217 -deh <files>
219 Load the given dehacked patch(es)
220 -hhever <version>
222 Select the Heretic version number that was used to generate the
223 HHE patch to be loaded. Patches for each of the Vanilla Heretic
224 versions (1.0, 1.2, 1.3) can be loaded, but the correct version
225 number must be specified.
226 -merge <files>
228 Simulates the behavior of deutex's -merge option, merging a PWAD
229 into the main IWAD. Multiple files may be specified.
230 -nocheats
232 Ignore cheats in dehacked files.
233 -nwtmerge <files>
235 Simulates the behavior of NWT's -merge option. Multiple files
236 may be specified.
237
239 To play, an IWAD file is needed. This is a large file containing all of
240 the levels, graphics, sound effects, music and other material that make
241 up the game. IWAD files are named according to the game; the standard
242 names are:
243 doom.wad, doom1.wad, doom2.wad, tnt.wad, plutonia.wad
245 Doom, Doom II, Final Doom
246 heretic.wad, heretic1.wad, hexen.wad, strife1.wad
248 Heretic, Hexen and Strife (commercial Doom engine games).
249 hacx.wad, chex.wad
251 Hacx and Chex Quest - more obscure games based on the Doom
252 engine.
253 freedm.wad, freedoom1.wad, freedoom2.wad
255 The Freedoom open content IWAD files.
256 The following directory paths are searched in order to find an IWAD:
258 Current working directory
260 Any IWAD files found in the current working directory will be
261 used in preference to IWADs found in any other directories.
262 DOOMWADDIR
264 This environment variable can be set to contain a path to a sin‐
265 gle directory in which to look for IWAD files. This environment
266 variable is supported by most Doom source ports.
267 DOOMWADPATH
269 This environment variable, if set, can contain a colon-separated
270 list of directories in which to look for IWAD files, or alterna‐
271 tively full paths to specific IWAD files.
272 $HOME/.local/share/games/doom
274 Writeable directory in the user's home directory. The path can
275 be overridden using the XDG_DATA_HOME environment variable (see
276 the XDG Base Directory Specification).
277 /usr/local/share/games/doom, /usr/share/games/doom
279 System-wide locations that can be accessed by all users. The
280 path /usr/share/games/doom is a standard path that is supported
281 by most Doom source ports. These paths can be overridden using
282 the XDG_DATA_DIRS environment variable (see the XDG Base Direc‐
283 tory Specification).
284 The above can be overridden on a one-time basis by using the -iwad com‐
286 mand line parameter to provide the path to an IWAD file to use. This
287 parameter can also be used to specify the name of a particular IWAD to
288 use from one of the above paths. For example, '-iwad doom.wad' will
289 search the above paths for the file doom.wad to use.
290
292 This section describes environment variables that control Chocolate
293 Heretic's behavior.
294 DOOMWADDIR, DOOMWADPATH
296 See the section, IWAD SEARCH PATHS above.
297 PCSOUND_DRIVER
299 When running in PC speaker sound effect mode, this environment
300 variable specifies a PC speaker driver to use for sound effect
301 playback. Valid options are "Linux" for the Linux console mode
302 driver, "BSD" for the NetBSD/OpenBSD PC speaker driver, and
303 "SDL" for SDL-based emulated PC speaker playback (using the dig‐
304 ital output).
305 OPL_DRIVER
307 When using OPL MIDI playback, this environment variable speci‐
308 fies an OPL backend driver to use. Valid options are "SDL" for
309 an SDL-based software emulated OPL chip, "Linux" for the Linux
310 hardware OPL driver, and "OpenBSD" for the OpenBSD/NetBSD hard‐
311 ware OPL driver.
312 Generally speaking, a real hardware OPL chip sounds better than
314 software emulation; however, modern machines do not often
315 include one. If present, it may still require extra work to set
316 up and elevated security privileges to access.
317
320 $HOME/.local/share/chocolate-doom/heretic.cfg
321 The main configuration file for Chocolate Heretic. See
322 heretic.cfg(5).
323 $HOME/.local/share/chocolate-doom/chocolate-heretic.cfg
325 Extra configuration values that are specific to Chocolate
326 Heretic and not present in Vanilla Heretic. See chocolate-
327 heretic.cfg(5).
328
330 chocolate-doom(6), chocolate-hexen(6), chocolate-server(6), chocolate-
331 setup(6)
332
334 Chocolate Heretic is part of the Chocolate Doom project, written and
335 maintained by Simon Howard. It is based on the Heretic source code,
336 released by Raven Software.
337
339 Copyright © id Software Inc. Copyright © Raven Software Inc. Copy‐
340 right © 2005-2013 Simon Howard.
341 This is free software. You may redistribute copies of it under the
342 terms of the GNU General Public License
343 <http://www.gnu.org/licenses/gpl.html>. There is NO WARRANTY, to the
344 extent permitted by law.
345 chocolate-heretic(6)