tyr−quake, tyr−glquake, tyr−qwcl, tyr−glqwcl, tyr−qwsv − Client and server programs for the computer game Quake
[−OPTION [arg]]... [+COMMAND
tyr−glquake [−OPTION [arg]]... [+COMMAND [arg]]...
tyr−qwcl [−OPTION [arg]]... [+COMMAND [arg]]...
tyr−glqwcl [−OPTION [arg]]... [+COMMAND [arg]]...
tyr−qwsv [−OPTION [arg]]... [+COMMAND [arg]]...
TyrQuake is a port of id Software’s Quake engine which attempts to maintain the original look and feel of the game while also providing support for modern platforms and user created content.
Currently TyrQuake is implemented as five separate programs; two NetQuake clients (tyr−quake and tyr−glquake), two Quakeworld clients (tyr−qwcl and tyr−glqwcl) and a Quakeworld server (tyr−qwsv). The ’gl’ notation indicates the OpenGL accelerated clients and the non-gl versions use a software-only renderer.
−heapsize n, −mem n
Specifies the size of Quake’s internal memory heap. For historical reasons, when using −heapsize n is specified in kB and when using -mem n is specified in MB. Default 256MB.
Specifies the amount of memory in kB to reserve for Quake’s dynamic memory allocator. Default 256kB.
Allocate only a minimal sized heap for Quake. If playing standard quake (−game id1) this is ~5.5MB, otherwise ~15.5MB. Probably only useful for testing purposes.
Specify the base directory where the Quake data is located. The default is OS and distribution dependent.
Specify a game directory under basedir to search for game data. Default is id1. If this option is specified, then the given directory will be searched first, followed by id1.
Set up game directories and customised HUD for use with the Rogue expansion pack "Dissolution of Eternity".
Set up game directories and customised HUD for use with the Hipnotic expansion pack "Scourge of Armagon".
Start the game in windowed mode.
−width n, −height n
Specify the width and/or height of the game window in pixels.
−bpp n (tyr-glquake,tyr-glqwcl Windows only)
Request an OpenGL context with the specified bits-per-pixel.
Disable use of OpenGL Multitexture extenstions.
Disable use of OpenGL non-power-of-two textures. Textures will be stretched or padded to power-of two sizes as needed.
Disable the use of compressed textures. There is a slight quality hit when compressed textures are enable, so use this parameter if higher quality at the expense of more memory usage is preferred.
Set the video gamma value. Default 1.0.
−fullsbar (tyr-glquake,tyr-glqwcl Windows only)
Work around for buggy use of double/triple buffers and glClear. Force the renderer to redraw the full status bar every frame.
−noautostrectch (tyr-quake,tyr-qwcl Windows only)
By default Quake will try to adjust up the default video mode and select a resolution appropriate for your monitor resolution. Use this command line switch to prevent this behaviour.
−resetwinpos (tyr-quake,tyr-qwcl Windows only)
By default Quake will try to remember the previous window position and place the window in the same position. Specify this command line option to reset the window position to the top left corner of the screen.
Disable mouse input.
−nodinput (Windows only)
Disable direct input.
−noforcemspd (Windows only)
Don’t reset the mouse speed while the game is active.
−moforcemaccel (Windows only)
Don’t disable mouse acceleration while the game is active.
−noforcemparms (Windows only)
Don’t change mouse parameters at all while the game is active.
−nojoy (Windows only)
Disable joystick input.
−cddev dev (Linux/BSD only)
Set the cd device filname to dev. Default /dev/cdrom.
Disable CD audio.
Disable the use of music files in place of CD audio tracks.
Disable sound support.
Disable sound output, but still perform all mixing. For testing purposes only.
−sndbits n (Linux, OSS/SDL/PulseAudio)
Specify number of bits per sample for sound output format, 8 or 16. Default 8.
−sndspeed n (Linux, OSS/SDL/PulseAudio)
Specify sample speed for sound output. Default 11025.
−sndmono (Linux, BSD only)
Request only a single channel for sound output.
−sndstereo (Linux, BSD only)
Request stereo sound output channels (Default).
−snoforceformat (Windows only)
Do not try to set the sound format of the primary sound buffer (Direct Sound).
−primarysound (Windows only)
Mix directly into the primary sound buffer. By default, Quake will set up and use a secondary sound buffer.
−wavonly (Windows only)
Do not initialize direct sound, use the Windows media API only.
Explicitly set the size of the surface cache (in kB) used by the software renderer. By default Quake will automatically calculate a suitable size for the screen resolution selected.
Set the maximum number of particles supported by the renderer. It can be useful to increase this if debugging a leak in a map where the pointfile is very large. Default 2048.
−cheats (tyr-qwsv only)
Enable clients to send cheat commands.
Sets the developer console variable to 1. Useful for getting developer debug messages early in the init process, before config.cfg and autoexec.cfg have been executed.
Causes Quake to append all console messages to a file qconsole.log in the current game directory. By default the log is not written.
−noconinput (Linux, BSD only)
Disables console input from stdin.
Disables console output on stdout.
−dedicated [n] (tyr-quake, tyr-glquake only)
Start the engine in dedicated server mode (server only, no client) supporting up to n clients (n must be between 1 and 16). If −dedicated is the last command line argument, then the server will default to supporting 8 clients.
−listen [n] (tyr-quake, tyr-glquake only)
Start the engine in listen mode (both client and server) supporting up to n clients (n must be between 1 and 16). If −listen is not specified, then the server will support up to 4 clients. If −listen is specified as the last command line argument, then the server will default to supporting 8 clients.
−nolan (tyr-quake, tyr-glquake only)
Disable LAN support.
Set the UDP port that the LAN server will listen on.
−udpport (tyr-quake, tyr-glquake only)
Same as −port.
Specify an IP address to restrict Quake to use only that address. Note that with this enabled, if you start a server it will not be discoverable via broadcast messages. Players will have to connect directly. By default we bind to any/all interfaces so that any connected network may be used.
Specify an IP address to advertise as your visible IP for network play. Use if you need to advertise a different IP address than the one locally detected, e.g. if you are behind NAT or similar.
−noudp (tyr-quake, tyr-glquake only)
Disables UDP networking. Essentially the same effect as −nolan.
−HFILE n, −HPARENT n, −HCHILD n (tyr-quake, tyr-glquake, Windows only)
Originally intended for QHost, which as I understand provides a function similar to screen/tmux on unix for the Quake console. You probably don’t want to use this (and it probably doesn’t even work anymore!)
cd [command] [arguments]
Passes commands to the CD audio subsystem. Sub-commands are listed below.
Enable the CD audio subsystem.
Disable the CD audio subsystem.
Play CD audio track n.
Play CD audio track n in a loop.
Stop playing CD audio.
Pause CD audio playback.
Resume playing CD audio (if currently paused).
Eject the CD media.
Request the CD tray to close.
remap x y
Given two track numbers x and y, remap a CD track number such that a request to play track x will result in real track y being played. Remappings can be reset with the cd reset command.
Stop playing audio, remove any CD track remappings and re-read the CD table of contents.
Displays number of tracks on the currently loaded CD, which track is currently playing or paused (if any) and the current CD audio volume.
Start playing the given music file. If the file extension is not specified, then the supported file extensions will be tried in sequence (ogg, mp3, flac, wav).
Stop the currently playing music file.
Pause the currently playing music file.
Resume playing the currently paused music file.
Prints the list of currently loaded textures (GLQuake/GLQWCL)
Prints the available OpenGL extensions (GLQuake/GLQWCL)
Prints the active hud scaling factor, relative the the current resolution. If given a parameter, sets this as the new scaling factor. See also scr_hudscale under CONSOLE VARIABLES.
fog (glquake, glqwcl only)
Sets fog parameters on the
current map. The command takes one, three or four arguments
between 0 and 1. The command can set the desity of the fog
from 0 (no fog) to 1 (completely opaque fog) as well as the
color of the fog, expressed as fractions of red, green and
fog (red) (green) (blue)
fog (density) (red) (green) (blue)
Load the named skybox for the current level.
Prints the number of video modes provided by the window/operating system.
Prints out the list of video modes available on the window/operating system. Each mode is assigned a number which can be passed to the vid_mode command to set the mode directly.
With no parameters, prints the current video mode as an integer or just ’windowed’ if in windowed mode. If given an integer argument for a valid video mode as described by the vid_describemodes command, then sets the video mode to one of the described fullscreen modes.
Prints a brief description of the current video mode.
Restarts the entire video system. Used to change the window or screen resolution according to the vid_width, vid_height, vid_bpp, vid_fullscreen, vid_refreshrate and vid_vsync console variables.
Print information about internal memory allocations on the hunk. If the argument print is given, sequential allocations with the same hunk tag are totaled into one line. If the printall argument is given, details for every individual allocation are printed.
Print information about memory allocations in the zone allocator. If the argument print is given, only summary statistics are printed. If the printall argument is given, information about every memory block in the zone is printed.
When the mlook key is depressed, mouse movement controls the view orientation instead of direction of movement. If cvar "m_freelook" is 1, then the reverse is true, with mouse look enabled by default and the mlook key activates mouse movement instead.
game <directory> [-hipnotic|-rogue|-quoth]
End the current game and load the specified game (mod) directory. Optionally specify one of -hipnotic, -rogue, -quoth to enable the game specific HUD changes for these mods.
Add an IP filter to drop packets from the specified IP address or network. IP addresses are specified in the standard form A.B.C.D. A network can be specified using a netmask length, e.g. addip 10.10.10.0/24 or by giving only the first one, two or three octets; e.g. addip 10.10.10.
Remove an IP address or network from the IP filter list. Note that if an IP address is filtered as part of a network filter, you can only un-filter the IP by removing the network filter.
Show the current IP filter list.
Writes commands to re-construct the current IP filter list to the file listip.cfg which can later be restored with ’exec listip.cfg’.
Set volume level for background music. Valid values are between 0.0 (off) and 1.0 (full volume). Default 1.0.
If set to 1, then external music files will be used in place of CD audio if available. Files should be placed in a ’music’ directory, within the game directory (e.g. id1/music). CD tracks should be named track02.<ext>, track03.<ext>, etc. where ’<ext>’ is one of the supported file extensions (ogg, mp3, flac, wav). E.g. id1/music/track02.flac. Music files may also be placed inside pack files using the same relative paths. Default 1.
If set to 1 then external music files will loop. If set to 0, music files play once and then stop. Default 1.
The maximum number of textures that will be kept in memory at one time. If changed at runtime, a vid_restart is required for the change to take effect. Default 2048.
If 1, allow use of non-power-of-two sized textures in OpenGL (if the ARB extension is advertised). Set to zero to force stretching/padding of textures to power-of-two sizes. Default 1.
Set the degree of anisotropic filtering applied to textures. Higher numbers will give sharper detail to surfaces that are at sharper angles to the screen at the cost of some performance. 1 is the lower bound, which is effectively disabled. Drivers/hardware determine the upper limit. Default 1.0f.
If 1, smooth out animation of alias models by interpolating between animation frames. If enabling this setting, it is recommended to enable r_lerpmove as well. Default 0.
If 1, interpolate movement of alias model entities. Default 0.
r_wateralpha, r_slimealpha, r_lavaalpha, r_telealpha
Set to a fraction between 0 (fully transparent) and 1 (fully opaque) to control the transparency of water/slime/lava/teleport surfaces. Default 1.
Controls the speed at which the water surface warping effect displays. Higher values are faster, lower values are slower. Default 4.
Controls the amount of warping taking place. Higher values warp more and lower values less. Default 2.
Controls the amount of movement in the warping surface. Higher values move the surface more, lower values less. Default 8.
Scale the size of particles on the screen. Values greater than one increase the size and values less than one decrease the size. Default 1.
Add a flat level of fog to the sky between 0 (no fog) and 1 (fully obscured by fog). Default 0.
Set the transparency level of the sky foreground image for scrolling skies. Set between 0 (fully transparent) and 1 (fully opaque). Default 1.
r_sky_quality (tyr-glquake, tyr-glqwcl)
Sets the level of tesselation used to simulate the curved scrolling sky. Lower numbers may improve performance, while higher numbers may improve quality. Default 16.
Set to 1 to prevent drawing skybox or scrolling skies and instead just draw a flat color where the sky should be. May be helpful on very low performance systems. Default 0.
If 1, implements a workaround for z-fighting where world and brush models co-incide (e.g. the elevator to the E1M1 quad secret). Causes some undesirable side effects such as cracks or ridges where brush models and the world would otherwise meet flush. Default 0.
If 1, print some information about OpenGL memory usage each frame. Default 0.
If 1, write an unbindall command before saving key bindings to config.cfg, so that any explicitly unbound keys are no longer restored to their defaults after reloading the engine. Default 1.
Controls drawing the player’s weapon model in the view. When 1, the weapon is drawn. When zero, no weapon is drawn. If a fractional value less than one is set, the weapon will be drawn translucent. Default 1.
This is mostly a legacy setting that was used to allow the software render to render more complex scenes. Now the engine will automatically adjust the resources as needed if it encounters more complex scenes. However, these settings remain available if you wish to preempt the auto-adjustment and allow for more complex scenes right away to avoid the frame or two of latency as the engine automatically adjusts. In effect, these are now minimum settings as the engine will adjust upwards automatically as-needed. Defaults 768/2304.
Scale the console text and status bar by some factor. When set to 1, the console text and status bar pics are drawn at their pixel size. This can be very small when using a high resolution video mode. Setting to 2 will make the text twice as big, etc. Fractional values > 1 are allowed. If set to zero, the engine will try to pick a reasonable size based on the video mode. Can be queried/set via the hudscale command. Default 0.
Set to a value between 0 (fully transparent) and 1 (fully opaque) to draw the status bar semi-transparently. Default 0.75.
Sets the volume of sound effects between 0 (off) and 1 (full volume). Default 0.7.
When enabled, entity sounds that are cut off by another sound starting will fade out very quickly and smoothly instead of cutting off suddenly, as long as a sound channel is available to do so. This avoids some audio artifacts that can otherwise be heard if the cut off is instantaneous. Default 1.
Set to an integer value between 1 and 5 to control the quality of the sound filter used when resampling audio. 1 is the fastest but lowest quality and 5 is the highest quality, but slowest. Set to 0 to completely disable audio filtering. Default 3.
Specifies how far ahead (in seconds) to mix sound effects. Lower values provide better audio latency, while higher values help prevent audio skipping when framerate drops. Default 0.1.
If set to 1, switch to fullscreen mode on the next vid_restart. Default 0.
Specifies the width and height in pixels of the window or fullscreen mode to set on the next vid_restart. Default 800 x 600.
Specifies the color depth of the display mode to be set on the next vid_restart. Valid values depend on the system, but typically 32, 16 or 8. Default 32.
Specifies the refresh rate of the display mode to be set on the next vid_restart. Ignored for windowed modes. Valid values depend on the system. Default 60.
When 0, rendering occurs as fast as possible with no synchronization to vertical refresh. When ’1’, synchronize display of frames with vertical refresh to avoid tearing. When ’2’, use ’adaptive vsync’ - wait for vertical refresh to display the frame if the rendering completed ahead of the vertical refresh. If rendering was slower than the vertical refresh, display immediately. Not all modes are supported on all systems. Default ’1’.
Optionally scales up the pixel size rendered by the software renderer to improve performance or for aesthetic preference. When 1 (default), renders each pixel of the window individually. When 2 the rendered pixel size is 2x2 so only 1/4 of the work is required by the 3d renderer. For example with an 800x600 window and scale set to 2, the render will draw the scene at 400x300 and scale up the pixels by 2 to fill the window. When set to 0, the render resolution is specified by the vid_render_resolution_width and vid_render_resolution_height variables manually. Default 1.
When vid_render_resolution_scale is 0, sets the width and height of the resolution to render the scene at which will then be stretched up to the window or screen size. Default 320 x 200.
When 1, place the window centered on the screen. When 0, either use the previously remembered position if vid_window_remember_position is 1, otherwise allow the window manager to place the window. Default 1.
When 1, record the placement of the game window in the vid_window_x and vid_window_y console variables so the position can be restored next time the game starts or restarts. Note that if vid_window_centered is 1, then the window will be centered and the remembered position will be ignored. Default 1.
Records the window position of the application at the time it was last closed.
If 1, view orientation is controlled by mouse and the mouse look key (+mlook) has the inverse effect of temporarily disabling free look mode while depressed.
(for debugging purposes only) If 1, draw some debugging information above each model (GLQuake only for now). Default 0.
2013-2021 Kevin Shanahan
Copyright (C) 1997 id Software
GNU GPL version 2 or later
This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law.