chocolate-doom.cfg(5)

📦
version 3.1.1 · 5 versions
, in fedora 43, fedora 44, nixpkgs unstable, ubuntu resolute, ubuntu stonking

🎀 chocolate-doom.cfg 🎀

✨ NAME ✨

chocolate-doom.cfg — the Chocolate Doom configuration file, bestie. It lives in File Formats Manual territory and it is, lowkey, the vibe settings for your whole Doom experience. 💅

🦋 DESCRIPTION 🦋

Okay so, chocolate-doom.cfg is a configuration file for chocolate-doom(6). It's the auxiliary config file, not the main character. The main config options live in default.cfg, which has all the same options as Vanilla Doom (for compatibility reasons, obviously). chocolate-doom.cfg is where the stuff that's Chocolate-Doom only goes. Exclusive. VIP section. 👑

Normally this file chills in your home directory like:

~/.local/share/chocolate-doom/chocolate-doom.cfg

And you can override that path with the XDG_DATA_HOME environment variable (peep the XDG Base Directory Specification for the deets). ✨

Also, if you don't wanna hand-edit text files like some kind of gremlin, the chocolate-doom-setup(6) tool is a whole front-end for editing chocolate-doom.cfg. It's giving "user friendly". 🫶

🌈 FILE FORMAT 🌈

The file format is literally the same as the one used for default.cfg(5). No cap. If you know that one, you know this one. 🧚

💖 CONFIGURATION VARIABLES 💖

This is the main event, bestie. Every single variable, coming right up. 🍓

  • video_driver — The name of the SDL video driver you wanna use. If you set it to an empty string, it just uses the default video driver like a chill lil guy. ✨
  • window_position — Where the window sits on your screen when you're running in windowed mode. The accepted values are: "" (empty string) — don't care, not my problem; "center" — plop the window right in the center of the screen; and "x,y" — put the window at the exact coordinates you specify. 📍
  • fullscreen — If it's non-zero, the game runs in full screen mode. If it's zero, it runs in a window. Simple as. 🖥️
  • video_display — The index of the display the game should run on. Heads up tho: this does nothing if you're running in windowed mode (fullscreen=0) and window_position isn't set to "center". 🙈
  • aspect_ratio_correct — If it's non-zero, the screen gets stretched vertically so it displays correctly on a square pixel video mode. Math girlies, this one's for you. 📐
  • smooth_pixel_scaling — If it's non-zero, the screen gets smooth scaling. Silky. ✨
  • integer_scaling — If it's non-zero, it forces integer scales for resolution-independent rendering. 🧮
  • window_width — The window width when you're running in windowed mode. 📏
  • window_height — The window height when you're running in windowed mode. 📐
  • fullscreen_width — The width for screen mode when running fullscreen. If this and fullscreen_height are both set to zero, we run fullscreen as a desktop window that covers the entire screen, rather than ever switching screen modes. Honestly? It should usually be unnecessary to set this value. It's giving "why are you here". 💀
  • fullscreen_height — The height for screen mode when running fullscreen. Go read the documentation for fullscreen_width, it's the same situation. 👀
  • force_software_renderer — If it's non-zero, force the use of a software renderer. This is for the systems out there lacking hardware acceleration. We support you. 🫶
  • max_scaling_buffer_pixels — The maximum number of pixels to use for the intermediate scaling buffer. More pixels = the screen can be rendered more precisely, BUT there are diminishing returns on quality, so don't go wild. The default limits it to 16,000,000 pixels, which is enough to cover 4K monitor standards. Iconic. 🔥
  • startup_delay — The number of milliseconds to wait on startup after the video mode has been set, before the game will start. This gives the screen time to settle on some monitors that don't display an image for a brief interval after changing video modes. Patience is a virtue. 🌸
  • show_endoom — If it's non-zero, the ENDOOM text screen gets displayed when you exit the game. If it's zero, no ENDOOM for you. 😭
  • show_diskicon — If it's non-zero, a disk activity indicator shows up when data is read from disk. If it's zero, no indicator. A lil blinkie. 💫
  • png_screenshots — If it's non-zero, screenshots get saved in PNG format. If it's zero, they're saved in PCX format, exactly like Vanilla Doom does it. Retro behavior, preserved. 🎀
  • snd_samplerate — Sound output sample rate, in Hz. The typical values to use are 11025, 22050, 44100 and 48000. Pick your fighter. 🎵
  • snd_cachesize — The maximum number of bytes to allocate for caching converted sound effects in memory. If you set it to zero, there's no limit applied. Go feral. 🍓
  • snd_maxslicetime_ms — The maximum size of the output sound buffer size in milliseconds. Sound output is generated periodically in slices. Higher values might be more efficient, but they'll introduce latency to the sound output, and nobody wants laggy audio. The default is 28ms (that's one slice per tic with the 35fps timer, iykyk). ⏱️
  • snd_pitchshift — If it's non-zero, sound effects get their pitch varied up or down by a random amount during play. If it's zero, sound effects play back at their default pitch. Chaos mode: optional. 🌈
  • snd_musiccmd — An external command to invoke to perform MIDI playback. If you set it to the empty string, SDL_mixer's internal MIDI playback is used instead. Also important: this only has any effect when snd_musicdevice is set to General MIDI output. 🎹
  • snd_dmxoption — The value to set for the DMXOPTION environment variable. If this contains "-opl3", output for an OPL3 chip is generated when in OPL MIDI playback mode. ✨
  • opl_io_port — The I/O port to use to access the OPL chip. Only relevant when you're using native OPL music playback. 🔌
  • use_libsamplerate — Controls whether libsamplerate support is used for performing sample rate conversions of sound effects. Support for this must be compiled into the program — it's not just gonna show up. If it's zero, libsamplerate support is disabled. If it's non-zero, libsamplerate is enabled. And here's the tea: increasing values roughly correspond to higher quality conversion, and the higher the quality, the slower the conversion process. The scale is:
    • Linear conversion = 1
    • Zero order hold = 2
    • Fast Sinc filter = 3
    • Medium quality Sinc filter = 4
    • High quality Sinc filter = 5

