Difference between revisions of "Console Reference"

From ioquake3 wiki
Jump to: navigation, search
(Created page with '== Console Variables == == Console Commands == == RCON Commands ==')
 
(First pass at documenting ioquake3 variables & commands)
 
Line 1: Line 1:
 
== Console Variables ==
 
== Console Variables ==
 +
 +
{| class="wikitable sortable"
 +
|+Console Variables
 +
|-
 +
! Variable !! Type !! class="unsortable" | Default Value !! class="unsortable" | Description !! ioquake3 Only
 +
|-
 +
| cl_autoRecordDemo || Boolean ||  || Record a new demo on each map change. || Yes
 +
|-
 +
| cl_aviFrameRate || Integer ||  || The framerate to use when capturing video. || Yes
 +
|-
 +
| cl_aviMotionJpeg || Boolean ||  || Use the mjpeg codec when capturing video. || Yes
 +
|-
 +
| cl_platformSensitivity || RO Float || ||Indicates the mouse input scaling. || Yes
 +
|-
 +
| com_altivec || Boolean || || Enable the use of Altivec on PowerPC systems. || Yes
 +
|-
 +
| com_hunkMegs || Integer || 20 || set the amount of memory you want quake3.exe to reserve for game play dedicated server memory optimizations. Tips: com_hunkMegs 4 sv_maxclients 3 bot_enable 0 "John Carmack".
 +
|-
 +
| com_soundMegs || Integer || 8 || com_soundmegs and com_zonemegs can be adjusted to provide better performance on systems with more than 64mb of memory. the default configuration is set to allow the game to run on a 64 MB system. on a 128 MB system we would run with the following:com_hunkMegs - 64 com_soundMegs - 16 com_zoneMegs - 24.
 +
|-
 +
| com_zoneMegs || Integer || 16 || com_soundmegs and com_zonemegs can be adjusted to provide better performance on systems with more than 64mb of memory. the default configuration is set to allow the game to run on a 64 MB system. on a 128 MB system we would run with the following:com_hunkMegs - 64 com_soundMegs - 16 com_zoneMegs - 24.
 +
|-
 +
| fs_game || String ||  || Set gamedir set the game folder/dir default is baseq3 (other for MODS).
 +
|-
 +
| in_disablemacosxmouseaccel || Integer ||  || Disable mouse acceleration when running OS X with a mouse, defaults to 1. || Yes
 +
|-
 +
| r_customheight || Integer ||  || Custom resolution (Height).
 +
|-
 +
| r_customwidth || Integer ||  || Custom resolution (Width).
 +
|-
 +
| r_fullscreen || Integer || 1 || Toggle full screen or play in a window.
 +
|-
 +
| r_GLlibCoolDownMsec || Integer || || Wait for a number of milliseconds to close GL library. || Yes
 +
|-
 +
| r_mode || Integer ||  || Set video display mode.
 +
|-
 +
| s_useOpenAL || Boolean ||  || Use the OpenAL sound backend if it’s available. || Yes
 +
|-
 +
| s_alPrecache || Boolean ||  || Cache OpenAL sounds before use. || Yes
 +
|-
 +
| s_alGain || Float ||  || The value of AL_GAIN for each source. || Yes
 +
|-
 +
| s_alSources || Integer ||  || The total number of sources (memory) to allocate. || Yes
 +
|-
 +
| s_alDopplerFactor || Float ||  || The value passed to alDopplerFactor(). || Yes
 +
|-
 +
| s_alDopplerSpeed || Float ||  || The value passed to alDopplerVelocity(). || Yes
 +
|-
 +
| s_alMinDistance || Float ||  || The value of AL_REFERENCE_DISTANCE for each source. || Yes
 +
|-
 +
| s_alRolloff || Float ||  || The value of AL_ROLLOFF_FACTOR for each source. || Yes
 +
|-
 +
| s_alMaxSpeakerDistance || Float ||  || ET_SPEAKERS beyond this distance are culled. || Yes
 +
|-
 +
| s_alDriver || String ||  || Which OpenAL library to use. || Yes
 +
|-
 +
| s_backend || RO String || || Indicates the current sound backend. || Yes
 +
|-
 +
| s_sdlBits || Integer ||  || SDL bit resolution. || Yes
 +
|-
 +
| s_sdlSpeed || Integer ||  || SDL sample rate. || Yes
 +
|-
 +
| s_sdlChannels || Integer || || SDL number of channels. || Yes
 +
|-
 +
| s_sdlDevSamps || Integer || || SDL DMA buffer size override. || Yes
 +
|-
 +
| s_sdlMixSamps || Integer || || SDL mix buffer size override. || Yes
 +
|-
 +
| sv_voip || Boolean || 1 || set to "1" (the default) to enable server-side VoIP support. Set to "0" to disable. Without this, all VoIP packets are refused by the server, which means no one gets to use in-game VoIP. || Yes
 +
 +
|-
 +
| ttycon_ansicolor || Boolean ||  || Enable the addition of ANSI escape codes for colors in the tty. || Yes
 +
|}
  
 
== Console Commands ==
 
