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

NAME

6       chocolate-heretic - historically compatible Heretic engine
7

SYNOPSIS

9       chocolate-heretic [OPTIONS]
10

DESCRIPTION

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

GENERAL OPTIONS

17       -cdrom [windows   only]   Save  configuration  data  and  savegames  in
18              c:\heretic.cd, allowing play from CD.
19
20       -config <file>
21              Load main configuration from the specified file, instead of  the
22              default.
23
24       -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
28       -episode <n>
29              Start playing on episode n (1-4)
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       -noartiskip
51              Allow artifacts to be used when the run key is held down.
52
53       -nomonsters
54              Disable monsters.
55
56       -nomusic
57              Disable music.
58
59       -nosfx Disable sound effects.
60
61       -nosound
62              Disable all sound output.
63
64       -ravpic
65              Take screenshots when F1 is pressed.
66
67       -respawn
68              Monsters respawn after being killed.
69
70       -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
74       -skill <skill>
75              Set  the game skill, 1-5 (1: easiest, 5: hardest).  A skill of 0
76              disables all monsters.
77
78       -warp <x> <y>
79              Start a game immediately, warping to level ExMy.
80
81

DISPLAY OPTIONS

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

DEMO OPTIONS

115       -demoextend
116              Record or playback a demo without automatically  quitting  after
117              either level exit or player respawn.
118
119       -longtics
120              Record or playback a demo with high resolution turning.
121
122       -maxdemo <size>
123              Specify the demo buffer size (KiB)
124
125       -playdemo <demo>
126              Play back the demo named demo.lmp.
127
128       -record <x>
129              Record a demo named x.lmp.
130
131       -recordfrom <savenum> <demofile>
132              Record  a  demo,  loading from the given filename. Equivalent to
133              -loadgame <savenum> -record <demofile>.
134
135       -shortticfix
136              Smooth out low resolution turning when recording a demo.
137
138       -strictdemos
139              When recording or playing back demos, disable any extensions  of
140              the  vanilla demo format - record demos as vanilla would do, and
141              play back demos as vanilla would do.
142
143       -timedemo <demo>
144              Play back the demo named demo.lmp, determining the framerate  of
145              the screen.
146
147

NETWORKING OPTIONS

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

DEHACKED AND WAD MERGING

200       -aa <files>
201              Equivalent to "-af <files> -as <files>".
202
203       -af <files>
204              Simulates  the  behavior of NWT's -af option, merging flats into
205              the main IWAD directory.  Multiple files may be specified.
206
207       -as <files>
208              Simulates the behavior of NWT's -as option, merging sprites into
209              the main IWAD directory.  Multiple files may be specified.
210
211       -deh <files>
212              Load the given dehacked patch(es)
213
214       -hhever <version>
215              Select  the Heretic version number that was used to generate the
216              HHE patch to be loaded.  Patches for each of the Vanilla Heretic
217              versions  (1.0, 1.2, 1.3) can be loaded, but the correct version
218              number must be specified.
219
220       -merge <files>
221              Simulates the behavior of deutex's -merge option, merging a PWAD
222              into the main IWAD.  Multiple files may be specified.
223
224       -nocheats
225              Ignore cheats in dehacked files.
226
227       -nwtmerge <files>
228              Simulates  the  behavior of NWT's -merge option.  Multiple files
229              may be specified.
230
231

COMPATIBILITY

233       -setmem <version>
234              Specify DOS version to emulate for NULL pointer dereference emu‐
235              lation.   Supported  versions  are:  dos622,  dos71, dosbox. The
236              default is to emulate DOS 7.1 (Windows 98).
237

IWAD SEARCH PATHS

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
244       doom.wad, doom1.wad, doom2.wad, tnt.wad, plutonia.wad
245              Doom, Doom II, Final Doom
246
247       heretic.wad, heretic1.wad, hexen.wad, strife1.wad
248              Heretic, Hexen and Strife (commercial Doom engine games).
249
250       hacx.wad, chex.wad
251              Hacx  and  Chex  Quest  -  more  obscure games based on the Doom
252              engine.
253
254       freedm.wad, freedoom1.wad, freedoom2.wad
255              The Freedoom open content IWAD files.
256
257       The following directory paths are searched in order to find an IWAD:
258
259       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
263       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
268       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
273       $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
278       /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
285       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

ENVIRONMENT

292       This  section  describes  environment  variables that control Chocolate
293       Heretic's behavior.
294
295       DOOMWADDIR, DOOMWADPATH
296              See the section, IWAD SEARCH PATHS above.
297
298       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
306       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
313              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
318

FILES

320       $HOME/.local/share/chocolate-doom/heretic.cfg
321              The  main  configuration  file  for  Chocolate   Heretic.    See
322              heretic.cfg(5).
323
324       $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

SEE ALSO

330       chocolate-doom(6),  chocolate-hexen(6), chocolate-server(6), chocolate-
331       setup(6)
332

AUTHOR

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
346
347
348
349                                                          chocolate-heretic(6)
Impressum