Choose wisely bestie. 💅

  • libsamplerate_scale — The scaling factor used by libsamplerate. This gets used when converting sounds internally back into integer form; normally you should not need to change it from the default value. The one time it might be needed is if a PWAD file is loaded that contains very loud sounds — in that case the conversion may cause sound clipping, and the scale factor should be reduced. The lower the value, the quieter the sound effects become, so it should be set as high as possible without clipping occurring. Balance, babe. ⚖️
  • autoload_path — The full path to a directory where WAD files and dehacked patches can be placed so they get automatically loaded on startup. A subdirectory of this directory matching the IWAD name is checked to find the files to load. Autoload, slay. 🗂️
  • music_pack_path — The full path to a directory containing configuration files for substitute music packs. These packs contain high quality renderings of game music to be played instead of using the system's built-in MIDI playback. Fancy. 🎼
  • fsynth_chorus_active — If 1, activate the FluidSynth chorus effects module. If 0, no chorus gets added to the output signal. 🎶
  • fsynth_chorus_depth — Specifies the modulation depth of the FluidSynth chorus. Default is 5.0, range is 0.0 to 256.0. 🌊
  • fsynth_chorus_level — Specifies the output amplitude of the FluidSynth chorus signal. Default is 0.35, range is 0.0 to 10.0. 🔊
  • fsynth_chorus_nr — Sets the voice count of the FluidSynth chorus signal. Default is 3, range is 0 to 99. 🎤
  • fsynth_chorus_speed — Sets the FluidSynth chorus modulation speed in Hz. Default is 0.3, range is 0.1 to 5.0. 💫
  • fsynth_midibankselect — This setting defines how FluidSynth interprets Bank Select messages. The default is "gs". The other possible values are "gm", "xg" and "mma". Pick your lore. 📜
  • fsynth_polyphony — Sets the number of FluidSynth voices that can be played in parallel. Default is 256, range is 1 - 65535. That's a lot of voices, go off. 👑
  • fsynth_reverb_active — If 1, activate the FluidSynth reverb effects module. If 0, no reverb gets added to the output signal. 🏛️
  • fsynth_reverb_damp — Sets the amount of FluidSynth reverb damping. Default is 0.4, range is 0.0 to 1.0. 🫧
  • fsynth_reverb_level — Sets the FluidSynth reverb amplitude. Default is 0.15, range is 0.0 - 1.0. 🔊
  • fsynth_reverb_roomsize — Sets the room size (i.e. the amount of wet) of FluidSynth reverb. Default is 0.6, range is 0.0 - 1.0. 🚿
  • fsynth_reverb_width — Sets the stereo spread of the FluidSynth reverb signal. Default is 0.4, range is 0.0 - 100.0. 🌐
  • fsynth_gain — Fine tune the FluidSynth output level. Default is 1.0, range is 0.0 - 10.0. 📶
  • fsynth_sf_path — The full path to a soundfont file to use with FluidSynth MIDI playback. 🎹
  • timidity_cfg_path — The full path to a Timidity configuration file to use for MIDI playback. The file will be evaluated from the directory where it is evaluated, so there's no need to add "dir" commands into it. Nice, less work for you. ✨
  • gus_patch_path — The path to GUS patch files to use when operating in GUS emulation mode. 🎛️
  • gus_ram_kb — The number of kilobytes of RAM to use in GUS emulation mode. Valid values are 256, 512, 768 or 1024. Pick one, no in-betweens. 💾
  • winmm_midi_device — The MIDI device for native Windows MIDI. 🪟
  • winmm_complevel — The compatibility level for native Windows MIDI, default 0. Valid values are 0 (Vanilla), 1 (Standard), 2 (Full). 🎚️
  • winmm_reset_type — The reset device type for native Windows MIDI, default 1. Valid values are 0 (None), 1 (GM Mode), 2 (GS Mode), 3 (XG Mode). 🔄
  • winmm_reset_delay — The reset device delay for native Windows MIDI, default 0, median value 100 ms. ⏳
  • vanilla_savegame_limit — If it's non-zero, the Vanilla savegame limit is enforced. Meaning: if the savegame exceeds 180224 bytes in size, the game will exit with an error. If this has a value of zero, there is no limit to the size of savegames. Choose chaos if you want. 😭
  • vanilla_demo_limit — If it's non-zero, the Vanilla demo size limit is enforced. Meaning: the game exits with an error when a demo exceeds the demo size limit (128KiB by default). If this has a value of zero, there's no limit to the size of demos. 🎬
  • vanilla_keyboard_mapping — If it's non-zero, the game behaves like Vanilla Doom, always assuming an American keyboard mapping. If this has a value of zero, the native keyboard mapping of the keyboard is used. 🇺🇸
  • player_name — The name to use in network games for identification. Important caveat: this is only used on the "waiting" screen while waiting for the game to start. So make it cute, everyone's gonna see it. 🫶