== Console Commands ==
  
 +
{| class="wikitable sortable"
 +
|+Console Commands
 +
|-
 +
! Command !!  class="unsortable" | Description !! ioquake3 Only
 +
|-
 +
| stopvideo || Stop the video capture. || Yes
 +
|-
 +
| video <filename> || Start video capture (use with demo command). Outputs to filename. || Yes
 +
|-
 +
| voip ignore <clientnum> || Turn off incoming voice from player number <clientnum>. This will refuse to play any incoming audio from that player, and instruct the server to stop sending it, to save bandwidth. Use unignore to reenable. This is reset to unignored when (re)connecting to a server. || Yes
 +
|-
 +
| voip unignore <clientnum> || Turn on incoming voice from player number <clientnum>. This will start playing audio from this player again if you've previously done a "voip ignore", and instruct the server to start sending her voice packets to you again. || Yes
 +
|-
 +
| voip muteall || Turn off all incoming voice. This will refuse to play any incoming audio, and instruct the server to stop sending it, to save bandwidth. Use unmuteall to reenable. This is reset to unmuted when (re)connecting to a server. || Yes
 +
|-
 +
| voip unmuteall || Turn on incoming voice. This will start playing audio again if you've previously done a "voip muteall", and instruct the server to start sending voice packets to you again. || Yes
 +
|-
 +
| voip gain <clientnum> <gain> || Sets the volume ("gain") for player number <clientnum> to <gain> ... A gain of 0.0 is silence, and 2.0 doubles the volume. Use this if someone is too quiet or too loud. || Yes
 +
|}
  
 
== RCON Commands ==
 
== RCON Commands ==
 +
 +
== Sources ==
 +
