1chocolate-doom.cfg(5) File Formats Manual chocolate-doom.cfg(5)
2
6 chocolate-doom.cfg - Chocolate Doom configuration file
7
9 chocolate-doom.cfg is a configuration file for chocolate-doom(6). This
10 file acts as an auxiliary configuration file; the main configuration
11 options are stored in default.cfg, which contains the same configura‐
12 tion options as Vanilla Doom (for compatibility). chocolate-doom.cfg
13 contains configuration options that are specific to Chocolate Doom
14 only.
15 chocolate-doom.cfg is normally stored in the user's home directory, as
17 ~/.chocolate-doom/chocolate-doom.cfg.
18 The chocolate-setup(6) tool provides a simple to use front-end for
20 editing chocolate-doom.cfg.
21
23 The file format is the same as that used for default.cfg(5).
24
27 graphical_startup
28 If non-zero, display the graphical startup screen.
29 autoadjust_video_settings
31 If non-zero, video settings will be autoadjusted to a valid con‐
32 figuration when the screen_width and screen_height variables do
33 not match any valid configuration.
34 fullscreen
36 If non-zero, the game will run in full screen mode. If zero,
37 the game will run in a window.
38 aspect_ratio_correct
40 If non-zero, the screen will be stretched vertically to display
41 correctly on a square pixel video mode.
42 startup_delay
44 Number of milliseconds to wait on startup after the video mode
45 has been set, before the game will start. This allows the
46 screen to settle on some monitors that do not display an image
47 for a brief interval after changing video modes.
48 screen_width
50 Screen width in pixels. If running in full screen mode, this is
51 the X dimension of the video mode to use. If running in win‐
52 dowed mode, this is the width of the window in which the game
53 will run.
54 screen_height
56 Screen height in pixels. If running in full screen mode, this
57 is the Y dimension of the video mode to use. If running in win‐
58 dowed mode, this is the height of the window in which the game
59 will run.
60 screen_bpp
62 Color depth of the screen, in bits. If this is set to zero, the
63 color depth will be automatically set on startup to the
64 machine's default/native color depth.
65 grabmouse
67 If this is non-zero, the mouse will be "grabbed" when running in
68 windowed mode so that it can be used as an input device. When
69 running full screen, this has no effect.
70 novert If non-zero, all vertical mouse movement is ignored. This emu‐
72 lates the behavior of the "novert" tool available under DOS that
73 performs the same function.
74 mouse_acceleration
76 Mouse acceleration factor. When the speed of mouse movement
77 exceeds the threshold value (mouse_threshold), the speed is mul‐
78 tiplied by this value.
79 mouse_threshold
81 Mouse acceleration threshold. When the speed of mouse movement
82 exceeds this threshold value, the speed is multiplied by an
83 acceleration factor (mouse_acceleration).
84 snd_samplerate
86 Sound output sample rate, in Hz. Typical values to use are
87 11025, 22050, 44100 and 48000.
88 snd_cachesize
90 Maximum number of bytes to allocate for caching converted sound
91 effects in memory. If set to zero, there is no limit applied.
92 snd_maxslicetime_ms
94 Maximum size of the output sound buffer size in milliseconds.
95 Sound output is generated periodically in slices. Higher values
96 might be more efficient but will introduce latency to the sound
97 output. The default is 28ms (one slice per tic with the 35fps
98 timer).
99 snd_pitchshift
101 If non-zero, sound effects will have their pitch varied up or
102 down by a random amount during play. If zero, sound effects play
103 back at their default pitch. The default is zero.
104 snd_musiccmd
106 External command to invoke to perform MIDI playback. If set to
107 the empty string, SDL_mixer's internal MIDI playback is used.
108 This only has any effect when snd_musicdevice is set to General
109 MIDI output.
110 snd_dmxoption
112 Value to set for the DMXOPTION environment variable. If this
113 contains "-opl3", output for an OPL3 chip is generated when in
114 OPL MIDI playback mode.
115 opl_io_port
117 The I/O port to use to access the OPL chip. Only relevant when
118 using native OPL music playback.
119 png_screenshots
121 If non-zero, save screenshots in PNG format.
122 vanilla_keyboard_mapping
124 If non-zero, the game behaves like Vanilla Doom, always assuming
125 an American keyboard mapping. If this has a value of zero, the
126 native keyboard mapping of the keyboard is used.
127 video_driver
129 Name of the SDL video driver to use. If this is an empty
130 string, the default video driver is used.
131 window_position
133 Position of the window on the screen when running in windowed
134 mode. Accepted values are: "" (empty string) - don't care, "cen‐
135 ter" - place window at center of screen, "x,y" - place window at
136 the specified coordinates.
137 player_name
139 Name to use in network games for identification. This is only
140 used on the "waiting" screen while waiting for the game to
141 start.
142 joystick_index
144 Joystick number to use; '0' is the first joystick. A negative
145 value ('-1') indicates that no joystick is configured.
146 joystick_x_axis
148 Joystick axis to use to for horizontal (X) movement.
149 joystick_x_invert
151 If non-zero, movement on the horizontal joystick axis is
152 inverted.
153 joystick_y_axis
155 Joystick axis to use to for vertical (Y) movement.
156 joystick_y_invert
158 If non-zero, movement on the vertical joystick axis is inverted.
159 joystick_strafe_axis
161 Joystick axis to use to for strafing movement.
162 joystick_strafe_invert
164 If non-zero, movement on the joystick axis used for strafing is
165 inverted.
166 joystick_physical_button0
168 The physical joystick button that corresponds to joystick vir‐
169 tual button #0.
170 joystick_physical_button1
172 The physical joystick button that corresponds to joystick vir‐
173 tual button #1.
174 joystick_physical_button2
176 The physical joystick button that corresponds to joystick vir‐
177 tual button #2.
178 joystick_physical_button3
180 The physical joystick button that corresponds to joystick vir‐
181 tual button #3.
182 joystick_physical_button4
184 The physical joystick button that corresponds to joystick vir‐
185 tual button #4.
186 joystick_physical_button5
188 The physical joystick button that corresponds to joystick vir‐
189 tual button #5.
190 joystick_physical_button6
192 The physical joystick button that corresponds to joystick vir‐
193 tual button #6.
194 joystick_physical_button7
196 The physical joystick button that corresponds to joystick vir‐
197 tual button #7.
198 joystick_physical_button8
200 The physical joystick button that corresponds to joystick vir‐
201 tual button #8.
202 joystick_physical_button9
204 The physical joystick button that corresponds to joystick vir‐
205 tual button #9.
206 joystick_physical_button10
208 The physical joystick button that corresponds to joystick vir‐
209 tual button #10.
210 joyb_strafeleft
212 Joystick virtual button to make the player strafe left.
213 joyb_straferight
215 Joystick virtual button to make the player strafe right.
216 joyb_menu_activate
218 Joystick virtual button to activate the menu.
219 joyb_toggle_automap
221 Joystick virtual button to toggle the automap.
222 joyb_prevweapon
224 Joystick virtual button that cycles to the previous weapon.
225 joyb_nextweapon
227 Joystick virtual button that cycles to the next weapon.
228 mouseb_strafeleft
230 Mouse button to strafe left.
231 mouseb_straferight
233 Mouse button to strafe right.
234 mouseb_use
236 Mouse button to "use" an object, eg. a door or switch.
237 mouseb_backward
239 Mouse button to move backwards.
240 mouseb_prevweapon
242 Mouse button to cycle to the previous weapon.
243 mouseb_nextweapon
245 Mouse button to cycle to the next weapon.
246 dclick_use
248 If non-zero, double-clicking a mouse button acts like pressing
249 the "use" key to use an object in-game, eg. a door or switch.
250 use_libsamplerate
252 Controls whether libsamplerate support is used for performing
253 sample rate conversions of sound effects. Support for this must
254 be compiled into the program. If zero, libsamplerate support is
255 disabled. If non-zero, libsamplerate is enabled. Increasing
256 values roughly correspond to higher quality conversion; the
257 higher the quality, the slower the conversion process. Linear
258 conversion = 1; Zero order hold = 2; Fast Sinc filter = 3;
259 Medium quality Sinc filter = 4; High quality Sinc filter = 5.
260 libsamplerate_scale
262 Scaling factor used by libsamplerate. This is used when convert‐
263 ing sounds internally back into integer form; normally it should
264 not be necessary to change it from the default value. The only
265 time it might be needed is if a PWAD file is loaded that con‐
266 tains very loud sounds, in which case the conversion may cause
267 sound clipping and the scale factor should be reduced. The lower
268 the value, the quieter the sound effects become, so it should be
269 set as high as is possible without clipping occurring.
270 timidity_cfg_path
272 Full path to a Timidity configuration file to use for MIDI play‐
273 back. The file will be evaluated from the directory where it is
274 evaluated, so there is no need to add "dir" commands into it.
275 gus_patch_path
277 Path to GUS patch files to use when operating in GUS emulation
278 mode.
279 gus_ram_kb
281 Number of kilobytes of RAM to use in GUS emulation mode. Valid
282 values are 256, 512, 768 or 1024.
283 key_pause
285 Key to pause or unpause the game.
286 key_menu_activate
288 Key that activates the menu when pressed.
289 key_menu_up
291 Key that moves the cursor up on the menu.
292 key_menu_down
294 Key that moves the cursor down on the menu.
295 key_menu_left
297 Key that moves the currently selected slider on the menu left.
298 key_menu_right
300 Key that moves the currently selected slider on the menu right.
301 key_menu_back
303 Key to go back to the previous menu.
304 key_menu_forward
306 Key to activate the currently selected menu item.
307 key_menu_confirm
309 Key to answer 'yes' to a question in the menu.
310 key_menu_abort
312 Key to answer 'no' to a question in the menu.
313 key_menu_help
315 Keyboard shortcut to bring up the help screen.
316 key_menu_save
318 Keyboard shortcut to bring up the save game menu.
319 key_menu_load
321 Keyboard shortcut to bring up the load game menu.
322 key_menu_volume
324 Keyboard shortcut to bring up the sound volume menu.
325 key_menu_detail
327 Keyboard shortcut to toggle the detail level.
328 key_menu_qsave
330 Keyboard shortcut to quicksave the current game.
331 key_menu_endgame
333 Keyboard shortcut to end the game.
334 key_menu_messages
336 Keyboard shortcut to toggle heads-up messages.
337 key_menu_qload
339 Keyboard shortcut to load the last quicksave.
340 key_menu_quit
342 Keyboard shortcut to quit the game.
343 key_menu_gamma
345 Keyboard shortcut to toggle the gamma correction level.
346 key_spy
348 Keyboard shortcut to switch view in multiplayer.
349 key_menu_incscreen
351 Keyboard shortcut to increase the screen size.
352 key_menu_decscreen
354 Keyboard shortcut to decrease the screen size.
355 key_menu_screenshot
357 Keyboard shortcut to save a screenshot.
358 key_map_toggle
360 Key to toggle the map view.
361 key_map_north
363 Key to pan north when in the map view.
364 key_map_south
366 Key to pan south when in the map view.
367 key_map_east
369 Key to pan east when in the map view.
370 key_map_west
372 Key to pan west when in the map view.
373 key_map_zoomin
375 Key to zoom in when in the map view.
376 key_map_zoomout
378 Key to zoom out when in the map view.
379 key_map_maxzoom
381 Key to zoom out the maximum amount when in the map view.
382 key_map_follow
384 Key to toggle follow mode when in the map view.
385 key_map_grid
387 Key to toggle the grid display when in the map view.
388 key_map_mark
390 Key to set a mark when in the map view.
391 key_map_clearmark
393 Key to clear all marks when in the map view.
394 key_weapon1
396 Key to select weapon 1.
397 key_weapon2
399 Key to select weapon 2.
400 key_weapon3
402 Key to select weapon 3.
403 key_weapon4
405 Key to select weapon 4.
406 key_weapon5
408 Key to select weapon 5.
409 key_weapon6
411 Key to select weapon 6.
412 key_weapon7
414 Key to select weapon 7.
415 key_weapon8
417 Key to select weapon 8.
418 key_prevweapon
420 Key to cycle to the previous weapon.
421 key_nextweapon
423 Key to cycle to the next weapon.
424 key_arti_all
426 Key to use one of each artifact.
427 key_arti_health
429 Key to use "quartz flask" artifact.
430 key_arti_poisonbag
432 Key to use "flechette" artifact.
433 key_arti_blastradius
435 Key to use "disc of repulsion" artifact.
436 key_arti_teleport
438 Key to use "chaos device" artifact.
439 key_arti_teleportother
441 Key to use "banishment device" artifact.
442 key_arti_egg
444 Key to use "porkalator" artifact.
445 key_arti_invulnerability
447 Key to use "icon of the defender" artifact.
448 key_message_refresh
450 Key to re-display last message.
451 key_demo_quit
453 Key to quit the game when recording a demo.
454 key_multi_msg
456 Key to send a message during multiplayer games.
457 key_multi_msgplayer1
459 Key to send a message to player 1 during multiplayer games.
460 key_multi_msgplayer2
462 Key to send a message to player 2 during multiplayer games.
463 key_multi_msgplayer3
465 Key to send a message to player 3 during multiplayer games.
466 key_multi_msgplayer4
468 Key to send a message to player 4 during multiplayer games.
469 key_multi_msgplayer5
471 Key to send a message to player 5 during multiplayer games.
472 key_multi_msgplayer6
474 Key to send a message to player 6 during multiplayer games.
475 key_multi_msgplayer7
477 Key to send a message to player 7 during multiplayer games.
478 key_multi_msgplayer8
480 Key to send a message to player 8 during multiplayer games.
481
484 chocolate-doom(6), default.cfg(5), chocolate-setup(6)
485 chocolate-doom.cfg(5)