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 show_endoom
121 If non-zero, the ENDOOM text screen is displayed when exiting
122 the game. If zero, the ENDOOM screen is not displayed.
123 png_screenshots
125 If non-zero, save screenshots in PNG format.
126 vanilla_keyboard_mapping
128 If non-zero, the game behaves like Vanilla Doom, always assuming
129 an American keyboard mapping. If this has a value of zero, the
130 native keyboard mapping of the keyboard is used.
131 video_driver
133 Name of the SDL video driver to use. If this is an empty
134 string, the default video driver is used.
135 window_position
137 Position of the window on the screen when running in windowed
138 mode. Accepted values are: "" (empty string) - don't care, "cen‐
139 ter" - place window at center of screen, "x,y" - place window at
140 the specified coordinates.
141 player_name
143 Name to use in network games for identification. This is only
144 used on the "waiting" screen while waiting for the game to
145 start.
146 joystick_index
148 Joystick number to use; '0' is the first joystick. A negative
149 value ('-1') indicates that no joystick is configured.
150 joystick_x_axis
152 Joystick axis to use to for horizontal (X) movement.
153 joystick_x_invert
155 If non-zero, movement on the horizontal joystick axis is
156 inverted.
157 joystick_y_axis
159 Joystick axis to use to for vertical (Y) movement.
160 joystick_y_invert
162 If non-zero, movement on the vertical joystick axis is inverted.
163 joystick_strafe_axis
165 Joystick axis to use to for strafing movement.
166 joystick_strafe_invert
168 If non-zero, movement on the joystick axis used for strafing is
169 inverted.
170 joystick_physical_button0
172 The physical joystick button that corresponds to joystick vir‐
173 tual button #0.
174 joystick_physical_button1
176 The physical joystick button that corresponds to joystick vir‐
177 tual button #1.
178 joystick_physical_button2
180 The physical joystick button that corresponds to joystick vir‐
181 tual button #2.
182 joystick_physical_button3
184 The physical joystick button that corresponds to joystick vir‐
185 tual button #3.
186 joystick_physical_button4
188 The physical joystick button that corresponds to joystick vir‐
189 tual button #4.
190 joystick_physical_button5
192 The physical joystick button that corresponds to joystick vir‐
193 tual button #5.
194 joystick_physical_button6
196 The physical joystick button that corresponds to joystick vir‐
197 tual button #6.
198 joystick_physical_button7
200 The physical joystick button that corresponds to joystick vir‐
201 tual button #7.
202 joystick_physical_button8
204 The physical joystick button that corresponds to joystick vir‐
205 tual button #8.
206 joystick_physical_button9
208 The physical joystick button that corresponds to joystick vir‐
209 tual button #9.
210 joystick_physical_button10
212 The physical joystick button that corresponds to joystick vir‐
213 tual button #10.
214 joyb_strafeleft
216 Joystick virtual button to make the player strafe left.
217 joyb_straferight
219 Joystick virtual button to make the player strafe right.
220 joyb_menu_activate
222 Joystick virtual button to activate the menu.
223 joyb_toggle_automap
225 Joystick virtual button to toggle the automap.
226 joyb_prevweapon
228 Joystick virtual button that cycles to the previous weapon.
229 joyb_nextweapon
231 Joystick virtual button that cycles to the next weapon.
232 mouseb_strafeleft
234 Mouse button to strafe left.
235 mouseb_straferight
237 Mouse button to strafe right.
238 mouseb_use
240 Mouse button to "use" an object, eg. a door or switch.
241 mouseb_backward
243 Mouse button to move backwards.
244 mouseb_prevweapon
246 Mouse button to cycle to the previous weapon.
247 mouseb_nextweapon
249 Mouse button to cycle to the next weapon.
250 dclick_use
252 If non-zero, double-clicking a mouse button acts like pressing
253 the "use" key to use an object in-game, eg. a door or switch.
254 use_libsamplerate
256 Controls whether libsamplerate support is used for performing
257 sample rate conversions of sound effects. Support for this must
258 be compiled into the program. If zero, libsamplerate support is
259 disabled. If non-zero, libsamplerate is enabled. Increasing
260 values roughly correspond to higher quality conversion; the
261 higher the quality, the slower the conversion process. Linear
262 conversion = 1; Zero order hold = 2; Fast Sinc filter = 3;
263 Medium quality Sinc filter = 4; High quality Sinc filter = 5.
264 libsamplerate_scale
266 Scaling factor used by libsamplerate. This is used when convert‐
267 ing sounds internally back into integer form; normally it should
268 not be necessary to change it from the default value. The only
269 time it might be needed is if a PWAD file is loaded that con‐
270 tains very loud sounds, in which case the conversion may cause
271 sound clipping and the scale factor should be reduced. The lower
272 the value, the quieter the sound effects become, so it should be
273 set as high as is possible without clipping occurring.
274 timidity_cfg_path
276 Full path to a Timidity configuration file to use for MIDI play‐
277 back. The file will be evaluated from the directory where it is
278 evaluated, so there is no need to add "dir" commands into it.
279 gus_patch_path
281 Path to GUS patch files to use when operating in GUS emulation
282 mode.
283 gus_ram_kb
285 Number of kilobytes of RAM to use in GUS emulation mode. Valid
286 values are 256, 512, 768 or 1024.
287 key_pause
289 Key to pause or unpause the game.
290 key_menu_activate
292 Key that activates the menu when pressed.
293 key_menu_up
295 Key that moves the cursor up on the menu.
296 key_menu_down
298 Key that moves the cursor down on the menu.
299 key_menu_left
301 Key that moves the currently selected slider on the menu left.
302 key_menu_right
304 Key that moves the currently selected slider on the menu right.
305 key_menu_back
307 Key to go back to the previous menu.
308 key_menu_forward
310 Key to activate the currently selected menu item.
311 key_menu_confirm
313 Key to answer 'yes' to a question in the menu.
314 key_menu_abort
316 Key to answer 'no' to a question in the menu.
317 key_menu_help
319 Keyboard shortcut to bring up the help screen.
320 key_menu_save
322 Keyboard shortcut to bring up the save game menu.
323 key_menu_load
325 Keyboard shortcut to bring up the load game menu.
326 key_menu_volume
328 Keyboard shortcut to bring up the sound volume menu.
329 key_menu_detail
331 Keyboard shortcut to toggle the detail level.
332 key_menu_qsave
334 Keyboard shortcut to quicksave the current game.
335 key_menu_endgame
337 Keyboard shortcut to end the game.
338 key_menu_messages
340 Keyboard shortcut to toggle heads-up messages.
341 key_menu_qload
343 Keyboard shortcut to load the last quicksave.
344 key_menu_quit
346 Keyboard shortcut to quit the game.
347 key_menu_gamma
349 Keyboard shortcut to toggle the gamma correction level.
350 key_spy
352 Keyboard shortcut to switch view in multiplayer.
353 key_menu_incscreen
355 Keyboard shortcut to increase the screen size.
356 key_menu_decscreen
358 Keyboard shortcut to decrease the screen size.
359 key_menu_screenshot
361 Keyboard shortcut to save a screenshot.
362 key_map_toggle
364 Key to toggle the map view.
365 key_map_north
367 Key to pan north when in the map view.
368 key_map_south
370 Key to pan south when in the map view.
371 key_map_east
373 Key to pan east when in the map view.
374 key_map_west
376 Key to pan west when in the map view.
377 key_map_zoomin
379 Key to zoom in when in the map view.
380 key_map_zoomout
382 Key to zoom out when in the map view.
383 key_map_maxzoom
385 Key to zoom out the maximum amount when in the map view.
386 key_map_follow
388 Key to toggle follow mode when in the map view.
389 key_map_grid
391 Key to toggle the grid display when in the map view.
392 key_map_mark
394 Key to set a mark when in the map view.
395 key_map_clearmark
397 Key to clear all marks when in the map view.
398 key_weapon1
400 Key to select weapon 1.
401 key_weapon2
403 Key to select weapon 2.
404 key_weapon3
406 Key to select weapon 3.
407 key_weapon4
409 Key to select weapon 4.
410 key_weapon5
412 Key to select weapon 5.
413 key_weapon6
415 Key to select weapon 6.
416 key_weapon7
418 Key to select weapon 7.
419 key_weapon8
421 Key to select weapon 8.
422 key_prevweapon
424 Key to cycle to the previous weapon.
425 key_nextweapon
427 Key to cycle to the next weapon.
428 key_message_refresh
430 Key to re-display last message.
431 key_demo_quit
433 Key to quit the game when recording a demo.
434 key_multi_msg
436 Key to send a message during multiplayer games.
437 key_multi_msgplayer1
439 Key to send a message to player 1 during multiplayer games.
440 key_multi_msgplayer2
442 Key to send a message to player 2 during multiplayer games.
443 key_multi_msgplayer3
445 Key to send a message to player 3 during multiplayer games.
446 key_multi_msgplayer4
448 Key to send a message to player 4 during multiplayer games.
449
452 chocolate-doom(6), default.cfg(5), chocolate-setup(6)
453 chocolate-doom.cfg(5)