*[http://web.archive.org/web/20080405091729/q3console.planetquake.gamespy.com/variables.htm Commander Keen's Quake3 Console Page]
 +
*[http://ioquake3.org/help/ ioquake3 Help]

Latest revision as of 00:38, 1 November 2009

Console Variables

Console Variables
Variable Type Default Value Description ioquake3 Only
cl_autoRecordDemo Boolean Record a new demo on each map change. Yes
cl_aviFrameRate Integer The framerate to use when capturing video. Yes
cl_aviMotionJpeg Boolean Use the mjpeg codec when capturing video. Yes
cl_platformSensitivity RO Float Indicates the mouse input scaling. Yes
com_altivec Boolean Enable the use of Altivec on PowerPC systems. Yes
com_hunkMegs Integer 20 set the amount of memory you want quake3.exe to reserve for game play dedicated server memory optimizations. Tips: com_hunkMegs 4 sv_maxclients 3 bot_enable 0 "John Carmack".
com_soundMegs Integer 8 com_soundmegs and com_zonemegs can be adjusted to provide better performance on systems with more than 64mb of memory. the default configuration is set to allow the game to run on a 64 MB system. on a 128 MB system we would run with the following:com_hunkMegs - 64 com_soundMegs - 16 com_zoneMegs - 24.
com_zoneMegs Integer 16 com_soundmegs and com_zonemegs can be adjusted to provide better performance on systems with more than 64mb of memory. the default configuration is set to allow the game to run on a 64 MB system. on a 128 MB system we would run with the following:com_hunkMegs - 64 com_soundMegs - 16 com_zoneMegs - 24.
fs_game String Set gamedir set the game folder/dir default is baseq3 (other for MODS).
in_disablemacosxmouseaccel Integer Disable mouse acceleration when running OS X with a mouse, defaults to 1. Yes
r_customheight Integer Custom resolution (Height).
r_customwidth Integer Custom resolution (Width).
r_fullscreen Integer 1 Toggle full screen or play in a window.
r_GLlibCoolDownMsec Integer Wait for a number of milliseconds to close GL library. Yes
r_mode Integer Set video display mode.
s_useOpenAL Boolean Use the OpenAL sound backend if it’s available. Yes
s_alPrecache Boolean Cache OpenAL sounds before use. Yes
s_alGain Float The value of AL_GAIN for each source. Yes
s_alSources Integer The total number of sources (memory) to allocate. Yes
s_alDopplerFactor Float The value passed to alDopplerFactor(). Yes
s_alDopplerSpeed Float The value passed to alDopplerVelocity(). Yes
s_alMinDistance Float The value of AL_REFERENCE_DISTANCE for each source. Yes
s_alRolloff Float The value of AL_ROLLOFF_FACTOR for each source. Yes
s_alMaxSpeakerDistance Float ET_SPEAKERS beyond this distance are culled. Yes
s_alDriver String Which OpenAL library to use. Yes
s_backend RO String Indicates the current sound backend. Yes
s_sdlBits Integer SDL bit resolution. Yes
s_sdlSpeed Integer SDL sample rate. Yes
s_sdlChannels Integer SDL number of channels. Yes
s_sdlDevSamps Integer SDL DMA buffer size override. Yes
s_sdlMixSamps Integer SDL mix buffer size override. Yes
sv_voip Boolean 1 set to "1" (the default) to enable server-side VoIP support. Set to "0" to disable. Without this, all VoIP packets are refused by the server, which means no one gets to use in-game VoIP. Yes
ttycon_ansicolor Boolean Enable the addition of ANSI escape codes for colors in the tty. Yes

Console Commands

Console Commands
Command Description ioquake3 Only
stopvideo Stop the video capture. Yes
video <filename> Start video capture (use with demo command). Outputs to filename. Yes
voip ignore <clientnum> Turn off incoming voice from player number <clientnum>. This will refuse to play any incoming audio from that player, and instruct the server to stop sending it, to save bandwidth. Use unignore to reenable. This is reset to unignored when (re)connecting to a server. Yes
voip unignore <clientnum> Turn on incoming voice from player number <clientnum>. This will start playing audio from this player again if you've previously done a "voip ignore", and instruct the server to start sending her voice packets to you again. Yes
voip muteall Turn off all incoming voice. This will refuse to play any incoming audio, and instruct the server to stop sending it, to save bandwidth. Use unmuteall to reenable. This is reset to unmuted when (re)connecting to a server. Yes
voip unmuteall Turn on incoming voice. This will start playing audio again if you've previously done a "voip muteall", and instruct the server to start sending voice packets to you again. Yes
voip gain <clientnum> <gain> Sets the volume ("gain") for player number <clientnum> to <gain> ... A gain of 0.0 is silence, and 2.0 doubles the volume. Use this if someone is too quiet or too loud. Yes

RCON Commands

Sources