yquake2/yquake2remaster
0
0
Fork 0
mirror of https://github.com/yquake2/yquake2remaster.git synced 2024-11-10 07:12:07 +00:00
Code Issues Projects Releases Packages Wiki Activity

Update the cvarlist to match reality.

Browse source
This commit is contained in:
Yamagi Burmeister 2018-11-05 10:42:11 +01:00
parent 1a6c1f5227
commit edd3b1da8a
1 changed files with 112 additions and 109 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

221
doc/04_cvarlist.md
View file

@ -1,5 +1,4 @@
Yamagi Quake II Console Variables # Yamagi Quake II Console Variables
=================================
This lists explains most console variables (cvars) added by Yamagi This lists explains most console variables (cvars) added by Yamagi
Quake II. Most of the original clients (Vanilla Quake II) cvars are Quake II. Most of the original clients (Vanilla Quake II) cvars are
@ -12,66 +11,69 @@ have been renamed. The prefixes are:
* `gl1_`: OpenGL 1.4 renderer. * `gl1_`: OpenGL 1.4 renderer.
* `gl3_`: OpenGL 3.2 renderer. * `gl3_`: OpenGL 3.2 renderer.
* `ogg_`: Ogg/Vorbis music playback. * `ogg_`: Ogg/Vorbis music playback.
* `r_`: All renderers. * `r_`: Common to all renderers.
* `s_`: Sound system. * `s_`: Sound system.
* `sw_`: Software renderer.
* `vid_`: Video backend. * `vid_`: Video backend.
All cvars may be given at command line trough `+set cvar value` or typed
into the console. The console can be opended with *shift-esc*.
Command line arguments
---------------------- ## Command line arguments
These are not console variables, they cannot be entered into the These are not console variables, they cannot be entered into the
console only be given at the command line at startup. While cvars console, only be given through the command line at startup. While cvars
are prefixed with a `+` arguments are starting with a `-`. For are prefixed with a `+`, arguments are starting with a `-`. For example
example it's `+set busywait 0` (setting the `busywait` cvar) and it's `+set busywait 0` (setting the `busywait` cvar) and `-portable`
`-portable` (setting the `portable` argument). (setting the `portable` argument).
* **datadir**: Directory from which the game data is loaded. Can be used * **datadir**: Directory from which the game data is loaded. Can be used
in startup scripts, to test binaries, etc. If not set, the directory in startup scripts, to test binaries, etc. If not set, the directory
containing the binaries is used. containing the binaries is used.
* **portable**: Makes Quake II portable, all runtime data like the * **portable**: Makes Quake II portable, all runtime data like the the
the config, savegames and so on is stored next to the executable and config, savegames and so on is stored next to the executable and not
not in the users home directory. in the users home directory.
General: ## General
--------
* **busywait**: By default this is set to `1`. causing Quake II to spin * **busywait**: By default this is set to `1`. causing Quake II to spin
in a very tight loop until it's time to process the next frame. This is in a very tight loop until it's time to process the next frame. This
a very accurate way to determine the internal timing but comes with a is a very accurate way to determine the internal timing but comes with
relatively high CPU usage. If set to `0` Quake II lays itself to sleep a relatively high CPU usage. If set to `0` Quake II lays itself to
and tells the operating system to send a wakeup signal when it's time sleep and tells the operating system to send a wakeup signal when it's
for the next frame. The later is more CPU friendly but rather inaccurate, time for the next frame. The later is more CPU friendly but rather
especially on Windows. Use with care. inaccurate, especially on Windows. Use with care.
* **cl_async**: If set to `1` (the default) the client is asynchronous. * **cl_async**: If set to `1` (the default) the client is asynchronous.
The client framerate is fixed, the renderer framerate is variable. The client framerate is fixed, the renderer framerate is variable.
This makes it possible to renderer as many frames as desired without This makes it possible to renderer as many frames as desired without
any physics and movement problems. The client framerate is controlled any physics and movement problems. The client framerate is controlled
by *cl_maxfps*, set to `60` by defaut. The renderer framerate is by *cl_maxfps*, set to `60` by defaut. The renderer framerate is
controlled by *vid_maxfps*. There are two constraints: *vid_maxfps* must controlled by *vid_maxfps*. There are two constraints:
be the same or greater than *cl_maxfps*. In case that the vsync is
active, *vid_maxfps* must not be lower than the display refresh rate.
If *cl_async* is set to `0` *vid_maxfps* is the same as *cl_maxfps*, use
*cl_maxfps* to set the framerate.
* **cl_showfps**: Shows the framecounter. The shown value is rather * *vid_maxfps* must be the same or greater than *cl_maxfps*.
inaccurate and gets less precise with higher framerates, as it only * In case that the vsync is active, *vid_maxfps* must not be lower
measures full milliseconds. than the display refresh rate.
If *cl_async* is set to `0` *vid_maxfps* is the same as *cl_maxfps*,
use *cl_maxfps* to set the framerate.
* **in_grab**: Defines how the mouse is grabbed by Quake IIs window. If * **cl_showfps**: Shows the framecounter.
set to `0` the mouse is never grabbed and if set to `1` it's always
grabbed. If set to `2` (the default) the mouse is grabbed during * **in_grab**: Defines how the mouse is grabbed by Yamagi Quake IIs
gameplay and released otherwise (in menu, console or if game is paused). window. If set to `0` the mouse is never grabbed and if set to `1`
it's always grabbed. If set to `2` (the default) the mouse is grabbed
during gameplay and released otherwise (in menu, videos, console or if
game is paused).
Audio: ## Audio
------
* **al_device**: OpenAL device to use. In most cases there's no need to * **al_device**: OpenAL device to use. In most cases there's no need to
change this, since the default device is normally the right choice. change this, since the default device is normally the correct choice.
* **al_driver**: OpenAL library to use. This is usefull if for some * **al_driver**: OpenAL library to use. This is usefull if for some
reasons several OpenAL libraries are available and Quake II picks the reasons several OpenAL libraries are available and Quake II picks the
@ -80,12 +82,13 @@ Audio:
* **ogg_enable**: Enable Ogg/Vorbis music playback. * **ogg_enable**: Enable Ogg/Vorbis music playback.
* **ogg_ignoretrack0**: Normally Quake II disabled the background music * **ogg_ignoretrack0**: Normally Quake II disables the background music
if a major objective has been archived by setting the music track to 0. if a major objective has been archived by setting the music track to
Setting this cvar to `1` disables this behavior, the music keeps playing. 0. Setting this cvar to `1` disables this behavior, the music keeps
playing.
* **s_doppler**: If set to `1` (the default) doppler effects are enabled. * **s_doppler**: If set to `1` (the default) doppler effects are
This is only supported by the OpenAL sound backend. enabled. This is only supported by the OpenAL sound backend.
* **s_openal**: Use OpenAL for sound playback. This is enabled by * **s_openal**: Use OpenAL for sound playback. This is enabled by
default. OpenAL gives a huge quality boost over the classic sound default. OpenAL gives a huge quality boost over the classic sound
@ -94,20 +97,19 @@ Audio:
* **s_underwater**: Dampen sounds if submerged. Enabled by default. * **s_underwater**: Dampen sounds if submerged. Enabled by default.
Graphics (all renderers): ## Graphics (all renderers)
-------------------------
* Most old `r_*` cvars, but renamed to `gl_*` * Most old `r_*` cvars, but renamed to `gl_*`
* **vid_displayrefreshrate**: Sets the displays refresh rate. The * **vid_displayrefreshrate**: Sets the displays refresh rate. The
default `-1` let the game determine the refresh rate automatically. default `-1` let the game determine the refresh rate automatically.
There's little need to change that. If you do make sure that the refresh Often the default setting is okay, but some graphics drivers report
rate is rounded up, e.g. with a display of 59.95hz you should set `60`. wrong refresh rates. For example 59hz are reported while the display
Otherwise the game will render too few frames. has 59.95hz.
* **vid_renderer**: Selects the renderer library. Possible options are * **vid_renderer**: Selects the renderer library. Possible options are
`gl1` (the default) for the old OpenGL 1.4 renderer and `gl3` for `gl1` (the default) for the old OpenGL 1.4 renderer, `gl3` for the new
the new OpenGL 3.2 renderer. OpenGL 3.2 renderer and `soft` for the software renderer.
* **cin_force43**: If set to `1` (the default) cinematics are displayed * **cin_force43**: If set to `1` (the default) cinematics are displayed
with an aspect ratio of 4:3, regardless what the actual windows size with an aspect ratio of 4:3, regardless what the actual windows size
@ -122,50 +124,50 @@ Graphics (all renderers):
* **fov**: Sets the field of view. * **fov**: Sets the field of view.
* **r_gunfov**: The weapons are rendered with a custom field of view, * **r_gunfov**: The weapons are rendered with a custom field of view,
independently of the global **fov**, so they are not distorted at high FOVs. independently of the global **fov**, so they are not distorted at high
A value of `75` should look identical to the old code at `fov 90`, FOVs. A value of `75` should look identical to the old code at `fov
it defaults to `80` because that looks a bit better. 90`, it defaults to `80` because that looks a bit better.
* **horplus**: If set to 1 (the default) the horplus algorithm is used * **horplus**: If set to 1 (the default) the horplus algorithm is used
to calculate an optimal horizontal and vertical field of view, independent to calculate an optimal horizontal and vertical field of view,
of the window or screen aspect ratio or resolution. independent of the window or screen aspect ratio or resolution. If
If enabled *fov* is forced to `90`. enabled *fov* is forced to `90`.
* **vid_gamma**: The value used for gamma correction. Higher value looks * **vid_gamma**: The value used for gamma correction. Higher value looks
brighter. The GL1 renderer uses "Hardware Gamma", setting the Gamma of brighter. The OpenGL 1.4 and software renderers use "Hardware Gamma",
your whole screen to this value in realtime (except on OSX where it's setting the Gamma of the whole screen to this value in realtime
applied to textures on load and thus needs a `vid_restart` after changing). (except on MacOS where it's applied to textures on load and thus needs
The GL3 renderer applies this to the window in realtime via shaders a `vid_restart` after changing). The OpenGL 3.2 renderer applies this
(on all platforms). to the window in realtime via shaders (on all platforms). This is
This is also set by the brightness slider in the video menu. also set by the brightness slider in the video menu.
* **r_consolescale** / **r_hudscale** / **r_menuscale**, **crosshair_scale**: * **r_consolescale** / **r_hudscale** / **r_menuscale** and
Scale the console, the HUD, the menu and the crosshair. The value given **crosshair_scale**: Scale the console, the HUD, the menu and the
is the scale factor, a factor of `1` means no scaling. Values greater crosshair. The value given is the scale factor, a factor of `1` means
`1` make the objects bigger, values lower 1 smaller. The special value no scaling. Values greater `1` make the objects bigger, values lower 1
`-1` sets the optimal scaling factor for the current resolution. smaller. The special value `-1` (default) sets the optimal scaling
factor for the current resolution.
* **r_customheight** / **r_customwidth**: Specifies a custom * **r_customheight** / **r_customwidth**: Specifies a custom resolution,
resolution, the windows will be *r_customheight* pixels high and the windows will be *r_customheight* pixels high and *r_customwidth*
*r_customwidth* pixels wide. Set *r_mode* to `-1` to use the custom pixels wide. Set *r_mode* to `-1` to use the custom resolution.
resolution.
* **r_farsee**: Normally Quake II renders only up to 4096 units. If set * **r_farsee**: Normally Quake II renders only up to 4096 units. If set
to `1` the limit is increased to 8192 units. to `1` the limit is increased to 8192 units. This helps with some
custom maps and is problematic with other custom maps.
* **vid_maxfps**: The maximum framerate, if `cl_async` is `1`. Otherwise * **vid_maxfps**: The maximum framerate, if `cl_async` is `1`. Otherwise
`cl_maxfps` is used as maximum framerate. See `cl_async` description `cl_maxfps` is used as maximum framerate. See `cl_async` description
above for more information. above for more information. *Note* that vsync (`r_vsync`) also
*Note* that vsync (`r_vsync`) also restricts the framerate to restricts the framerate to the monitor refresh rate, so if vsync is
the monitor refresh rate, so if vsync is enabled, you won't get more than enabled, the game won't render more than 60fps on most displays (or
60fps on most displays (or 120 on a 120hz display etc). 120 on a 120hz display etc).
* **r_vsync**: Enables the vsync: frames are synchronized with * **r_vsync**: Enables the vsync: frames are synchronized with
display refresh rate, should (but doesn't always) prevent tearing. display refresh rate, should (but doesn't always) prevent tearing.
Graphics (GL renderers only): ## Graphics (GL renderers only)
-----------------------------
* **gl_anisotropic**: Anisotropic filtering. Possible values are * **gl_anisotropic**: Anisotropic filtering. Possible values are
dependent on the GPU driver, most of them support `1`, `2`, `4`, `8` dependent on the GPU driver, most of them support `1`, `2`, `4`, `8`
@ -173,15 +175,16 @@ Graphics (GL renderers only):
quality by a negligible performance impact. quality by a negligible performance impact.
* **gl_msaa_samples**: Full scene anti aliasing samples. The number of * **gl_msaa_samples**: Full scene anti aliasing samples. The number of
samples depends on the GPU driver, most drivers support at least samples depends on the GPU driver, most drivers support at least `2`,
`2`, `4` and `8` samples. If an invalid value is set, the value is `4` and `8` samples. If an invalid value is set, the value is reverted
reverted to the highest number of samples supported. Especially on OpenGL to the highest number of samples supported. Especially on OpenGL 3.2
3.2 anti aliasing is expensive and can lead to a huge performance hit, anti aliasing is expensive and can lead to a huge performance hit, so
so try setting it to a lower value if your framerate is too low. try setting it to a lower value if the framerate is too low.
* **gl_nolerp_list**: list seperate by spaces of textures ommitted from * **gl_nolerp_list**: list seperate by spaces of textures ommitted from
bilinear filtering. Used by default to exclude the console and HUD fonts. bilinear filtering. Used by default to exclude the console and HUD
Make sure to include the default values when extending the list. fonts. Make sure to include the default values when extending the
list.
* **gl_retexturing**: If set to `1` (the default) and a retexturing pack * **gl_retexturing**: If set to `1` (the default) and a retexturing pack
is installed, the high resolution textures are used. is installed, the high resolution textures are used.
@ -195,50 +198,50 @@ Graphics (GL renderers only):
small render errors. small render errors.
Graphics (GL1 only): ## Graphics (OpenGL 1.4 only)
--------------------
* **gl1_intensity**: Sets the color intensity used for 3D rendering. * **gl1_intensity**: Sets the color intensity used for 3D rendering.
Must be a floating point value, at least `1.0` - default is `2.0`. Must be a floating point value, at least `1.0` - default is `2.0`.
Applied when textures are loaded, so it needs a `vid_restart`! Applied when textures are loaded, so it needs a `vid_restart`!
* **gl1_overbrightbits**: Enables overbright bits, brightness scaling of * **gl1_overbrightbits**: Enables overbright bits, brightness scaling of
lightmaps and models. Higher values make shadows less dark. lightmaps and models. Higher values make shadows less dark. Possible
Possible values are `0` (no overbright bits), `1` (correct lighting values are `0` (no overbright bits), `1` (correct lighting for water),
for water), `2` (scale by factor 2) and `3` (scale by factor 3). `2` (scale by factor 2) and `3` (scale by factor 3). Applied in
Applied in realtime, does not need `vid_restart`. realtime, does not need `vid_restart`.
* **gl1_stencilshadow**: If `gl_shadows` is set to `1`, this makes them * **gl1_stencilshadow**: If `gl_shadows` is set to `1`, this makes them
look a bit better (no flickering) by using the stencil buffer. look a bit better (no flickering) by using the stencil buffer. (This
(This is always done in GL3, so not configurable there) is always done in OpenGL 3.2, so not configurable there)
Graphics (GL3 only): ## Graphics (OpenGL 3.2 only)
--------------------
* **gl3_debugcontext**: Enables the OpenGL 3.2 renderers debug context, * **gl3_debugcontext**: Enables the OpenGL 3.2 renderers debug context,
e.g. prints warnings and errors emmitted by the GPU driver. e.g. prints warnings and errors emmitted by the GPU driver. Not
Not supported on OSX. This is a pure debug cvar and slows down rendering. supported on MacSO. This is a pure debug cvar and slows down
rendering.
* **gl3_intensity**: Sets the color intensity used for 3D rendering. * **gl3_intensity**: Sets the color intensity used for 3D rendering.
Similar to GL1 `intensity`, but more flexible: can be any value between Similar to OpenGL 1.4 `gl1_intensity`, but more flexible: can be any
0.0 (completely dark) and 256.0 (very bright). value between 0.0 (completely dark) and 256.0 (very bright). Good
Good values are between `1.0` and `2.0`, default is `1.5`. values are between `1.0` and `2.0`, default is `1.5`. Applied in
Applied in realtime via shader, so it does *not* need a `vid_restart`. realtime via shader, so it does *not* need a `vid_restart`.
* **gl3_intensity_2D**: The same for 2D rendering (HUD, menu, console, videos) * **gl3_intensity_2D**: The same for 2D rendering (HUD, menu, console,
videos)
* **gl3_overbrightbits**: Enables overbright bits, brightness scaling of * **gl3_overbrightbits**: Enables overbright bits, brightness scaling of
lightmaps and models. Higher values make shadows less dark. lightmaps and models. Higher values make shadows less dark. Similar
Similar to GL1's `gl1_overbrightbits`, but allows any floating point number. to OpenGL 1.4 `gl1_overbrightbits`, but allows any floating point
Default is `1.3`. In the OpenGL3.2 renderer, no lighting fixes for water number. Default is `1.3`. In the OpenGL 3.2 renderer, no lighting
are needed, so `1.0` has no special meaning. fixes for water are needed, so `1.0` has no special meaning.
* **gl3_particle_size**: The size of particles - Default is `40`. * **gl3_particle_size**: The size of particles - Default is `40`.
* **gl3_particle_fade_factor**: "softness" of particles: higher values * **gl3_particle_fade_factor**: "softness" of particles: higher values
look less soft. Defaults to `1.2`. look less soft. Defaults to `1.2`. A value of `10` looks similar to
A value of `10` looks similar to the GL1 particles. the OpenGL 1.4 particles.
* **gl3_particle_square**: If set to `1`, particles are rendered as squares, * **gl3_particle_square**: If set to `1`, particles are rendered as
like in the old software renderer or Quake1. Default is `0`. squares, like in the old software renderer or Quake 1. Default is `0`.