ref: 99baaba60c7b24a9877db7b9726b51408713a0c5
parent: 38eb80a7dcb5a76b594d6dde1da630953c925005
author: Simon Howard <fraggle@soulsphere.org>
date: Sun Jan 8 15:13:23 EST 2017
Rearrange entries for extra config file. This groups related entries together in a more logical way - all video options together, all sound options together, etc.
--- a/src/m_config.c
+++ b/src/m_config.c
@@ -691,12 +691,20 @@
static default_t extra_defaults_list[] =
{//!
- // @game heretic hexen strife
+ // Name of the SDL video driver to use. If this is an empty string,
+ // the default video driver is used.
//
- // If non-zero, display the graphical startup screen.
+
+ CONFIG_VARIABLE_STRING(video_driver),
+
+ //!
+ // Position of the window on the screen when running in windowed
+ // mode. Accepted values are: "" (empty string) - don't care,
+ // "center" - place window at center of screen, "x,y" - place
+ // window at the specified coordinates.
//
- CONFIG_VARIABLE_INT(graphical_startup),
+ CONFIG_VARIABLE_STRING(window_position),
//!
// If non-zero, the game will run in full screen mode. If zero,
@@ -713,15 +721,6 @@
CONFIG_VARIABLE_INT(aspect_ratio_correct),
//!
- // Number of milliseconds to wait on startup after the video mode
- // has been set, before the game will start. This allows the
- // screen to settle on some monitors that do not display an image
- // for a brief interval after changing video modes.
- //
-
- CONFIG_VARIABLE_INT(startup_delay),
-
- //!
// Window width when running in windowed mode.
//
@@ -740,6 +739,7 @@
// rather than ever switching screen modes. It should usually
// be unnecessary to set this value.
//
+
CONFIG_VARIABLE_INT(fullscreen_width),
//!
@@ -746,41 +746,59 @@
// Height for screen mode when running fullscreen.
// See documentation for fullscreen_width.
//
+
CONFIG_VARIABLE_INT(fullscreen_height),
//!
- // If this is non-zero, the mouse will be "grabbed" when running
- // in windowed mode so that it can be used as an input device.
- // When running full screen, this has no effect.
+ // If non-zero, force the use of a software renderer. For use on
+ // systems lacking hardware acceleration.
//
- CONFIG_VARIABLE_INT(grabmouse),
+ CONFIG_VARIABLE_INT(force_software_renderer),
//!
- // If non-zero, all vertical mouse movement is ignored. This
- // emulates the behavior of the "novert" tool available under DOS
- // that performs the same function.
+ // Number of milliseconds to wait on startup after the video mode
+ // has been set, before the game will start. This allows the
+ // screen to settle on some monitors that do not display an image
+ // for a brief interval after changing video modes.
//
- CONFIG_VARIABLE_INT(novert),
+ CONFIG_VARIABLE_INT(startup_delay),
//!
- // Mouse acceleration factor. When the speed of mouse movement
- // exceeds the threshold value (mouse_threshold), the speed is
- // multiplied by this value.
+ // @game heretic hexen strife
//
+ // If non-zero, display the graphical startup screen.
+ //
- CONFIG_VARIABLE_FLOAT(mouse_acceleration),
+ CONFIG_VARIABLE_INT(graphical_startup),
//!
- // Mouse acceleration threshold. When the speed of mouse movement
- // exceeds this threshold value, the speed is multiplied by an
- // acceleration factor (mouse_acceleration).
+ // @game doom heretic strife
//
+ // If non-zero, the ENDOOM text screen is displayed when exiting the
+ // game. If zero, the ENDOOM screen is not displayed.
+ //
- CONFIG_VARIABLE_INT(mouse_threshold),
+ CONFIG_VARIABLE_INT(show_endoom),
//!
+ // @game doom strife
+ //
+ // If non-zero, a disk activity indicator is displayed when data is read
+ // from disk. If zero, the disk activity indicator is not displayed.
+ //
+
+ CONFIG_VARIABLE_INT(show_diskicon),
+
+ //!
+ // If non-zero, save screenshots in PNG format. If zero, screenshots are
+ // saved in PCX format, as Vanilla Doom does.
+ //
+
+ CONFIG_VARIABLE_INT(png_screenshots),
+
+ //!
// Sound output sample rate, in Hz. Typical values to use are
// 11025, 22050, 44100 and 48000.
//
@@ -800,6 +818,7 @@
// might be more efficient but will introduce latency to the
// sound output. The default is 28ms (one slice per tic with the
// 35fps timer).
+ //
CONFIG_VARIABLE_INT(snd_maxslicetime_ms),
@@ -806,7 +825,7 @@
//!
// If non-zero, sound effects will have their pitch varied up or
// down by a random amount during play. If zero, sound effects
- // play back at their default pitch. The default is zero.
+ // play back at their default pitch.
//
CONFIG_VARIABLE_INT(snd_pitchshift),
@@ -816,6 +835,7 @@
// the empty string, SDL_mixer's internal MIDI playback is used.
// This only has any effect when snd_musicdevice is set to General
// MIDI output.
+ //
CONFIG_VARIABLE_STRING(snd_musiccmd),
@@ -824,6 +844,7 @@
// "-opl3", output for an OPL3 chip is generated when in OPL MIDI
// playback mode.
//
+
CONFIG_VARIABLE_STRING(snd_dmxoption),
//!
@@ -833,30 +854,60 @@
CONFIG_VARIABLE_INT_HEX(opl_io_port),
+#ifdef FEATURE_SOUND
+
//!
- // @game doom heretic strife
+ // Controls whether libsamplerate support is used for performing
+ // sample rate conversions of sound effects. Support for this
+ // must be compiled into the program.
//
- // If non-zero, the ENDOOM text screen is displayed when exiting the
- // game. If zero, the ENDOOM screen is not displayed.
+ // If zero, libsamplerate support is disabled. If non-zero,
+ // libsamplerate is enabled. Increasing values roughly correspond
+ // to higher quality conversion; the higher the quality, the
+ // slower the conversion process. Linear conversion = 1;
+ // Zero order hold = 2; Fast Sinc filter = 3; Medium quality
+ // Sinc filter = 4; High quality Sinc filter = 5.
//
- CONFIG_VARIABLE_INT(show_endoom),
+ CONFIG_VARIABLE_INT(use_libsamplerate),
//!
- // @game doom strife
+ // Scaling factor used by libsamplerate. This is used when converting
+ // sounds internally back into integer form; normally it should not
+ // be necessary to change it from the default value. The only time
+ // it might be needed is if a PWAD file is loaded that contains very
+ // loud sounds, in which 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 is
+ // possible without clipping occurring.
+
+ CONFIG_VARIABLE_FLOAT(libsamplerate_scale),
+
+ //!
+ // 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 is no need to add "dir" commands
+ // into it.
//
- // If non-zero, a disk activity indicator is displayed when data is read
- // from disk. If zero, the disk activity indicator is not displayed.
+
+ CONFIG_VARIABLE_STRING(timidity_cfg_path),
+
+ //!
+ // Path to GUS patch files to use when operating in GUS emulation
+ // mode.
//
- CONFIG_VARIABLE_INT(show_diskicon),
+ CONFIG_VARIABLE_STRING(gus_patch_path),
//!
- // If non-zero, save screenshots in PNG format.
+ // Number of kilobytes of RAM to use in GUS emulation mode. Valid
+ // values are 256, 512, 768 or 1024.
//
- CONFIG_VARIABLE_INT(png_screenshots),
+ CONFIG_VARIABLE_INT(gus_ram_kb),
+#endif
+
//!
// @game doom strife
//
@@ -887,39 +938,93 @@
CONFIG_VARIABLE_INT(vanilla_keyboard_mapping),
+#ifdef FEATURE_MULTIPLAYER
+
//!
- // Name of the SDL video driver to use. If this is an empty string,
- // the default video driver is used.
+ // Name to use in network games for identification. This is only
+ // used on the "waiting" screen while waiting for the game to start.
//
- CONFIG_VARIABLE_STRING(video_driver),
+ CONFIG_VARIABLE_STRING(player_name),
+#endif
+
//!
- // Position of the window on the screen when running in windowed
- // mode. Accepted values are: "" (empty string) - don't care,
- // "center" - place window at center of screen, "x,y" - place
- // window at the specified coordinates.
+ // If this is non-zero, the mouse will be "grabbed" when running
+ // in windowed mode so that it can be used as an input device.
+ // When running full screen, this has no effect.
+ //
- CONFIG_VARIABLE_STRING(window_position),
+ CONFIG_VARIABLE_INT(grabmouse),
//!
- // If non-zero, force the use of a software renderer. For use on
- // systems lacking hardware acceleration.
+ // If non-zero, all vertical mouse movement is ignored. This
+ // emulates the behavior of the "novert" tool available under DOS
+ // that performs the same function.
//
- CONFIG_VARIABLE_INT(force_software_renderer),
-#ifdef FEATURE_MULTIPLAYER
+ CONFIG_VARIABLE_INT(novert),
//!
- // Name to use in network games for identification. This is only
- // used on the "waiting" screen while waiting for the game to start.
+ // Mouse acceleration factor. When the speed of mouse movement
+ // exceeds the threshold value (mouse_threshold), the speed is
+ // multiplied by this value.
//
- CONFIG_VARIABLE_STRING(player_name),
+ CONFIG_VARIABLE_FLOAT(mouse_acceleration),
-#endif
+ //!
+ // Mouse acceleration threshold. When the speed of mouse movement
+ // exceeds this threshold value, the speed is multiplied by an
+ // acceleration factor (mouse_acceleration).
+ //
+ CONFIG_VARIABLE_INT(mouse_threshold),
+
//!
+ // Mouse button to strafe left.
+ //
+
+ CONFIG_VARIABLE_INT(mouseb_strafeleft),
+
+ //!
+ // Mouse button to strafe right.
+ //
+
+ CONFIG_VARIABLE_INT(mouseb_straferight),
+
+ //!
+ // Mouse button to "use" an object, eg. a door or switch.
+ //
+
+ CONFIG_VARIABLE_INT(mouseb_use),
+
+ //!
+ // Mouse button to move backwards.
+ //
+
+ CONFIG_VARIABLE_INT(mouseb_backward),
+
+ //!
+ // Mouse button to cycle to the previous weapon.
+ //
+
+ CONFIG_VARIABLE_INT(mouseb_prevweapon),
+
+ //!
+ // Mouse button to cycle to the next weapon.
+ //
+
+ CONFIG_VARIABLE_INT(mouseb_nextweapon),
+
+ //!
+ // 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.
+ //
+
+ CONFIG_VARIABLE_INT(dclick_use),
+
+ //!
// SDL GUID string indicating the joystick to use. An empty string
// indicates that no joystick is configured.
//
@@ -1083,103 +1188,6 @@
//
CONFIG_VARIABLE_INT(joyb_nextweapon),
-
- //!
- // Mouse button to strafe left.
- //
-
- CONFIG_VARIABLE_INT(mouseb_strafeleft),
-
- //!
- // Mouse button to strafe right.
- //
-
- CONFIG_VARIABLE_INT(mouseb_straferight),
-
- //!
- // Mouse button to "use" an object, eg. a door or switch.
- //
-
- CONFIG_VARIABLE_INT(mouseb_use),
-
- //!
- // Mouse button to move backwards.
- //
-
- CONFIG_VARIABLE_INT(mouseb_backward),
-
- //!
- // Mouse button to cycle to the previous weapon.
- //
-
- CONFIG_VARIABLE_INT(mouseb_prevweapon),
-
- //!
- // Mouse button to cycle to the next weapon.
- //
-
- CONFIG_VARIABLE_INT(mouseb_nextweapon),
-
- //!
- // 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.
- //
-
- CONFIG_VARIABLE_INT(dclick_use),
-
-#ifdef FEATURE_SOUND
-
- //!
- // Controls whether libsamplerate support is used for performing
- // sample rate conversions of sound effects. Support for this
- // must be compiled into the program.
- //
- // If zero, libsamplerate support is disabled. If non-zero,
- // libsamplerate is enabled. Increasing values roughly correspond
- // to higher quality conversion; the higher the quality, the
- // slower the conversion process. Linear conversion = 1;
- // Zero order hold = 2; Fast Sinc filter = 3; Medium quality
- // Sinc filter = 4; High quality Sinc filter = 5.
- //
-
- CONFIG_VARIABLE_INT(use_libsamplerate),
-
- //!
- // Scaling factor used by libsamplerate. This is used when converting
- // sounds internally back into integer form; normally it should not
- // be necessary to change it from the default value. The only time
- // it might be needed is if a PWAD file is loaded that contains very
- // loud sounds, in which 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 is
- // possible without clipping occurring.
-
- CONFIG_VARIABLE_FLOAT(libsamplerate_scale),
-
- //!
- // 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 is no need to add "dir" commands
- // into it.
- //
-
- CONFIG_VARIABLE_STRING(timidity_cfg_path),
-
- //!
- // Path to GUS patch files to use when operating in GUS emulation
- // mode.
- //
-
- CONFIG_VARIABLE_STRING(gus_patch_path),
-
- //!
- // Number of kilobytes of RAM to use in GUS emulation mode. Valid
- // values are 256, 512, 768 or 1024.
- //
-
- CONFIG_VARIABLE_INT(gus_ram_kb),
-
-#endif
//!
// Key to pause or unpause the game.