okay bestie, we're officially in the input-device half of the config and this is where the girlies either thrive or cry 😭 mouse first, joystick second, keybinds last. buckle up 🎀

  • grabmouse — if this is non-zero, the mouse gets grabbed while you're running in windowed mode so you can actually use it as an input device 🖱️ while running full screen? this does literally nothing. zero effect. napping 💤
  • novert — if non-zero, all vertical mouse movement gets ignored. it's cosplaying the "novert" tool from back in the DOS days that did the exact same thing. retro icon behavior fr 💅
  • mouse_acceleration — the mouse acceleration factor. the moment your mouse speed goes past the threshold value (mouse_threshold), your speed gets multiplied by this value. math is mathing ✨
  • mouse_threshold — the mouse acceleration threshold. when mouse speed exceeds this, speed gets multiplied by an acceleration factor (mouse_acceleration). they're a duo, they come as a set 🫶
  • mouseb_strafeleft — mouse button to strafe left ⬅️
  • mouseb_straferight — mouse button to strafe right ➡️
  • mouseb_turnleft — mouse button to turn left ↩️
  • mouseb_turnright — mouse button to turn right ↪️
  • mouseb_use — mouse button to "use" an object, eg. a door or switch 🚪
  • mouseb_backward — mouse button to move backwards 🙈
  • mouseb_prevweapon — mouse button to cycle to the previous weapon
  • mouseb_nextweapon — mouse button to cycle to the next weapon
  • dclick_use — if non-zero, double-clicking a mouse button acts like pressing the "use" key to use an object in-game, eg. a door or switch. double tap, but make it doors 🚪✨

and now the joystick section, aka the part where you find out your controller has opinions 🎮

  • joystick_guid — an SDL GUID string telling the game which joystick to use. an empty string means no joystick is configured. it's giving "single and ready to mingle" 💀
  • joystick_index — index of the SDL joystick to use. this one only matters when you've got multiple identical joystick devices plugged in that share the same GUID and you need to tell them apart. twin energy 👯
  • use_analog — if non-zero, use analog movement when playing with a gamepad 🕹️
  • joystick_x_axis — joystick axis to use for horizontal (X) movement
  • joystick_x_invert — if non-zero, movement on the horizontal joystick axis is inverted 🔄
  • joystick_turn_sensitivity — joystick turn analog sensitivity, specified as a value between 0 and 20
  • joystick_y_axis — joystick axis to use for vertical (Y) movement
  • joystick_y_invert — if non-zero, movement on the vertical joystick axis is inverted 🔄
  • joystick_strafe_axis — joystick axis to use for strafing movement
  • joystick_strafe_invert — if non-zero, movement on the joystick axis used for strafing is inverted 🔄
  • joystick_move_sensitivity — joystick move and strafe analog sensitivity, specified as a value between 0 and 20
  • joystick_look_axis — joystick axis to use for looking up and down 👀
  • joystick_look_invert — if non-zero, movement on the joystick axis used for looking is inverted 🔄
  • joystick_look_sensitivity — joystick look analog sensitivity, specified as a value between 0 and 20

okay so this next bit is the virtual button mapping. there are seventeen of them (0 through 16, no cap) and they all work the same way: you're telling the game which physical joystick button stands in for each virtual button 💅

  • joystick_physical_button0 — the physical joystick button that corresponds to joystick virtual button #0
  • joystick_physical_button1 — the physical joystick button that corresponds to joystick virtual button #1
  • joystick_physical_button2 — the physical joystick button that corresponds to joystick virtual button #2
  • joystick_physical_button3 — the physical joystick button that corresponds to joystick virtual button #3
  • joystick_physical_button4 — the physical joystick button that corresponds to joystick virtual button #4
  • joystick_physical_button5 — the physical joystick button that corresponds to joystick virtual button #5
  • joystick_physical_button6 — the physical joystick button that corresponds to joystick virtual button #6
  • joystick_physical_button7 — the physical joystick button that corresponds to joystick virtual button #7
  • joystick_physical_button8 — the physical joystick button that corresponds to joystick virtual button #8
  • joystick_physical_button9 — the physical joystick button that corresponds to joystick virtual button #9
  • joystick_physical_button10 — the physical joystick button that corresponds to joystick virtual button #10
  • joystick_physical_button11 — the physical joystick button that corresponds to joystick virtual button #11
  • joystick_physical_button12 — the physical joystick button that corresponds to joystick virtual button #12
  • joystick_physical_button13 — the physical joystick button that corresponds to joystick virtual button #13
  • joystick_physical_button14 — the physical joystick button that corresponds to joystick virtual button #14
  • joystick_physical_button15 — the physical joystick button that corresponds to joystick virtual button #15
  • joystick_physical_button16 — the physical joystick button that corresponds to joystick virtual button #16
  • use_gamepad — if non-zero, use the SDL_GameController interface instead of the SDL_Joystick interface 🎮✨
  • gamepad_type — stores the SDL_GameControllerType of the last configured gamepad. it's basically keeping receipts of what you plugged in 🧾
  • joystick_x_dead_zone — joystick x axis dead zone, specified as a percentage of the axis max value
  • joystick_y_dead_zone — joystick y axis dead zone, specified as a percentage of the axis max value
  • joystick_strafe_dead_zone — joystick strafe axis dead zone, specified as a percentage of the axis max value
  • joystick_look_dead_zone — joystick look axis dead zone, specified as a percentage of the axis max value
  • joyb_strafeleft — joystick virtual button to make the player strafe left ⬅️
  • joyb_straferight — joystick virtual button to make the player strafe right ➡️
  • joyb_menu_activate — joystick virtual button to activate the menu
  • joyb_toggle_automap — joystick virtual button to toggle the automap 🗺️
  • joyb_prevweapon — joystick virtual button that cycles to the previous weapon
  • joyb_nextweapon — joystick virtual button that cycles to the next weapon

and now: keybinds 👑 the main character section. every one of these is just "which key does the thing" and honestly? iconic.

  • key_pause — key to pause or unpause the game ⏸️
  • key_menu_activate — key that activates the menu when pressed
  • key_menu_up — key that moves the cursor up on the menu ⬆️
  • key_menu_down — key that moves the cursor down on the menu ⬇️
  • key_menu_left — key that moves the currently selected slider on the menu left
  • key_menu_right — key that moves the currently selected slider on the menu right
  • key_menu_back — key to go back to the previous menu
  • key_menu_forward — key to activate the currently selected menu item
  • key_menu_confirm — key to answer 'yes' to a question in the menu
  • key_menu_abort — key to answer 'no' to a question in the menu
  • key_menu_help — keyboard shortcut to bring up the help screen 🆘
  • key_menu_save — keyboard shortcut to bring up the save game menu 💾
  • key_menu_load — keyboard shortcut to bring up the load game menu 📂
  • key_menu_volume — keyboard shortcut to bring up the sound volume menu 🔊
  • key_menu_detail — keyboard shortcut to toggle the detail level
  • key_menu_qsave — keyboard shortcut to quicksave the current game ✨
  • key_menu_endgame — keyboard shortcut to end the game
  • key_menu_messages — keyboard shortcut to toggle heads-up messages 💬
  • key_menu_qload — keyboard shortcut to load the last quicksave
  • key_menu_quit — keyboard shortcut to quit the game
  • key_menu_gamma — keyboard shortcut to toggle the gamma correction level 🌈
  • key_spy — keyboard shortcut to switch view in multiplayer 👀
  • key_menu_incscreen — keyboard shortcut to increase the screen size
  • key_menu_decscreen — keyboard shortcut to decrease the screen size
  • key_menu_screenshot — keyboard shortcut to save a screenshot 📸
  • key_map_toggle — key to toggle the map view 🗺️
  • key_map_north — key to pan north when in the map view
  • key_map_south — key to pan south when in the map view
  • key_map_east — key to pan east when in the map view
  • key_map_west — key to pan west when in the map view
  • key_map_zoomin — key to zoom in when in the map view 🔍
  • key_map_zoomout — key to zoom out when in the map view
  • key_map_maxzoom — key to zoom out the maximum amount when in the map view
  • key_map_follow — key to toggle follow mode when in the map view
  • key_map_grid — key to toggle the grid display when in the map view
  • key_map_mark — key to set a mark when in the map view 📍
  • key_map_clearmark — key to clear all marks when in the map view
  • key_weapon1 — key to select weapon 1
  • key_weapon2 — key to select weapon 2
  • key_weapon3 — key to select weapon 3
  • key_weapon4 — key to select weapon 4
  • key_weapon5 — key to select weapon 5
  • key_weapon6 — key to select weapon 6
  • key_weapon7 — key to select weapon 7
  • key_weapon8 — key to select weapon 8
  • key_prevweapon — key to cycle to the previous weapon
  • key_nextweapon — key to cycle to the next weapon
  • key_message_refresh — key to re-display last message 🔁
  • key_demo_quit — key to quit the game when recording a demo 🎬
  • key_multi_msg — key to send a message during multiplayer games 💬
  • key_multi_msgplayer1 — key to send a message to player 1 during multiplayer games
  • key_multi_msgplayer2 — key to send a message to player 2 during multiplayer games
  • key_multi_msgplayer3 — key to send a message to player 3 during multiplayer games
  • key_multi_msgplayer4 — key to send a message to player 4 during multiplayer games

👀 SEE ALSO 👀

and that's the whole vibe check, bestie 🫶 this page was served to you fresh from Chocolate Doom 3.1.1, dated 2024-01-23, and it's literally the chocolate-doom.cfg(5) manual. go forth and bind some keys, you absolute icon 💖✨🌸

📦 where this page comes from