QStat is a command-line program that displays information about Internet game servers. The servers are either down, non-responsive, or running a game. For servers running a game, the server name, map name, current number of players, and response time are displayed. Server rules and player information may also be displayed.
Games supported include Quake, QuakeWorld, Hexen II, Quake II, HexenWorld, Unreal, Half-Life, Sin, Shogo, Tribes, Tribes 2, Quake III: Arena, BFRIS, Kingpin, and Heretic II, Unreal Tournament, Soldier of Fortune, Rogue Spear, Redline, Turok II, Blood 2, Descent 3, Drakan, KISS, Nerf Arena Blast, Rally Master, Terminous, Wheel of Time, and Daikatana and many more. Note for Tribes 2: QStat only supports Tribes 2 builds numbered 22075 or higher. Note for Ghost Recon QStat only supports GhostRecon patch 1.2, 1.3, 1.4, Desert Siege, and Island Thunder.
Some games use query protocols compatible with an existing game. These servers can be queried using the flags for the compatible game. For instance, Turok2 should work using the -uns flag. Unreal Tournament is also supported by the -uns but is not really a different game. You can distinguish Unreal Tournament games with the "minnetver" server rule (standard Unreal servers have a "mingamever" server rule).
The Quake servers can be divided into two categories: POQS (Plain Old Quake Server) and QuakeWorld. Quake shareware, Quake commercial (from CD), winquake, winded, unixded, and Hexen II are all POQS. The various versions of QuakeWorld and Quake II use a QuakeWorld type server. The distinction is based on network protocol used to query the servers, and affects the kind of information available for display.
The different server types can be queried simultaneously. If QStat detects that this is being done, the output is keyed by the type of server being displayed. See DISPLAY OPTIONS.
The game server may be specified as an IP address or a hostname. Servers can be listed on the command-line or, with the use of the -f option, a text file.
One line will be displayed for each server queried. The first component of the line will be the server's address as given on the command-line or the file. This can be used as a key to match input addresses to server status. Server rules and player information are displayed under the server info, indented by one tab stop.
QStat supports three additional display modes: raw, templates, and XML. In raw mode, the server information is displayed using simple delimiters and no formatting. This mode is good for programs that parse and reformat QStat's output. The template mode uses text files to layout the server information within existing text. This is ideal for generating web pages. The XML mode outputs server information wrapped in simple XML tags. The raw mode is enabled using the -raw option, template output is enabled using -Ts, and XML output is enabled with -xml.
These options select which servers to query and what game type they are running. Servers are specified by IP address (for example: 199.2.18.4) or hostname. Servers can be listed on the command-line or in a file (see option -f.) The game type of a server can be specified with its address, or a default game type can be set for all addresses that don't have a game type.
The following table shows the command-line option and type strings for the supported game types. The type string is used with the -default option and in files with the -f option.
| Option | Type String | Default Port | Game Server |
|---|---|---|---|
| -qs | qs | 26000 | Quake |
| -h2s | h2s | 26900 | Hexen II |
| -qws | qws | 27500 | QuakeWorld |
| -hws | hws | 26950 | HexenWorld |
| -q2s | q2s | 27910 | Quake II |
| -uns | uns | 7777 | Unreal |
| -ut2s | ut2s | 7777 | Unreal Tournament 2003 |
| -ut2004m | ut2004m | 28902 | Unreal Tournament 2004 Master requires CD Key |
| -hls | hls | 27015 | Half-Life |
| -sns | sns | 22450 | Sin |
| -sgs | sgs | 27888 | Shogo: Mobile Armor Division |
| -tbs | tbs | 28001 | Starsiege: Tribes |
| -t2s | t2s | 28000 | Tribes 2 |
| -qwm | qwm | 27000 | QuakeWorld master |
| -hwm | hwm | 26900 | HexenWorld master |
| -q2m | q2m | 27900 | Quake II master |
| -hlm | hlm | 27010 | Half-Life master |
| -stm | stm | 27010 | Half-Life master (Steam) |
| -tbm | tbm | 28000 | Tribes master |
| -t2m | t2m | 28002 | Tribes 2 master |
| -q3s | q3s | 27960 | Quake III |
| -q3m | q3m | 27950 | Quake III master |
| -dm3s | dm3s | 27666 | Doom 3 |
| -dm3m | dm3m | 27650 | Doom 3 master |
| -bfs | bfs | 44001 | BFRIS |
| -kps | kps | 31510 | Kingpin |
| -hrs | hrs | 28910 | Heretic II |
| -sfs | sfs | 28910 | Soldier of Fortune |
| -gsm | gsm | 28900 | Gamespy master |
| -gps | gps | - | Game using "Gamespy style" protocol |
| -gps | gs2 | - | Game using "Gamespy2 style" protocol |
| -d3m | d3m | 3445 | Descent 3 PXO master |
| -d3p | d3p | 2092 | Descent 3, PXO server |
| -d3s | d3s | 2092 | Descent 3, LAN server |
| -d3g | d3g | 20142 | Descent 3, Gamespy protocol |
| -rws | rws | 27960 | Return to Castle Wolfestein |
| -rwm | rwm | 27950 | Return to Castle Wolfestein master |
| -efs | efs | 27960 | Star Trek: Elite Force |
| -efm | efm | 27953 | Star Trek: Elite Force master |
| -efs | efs | 29070 | Jedi Knight: Jedi Academy |
| -efm | efm | 29060 | Jedi Knight: Jedi Academy master |
| -grs | grs | 2346 | Ghost Recon |
| -etqws | etqws | 27733 | QuakeWars server |
The command-line options can be specified multiple times, one for each server to be queried.
For built-in game types, certain parameters can be modified. The parameters are limited to the master server protocol and master server query string.
New game types can be defined as a variation on an existing game type. Most new games use a Quake 3 or Gamespy/Unreal based network engine. These games can already be queried using -q3s or -gps, but they don't have game specific details such as the correct default port, the game name, and the correct "game" or "mod" server rule. And, mostly importantly, they don't get their own game type string (e.g. q3s, rws, t2s). All of these details can be specified in the QStat config file.
QStat comes with a default configuration file called 'qstat.cfg'. If this file is found in the directory where qstat is run, the file will be loaded. Configuration files can also be specified with the QSTAT_CONFIG environment variable and the -cfg command-line option. See Appendix B for a description of the configuration file format.
Each protocol reports different information. The Gamespy protocol provides player names, frags, deaths, and ping. The PXO and LAN protocols only provide player names.
The ideal solution would be a PXO server list paired with each server's gamespy query port. Most servers will use the default gamespy query port, unless there are multiple servers on the same machine. A possible approach is to get the server list from the PXO master like this:
qstat -d3m,outfile gt.pxo.net,d3pxo.txtThen convert the file from "d3p" to "d3g" and remove the port numbers:
sed -e 's/d3p/d3g/' -e 's/:.*$//' d3pxo.txt > d3gs.txtThen run the servers in d3gs.txt with -f:
qstat -f d3gs.txtThis technique will retrieve the full player info for servers using the default gamespy query port.
A broadcast query is specified by prefixing an address with a '+' (plus sign). The address should be 255.255.255.255 or a valid broadcast address for your local network. On Unixes, 'ifconfig -a' will display the broadcast address for all attached networks.
Server queries are customized by attaching query arguments to the server type option. Each argument is separated by a comma (','). The argument has a name followed by an optional value separated with an equal-sign ('='). The general format looks like this:
-server-option,query-arg[=arg-value][, ...]See the Master Server sections below for more examples.
| Query Argument | Description |
|---|---|
| showgameport | Always display the game port in QStat output. If the query port was different from the game port, then the query port will be saved in the "_queryport" server rule. This is the same as the -showgameport command-line option, but only applies to one server query. |
| gp | Short-hand for showgameport. |
| noportoffset | Do not apply the "status port offset" when sending the server query. Some games use different ports for game play and status queries (for example, Unreal, Medal of Honor, etc). QStat will normally add an offset to the game port to find the query port. But not all servers use the standard offset. This option allows QStat to query servers where the query port is known. The server address should be an IP address and a query port (not the game port). This is the same as the -noportoffset command-line option, but only applies to one server query. |
| qp | Short-hand for noportoffset. |
Some examples of the general query arguments.
qstat -uns,noportoffset 1.2.3.4:7787 ADDRESS PLAYERS MAP RESPONSE TIME NAME 1.2.3.4:7787 0/16 Kansas 119 / 0 Example serverThe default Unreal game port is 7777 and the query port is usually at offset 1 (port 7778). But this server has a different query port. Note that qstat displays the query port. To display the game port instead:
qstat -uns,noportoffset,showgameport 1.2.3.4:7787 ADDRESS PLAYERS MAP RESPONSE TIME NAME 1.2.3.4:7777 0/16 Kansas 119 / 0 Example serverAnother common usage for "showgameport" is with broadcast queries:
qstat -uns,showgameport +255.255.255.255
| Game | Master Servers |
|---|---|
| QuakeWorld | satan.idsoftware.com (ports 27000, 27002, 27003, 27004, 27006), 204.182.161.2, 194.217.251.40, 203.34.140.1, 200.245.221.200, 194.87.251.3 |
| Quake II | satan.idsoftware.com, q2master.planetquake.com |
| Half-Life (hlm) | half-life.west.won.net, half-life.east.won.net |
| Half-Life (stm) | steam1.steampowered.com:27010, steam2.steampowered.com:27010 |
| Tribes | tribes.dynamix.com |
| Quake III | master3.idsoftware.com |
| Doom 3 | idnet.ua-corp.com |
| Gamespy | master0.gamespy.com |
| Tribes 2 | 211.233.32.77:28002, 217.6.160.205:28002 |
| Descent 3 | gt.pxo.net |
| Return to Castle Wolfenstein | wolfmaster.idsoftware.com |
| Star Trek: Elite Force | master.stef1.ravensoft.com |
| UT2004 | ut2004master1.epicgames.com, ut2004master2.epicgames.com, ut2004master3.epicgames.com |
Server lists can be fetched from Gamespy masters by using the gsm game type. A query argument is required to use the Gamespy master. This extra argument indicates which server list to get from the master. The query argument can be one of the QStat supported game types or any other string that will fetch a server list. The following game types can be used as query arguments: qws, q2s, q3s, tbs, uns, sgs, hls, kps, hrs, sfs. For each of the game types, QStat will fetch the appropriate server list and get status from each server.
The query argument can also be any string that the Gamespy master responds to. Most of these games support a "standard" server status protocol that I'll call the "Gamespy status protocol". Not surprisingly, it is almost identical to the Unreal server status protocol. This means that QStat can support any game that supports this protocol. In QStat these games are queried using the gps game type. Through experimentation I've found the following query arguments.
| Query Argument | Game |
|---|---|
| roguespear | Rainbow Six: Rogue Spear |
| redline | Redline Racer |
| turok2 | Turok 2: Seeds of Evil |
| blood2 | Blood 2: The Chosen |
| drakan | Drakan: Order of the Flame |
| kiss | KISS Psycho Circus: The Nightmare Child |
| nerfarena | Nerf Arena Blast |
| rally | Rally Masters: Michelin Race Of Champions |
| terminous | Terminous (?) |
| wot | The Wheel of Time |
| daikatana | Daikatana |
t2m,query-arg=value, ...
| Query Argument | Values | Description |
|---|---|---|
| game | mod path | Mod path the server is using. The mod path of unaltered servers is "base". Use query=types to get the list of known game types. |
| mission | Bounty, Capture the Flag, CnH, Deathmatch, Hunters, Rabbit, Siege, TeamHunters | Mission type the server is currently running. Use query=types to get the list of known mission types. |
| minplayers | 0 - 255 | Servers with fewer players than this will not be returned. |
| maxplayers | 1 - 255 | Servers with more players than this will not be returned. |
| regions | list of regions or 0xhex-value | Limit servers to those in the given geographical regions. See Region List table. The regionlist is sent as a bit mask to the Tribes 2 master. If you know the bit mask for a region QStat doesn't support, you can specify the bitmask directly by supplying a hex value: regions=0x11. |
| build | build version # | Only return servers matching this build version number. [4/20/2001] This filter only seems to work if the build version # is 22337. If the filter is 22228, then the master returns 0 servers. This appears to be a bug in the T2 master. |
| status | list of dedicated, linux, nopassword or 0xhex-value | Limit servers to those with these status flags set. The list is
one or more status flags separated by colons (':'). To filter on
dedicated Linux servers, specify status=dedicated:linux If you know a status flag that QStat doesn't support, you can specify the status flags directly by supplying a hex value: status=0x3 |
| maxbots | 0 - 255 | Servers with more bots than this will not be returned. |
| mincpu | 0 - 65535 | Servers with lower CPU speed than this will not be returned. |
| query | types | Get the list of game and mission types. This is not a filter but a different master request. Using this query argument overrides any other query arguments. The list of game and mission types known to the master server will be displayed. In raw mode, the first line is the list of game types and the second line is the list of mission types. There is no output template support for game and mission lists. |
The Tribes 2 master query arguments can be used on the command-line or in a server list file (via the -f option). If the values contain spaces, be sure to quote the arguments for your shell. The second example below demonstrates this usage for most common shells. To query for Capture the Flag servers that have more than 6 players:Region List
The region list is one or more region arguments separated by colons (':'). For example, to filter on North American servers specify regions=naeast:nawest
Region Argument Geography naeast North America East nawest North America West sa South America aus Australia asia Asia eur Europe
qstat -t2m,mission=Capture the Flag,minplayers=6 master-server-ipIf you want to do this in a server list file, that would look like this:
qstat -t2m,mission="Capture the Flag",minplayers=6 master-server-ip
t2m,mission=Capture the Flag,minplayers=6 master-server-ipMaster server filters can be combined with the "outfile" option. Just put outfile some where in the query argument list and put the name of the output file after the master IP address:
t2m,outfile,mission=Siege,minplayers=4 master-server-ip,siegeservers.txtWarning: There is a bug in the 22075 build of Tribes 2 that doesn't return the game name. For those builds, QStat will use the game info in place of the game name. The bug is fixed in the 22228 build. In fixed servers, the game info can be found in the "info" server rule.
hlm,query-arg=value, ...
| Query Argument | Values | Description |
|---|---|---|
| game | mod path | Servers running this "mod". |
| map | map name | Servers running this map. |
| status | list of dedicated, linux, notempty, notfull | Limit servers to those matching this status. The list is one or more status flags separated by colons (':'). To filter on dedicated servers that are not empty, specify status=dedicated:notempty |
stm,query-arg=value, ...
| Query Argument | Values | Description |
|---|---|---|
| game | mod path | Servers running this "mod". |
| map | map name | Servers running this map. |
| region | name or number of region | Geographical Area of the server.
You can specify the name or number of the region:
|
| status | list of dedicated, linux, notempty, notfull, secure, proxy | Limit servers to those matching this status. The list is one or more status flags separated by colons (':'). To filter on dedicated servers that are not empty, specify status=dedicated:notempty |
dm3m,query-arg=value, ...
| Query Argument | Values | Description |
|---|---|---|
| status | colon separated list of password, nopassword, notfull, notfullnotempty | Limit servers to those matching this status. The list is one or more status flags separated by colons (':'). To filter on servers without password that are not full, specify status=nopassword:notfull |
| gametype | one of dm, tdm or tourney | limit servers to those mathing the specified gametype |
ut2004m,query-arg=value, ...
| Query Argument | Values | Description |
|---|---|---|
| cdkey | path to the UT2004 cdkey file | You MUST specify a valid CD key to be able to query the master server |
| status | colon separated list of password, nopassword, notfull, notempty, standard, nostandard, nobots, stats, nostats, weaponstay, noweaponstay, transloc, notransloc | Limit servers to those matching this status. The list is one or more status flags separated by colons (':'). To filter on standard servers without password that are not full, specify status=standard:nopassword:notfull |
| gametype | any UT2004 gametype, e.g. xMutantGame | limit servers to those mathing the specified gametype |
| mutator | colon separated list of Mutators. | limit servers to those running the specified mutators. Prepend a dash to include servers that do NOT run the specified mutator |
qstat -ut2004m,cdkey=/usr/local/games/ut2004/System/cdkey,status=nostandard ut2004master1.epicgames.com:28902
The QStat output should be self explanatory. However, the type of information returned is different between game types. If QStat queries multiple server types, then each server status line is prefixed with its type string. The GAME OPTIONS table lists the available type strings.
The 'l' (ell) sort key displays servers in the order they were provided to qstat. For example, the order in which they are listed on the command-line or in a file. The 'l' sort key cannot be combined with other server sort keys, but it can be be combined with player sort keys. If the 'l' sort key is used with other sort keys, then the 'l' sort key is ignored.
Example: If your firewall will allow outgoing UDP packets on ports 26000-30000, the qstat option would be -srcport 26000-30000
Note: The number of source ports given should be greater than or equal to the -maxsim (defaults to 20). The number of source ports will limit the number of simultaneous server queries.
The response time is a measure of the expected playability of the server. The first number is the server's average time in milli-seconds to respond to a request packet from QStat. The second number is the total number of retries required to fetch the displayed information. More retries will cause the average response time to be higher. The response time will be more accurate if more requests are made to the server. For POQS, a request is made for each server rule and line of player information. So setting the -P and -R options will result in a more accurate response time. Quake and Hexen II are POQS. For most other game servers, QStat makes just one request to retrieve all the server status information, including server rules and player status. The -P and -R options do not increase the number of requests to the server. Half-Life supports three different requests for information; general status, players, and server rules. Each requires a separate request packet, so a total of three are used to retrieve player and rules.
Quake supports a number of control codes for special effects in player names. QStat normalizes the codes into the ASCII character set before display. The graphic codes are not translated except the orange brackets (hex 90, 10, 91, and 11) which are converted to '[' and ']'. Use the hex-player-names option -hpn to see the complete player name.
POQS do not return version information. But some small amount of info can be gathered from the server rules. The noexit rule did not appear until version 1.01. The Quake II server rules include a "version" key that contains the id build number. Recent releases of QuakeWorld have a "*version" key in the server rules. Unreal servers include a "gamever" key in the server rules that contains the server version without the decimal point. Most other game servers include some kind of version info in the server rules.
The following is an example address file that queries a QuakeWorld master, several Hexen II servers, some POQS, and a few Quake II servers.
QWM 192.246.40.12:27004 H2S 207.120.210.4 H2S 204.145.225.124 H2S 207.224.190.21 H2S 165.166.140.154 H2S 203.25.60.3 QS 207.25.198.110 QS 206.154.207.104 QS 205.246.42.31 QS 128.164.136.171 Q2S sm.iquest.net Q2S 209.39.134.5 Q2S 209.39.134.3
If the above text were in a file called QSERVER.TXT,
then the servers could be queried by running:
qstat -f QSERVER.TXT
QStat sends packets to each host and waits for return packets. After some interval, another packet is sent to each host which has not yet responded. This is done several times before the host is considered non-responsive. QStat can wait for responses from up to 20 hosts at a time. For host lists longer than that, QStat checks more hosts as results are determined.
The following applies only applies to POQS. If QStat exceeds the maximum number of retries when fetching server information, it will give up and try to move on to the next information. This means that some rules or player info may occasionally not appear. Player info may also be missing if a player drops out between getting the general server info and requesting the player info. If QStat times out on one rule request, no further rules can be fetched. This is a side-effect of the Quake protocol design.
The number of available file descriptors limits the number of simultaneous servers that can be checked. QStat reuses file descriptors so it can never run out. The macro MAXFD in qstat.c determines how many file descriptors will be simultaneously opened. Raise or lower this value as needed. The default is 20 file descriptors.
Operating systems which translate ICMP Bad Port (ICMP_PORT_UNREACHABLE) into a ECONNREFUSED will display some hosts as DOWN. These hosts are up and connected to the network, but there is no program on the port. Solaris 2.5 and Irix 5.3 correctly support ICMP_PORT_UNREACHABLE, but Solaris 2.4 does not. See page 442 of "Unix Network Programming" by Richard Stevens for a description of this ICMP behavior.
Operating systems without correct ICMP behavior will just report hosts without Quake servers as non-responsive. Windows NT and Windows 95 don't seem to support this ICMP.
For hosts with multiple IP addresses, QStat will only send packets to the first address returned from the name service.
QStat supports Unreal version 2.15 or greater.
UNIX - QStat has been compiled and tested on Solaris 2.x, Irix 5.3/6.2/6.3/6.4, FreeBSD 2.2/3.0, BSDi, HP-UX 10.20/11.0, and various flavors of Linux.
WINDOWS - The Windows version of QStat (win32/qstat.exe) runs on Windows 95 and Windows NT as a console application. On Windows 95 and NT 4.0, short-cuts can be used to set the arguments to qstat. On Windows NT 3.51, use a batch file.
OS/2 - An OS/2 binary is no longer included. Try contacting Per Hammer for an OS/2 Warp binary. per@mindbend.demon.co.uk.
VMS - The source includes a VMS patch from John Ross Hunt. This patch was tested on QStat 2.0b, but has not been tested on the current version. See COMPILE.txt for instructions.
This is QStat version 2.10
The QStat webpage is updated for each new version and
contains links to Quake server listings and pages about
the Quake and Unreal network protocols. The page can be found at
http://www.qstat.org
Quake, Quake II, QuakeWorld, and Quake III created by id Software. Hexen II, HexenWorld, and Heretic II created by Raven Software. Unreal created by Epic Games. Half-Life created by Valve Software. Sin created by Ritual Entertainment. Shogo: Mobile Armor Division was created by Monolith Productions Inc. Tribes and Tribes 2 created by Dynamix, Inc. BFRIS created by Aegis Simulation Technologies. Kingpin created by Xatrix Entertainment Inc.
Steve Jankowski
steve@qstat.org
Copyright © 1996,1997,1998,1999,2000,2001,2002 by Steve Jankowski
QStat is covered by the terms of the Artistic License. The license terms can be found in LICENSE.txt of the QStat package.
QStat output templates provide greater control of the appearance of server status information. The results of a server query can be organized, formatted, and wrapped within any other text. The most obvious use is to generate HTML for web pages. However, it could also generate custom output for redisplay within another tool.
There are four output templates:
| Template | Option | |
|---|---|---|
| server | -Ts | Output once for each server queried. (required) |
| player | -Tp | Output once for each player. Must be used with -P. Invoked by the $PLAYERTEMPLATE variable. |
| rule | -Tr | Output once for each server rule. Invoked by the $RULETEMPLATE variable. |
| header | -Th | Output once before any servers are queried. |
| trailer | -Tt | Output once after all servers are output. |
The server template must be specified to enable template output. The other templates are optional.
Each output template is a file containing text and QStat variables. The text is output unchanged by QStat, but the variables are processed and replaced by QStat. Most variables are replaced by values from a queried server. Some variables have hardcoded values, and some generate no output, but affect how the template is processed.
Variables are grouped according to the templates where they can be used. General variables may be used in any of the templates. Server variables may be used in the server or player templates. Player variables may be used in the player template. Expression variables may only be used with the $IF and $IFNOT variables. If a variable is used where it doesn't make sense, it is ignored and generates no output.
Variables are specified using one of several syntaxes:
$VAR
$VAR:OPTION
$(VAR)
$(VAR:OPTION)
$(VAR:OPTION(ARGUMENT))
The syntax used does not affect the output. However using the $()
syntax is somewhat more readable when the text gets cluttered. If you
want the variable to be followed immediately by text, then the $()
syntax must be used.
| $QSTATURL | Output the web address of the QStat home page. | ||||||||||||||||||||||||||||
| $QSTATVERSION | Output the version of QStat being run. | ||||||||||||||||||||||||||||
| $QSTATAUTHOR | Output the name of the QStat programmer. | ||||||||||||||||||||||||||||
| $QSTATAUTHOREMAIL | Output the email address of the QStat programmer. | ||||||||||||||||||||||||||||
| $HTML | Enable HTML friendly string output. Server
results may
include characters that have special meaning in HTML. These are replaced
by equivalent SGML entities. QStat converts '<', '>',
and '&' to '<', '>', and
'&'. Use this variable once in the header template.
| $CLEARNEWLINES | Convert line feeds and carriage
returns into spaces. Applies to all variables that output strings.
Use this variable once in the header template.
| $RULENAMESPACES | Allow spaces in rule names.
Use this variable once in the header template.
| $IF | Conditional output. If the variable option is "true,"
the template is output up to a matching $ENDIF variable. If the variable
option is "false," the template is ignored until after a matching
$ENDIF. See Conditional Options for a list of supported conditional
options.
| $IFNOT | Conditional output. Same as $IF, but the opposite
sense.
| $ENDIF | End conditional output. There must be one $ENDIF for
each $IF and $IFNOT within a template.
| $NOW | Output the current local time.
| $TOTALSERVERS | The total number of servers to be queried.
| $TOTALUP | The number of servers up and running.
| $TOTALNOTUP | The number of servers either DOWN or TIMEOUT.
| $TOTALPLAYERS | The number of players found on all servers.
| $TOTALMAXPLAYERS | The sum of the maximum player values
for all servers.
| $TOTALUTILIZATION | The ratio of $TOTALPLAYERS to $TOTALMAXPLAYERS
expressed as a percentage (a number between 0 and 100). Reports how full
the servers are.
| $\ | Ignore the next newline.
Not really a variable, but a way to curtail the output of extra newlines.
Saves space in the output while the template remains readable. Must be
the last thing on the line.
| $DEFAULTTYPE | The full name of the default server type specified
with -default.
| |
| $HOSTNAME | Output the host name of the server if known, otherwise the server address as given to QStat. |
| $SERVERNAME | Output the name of the server. |
| $PING | The time in milli-seconds to get a response from the server. If the server is DOWN or TIMEOUT, nothing is output. |
| $PLAYERS | The number of players on the server. |
| $MAXPLAYERS | The maximum number of players allowed on the server. |
| $MAP | The name of the map being played. |
| $GAME | The name of the game being played. This is usually the name of the "mod" run by the server. |
| $GAMETYPE | The type of game being played. Only applies to Quake 3. Typical values are Free For All, Capture the Flag, and Arena. |
| $RETRIES | The number of retries needed to get the server status. This is a measure of packet loss. |
| $IPADDR | The IP address of the server. Does not include the port number. |
| $PORT | The port the server is running on. |
| $ARG | The server address as given to QStat. |
| $TYPE | Output one of the following depending on the server type:
Quake
Quake II
Quake II Master
QuakeWorld
QuakeWorld Master
Hexen II
HexenWorld
Unreal
Unreal Tournament 2003
Half-Life
Half-Life Master
Sin
Tribes
Tribes Master
Tribes 2
Tribes 2 Master
Shogo: Mobile Armor Division
Quake III: Arena
Quake III Master
BFRIS
Kingpin
Heretic II
Soldier of Fortune
Gamespy Master
Gamespy Protocol
If the server type is not known, nothing is output.
|
| $TYPESTRING | The server's type string (see GAME OPTIONS table.) |
| $TYPEPREFIX | The server's type prefix (same as $TYPESTRING but in all-caps.) |
| $RULE:name | The value of a server rule. If the rule is not returned by the server, nothing is output. Must be used with the -R flag. Server rule names can include any alpha-numeric character plus '*', '_', '.', or ' ' (space). The use of space in a rule name will require use of the parenthesized format: $(RULE:name) |
| $ALLRULES | Output all the server rules in the format name=value separated by commas. Must be used with the -R flag. |
| $PLAYERTEMPLATE | Invoke the player template. The player template is output once for each player on the server. Must be used with the -P flag. |
| $RULETEMPLATE | Invoke the rule template. The rule template is output once for each server rule. |
| $PLAYERNAME | The name of the player. If -htmlnames or $HTML is used, then HTML color font tags will be added for Quake 3 and Tribes 2 player names. If $HTML is used but -nohtmlnames is set, then player names will not be colorized. |
| $HTMLPLAYERNAME | The name of the player with HTML color font tags. Only Quake 3 and Tribes 2 are supported. |
| $FRAGS | The number of frags scored. |
| $DEATHS | Descent 3 - The number of times player has died. Ghost Recon - Indicates if the player is dead. Only available for Descent 3 or Ghost Recon. |
| $PLAYERPING | The player's ping time to the server. This value is not available from Half-Life or Ghost Recon servers. |
| $CONNECTTIME | How long the player has been playing. This value is only available from Quake, QuakeWorld, Hexen II, and Half-Life servers. |
| $SKIN | The name of the player's skin texture. This value is not available from ?? and Ghost Recon servers. |
| $MESH | The name of the player's mesh (model). This value is only available from Unreal servers. |
| $FACE | The name of the player's face texture. This value is only available from Unreal version 405+ servers. |
| $SHIRTCOLOR | Color of the player's shirt. This value is only available from Quake, QuakeWorld, and Hexen II servers. |
| $PANTSCOLOR | Color of the player's pants. This value is not available from Quake, QuakeWorld, and Hexen II servers. |
| $PLAYERIP | The IP address of the player's computer. This value is only available from Quake and Hexen II servers. |
| $TEAMNUM | The player's team number. This value is only available from Unreal, Tribes, Tribes 2 and Ghost Recon servers. |
| $TEAMNAME | The player's team name. This value is only available from Tribes and Tribes 2 servers. |
| $TRIBETAG | The player's tribe tag. This value is only available from Tribes 2 servers. |
| $PLAYERSTATID | The player's global statistics id. This value is only available from Unreal Tournament 2003 servers. |
| $PACKETLOSS | The player's packet loss. This value is only available from Tribes servers. |
| $COLORNUMBERS | Display $SHIRTCOLOR and $PANTSCOLOR as numbers. Equivalent to -ncn command-line option. No output. |
| $COLORNAMES | Display $SHIRTCOLOR and $PANTSCOLOR using color names. Equivalent to -cn command-line option. No output. |
| $COLORRGB | Display $SHIRTCOLOR and $PANTSCOLOR using #rrggbb format. Equivalent to -hc command-line option. No output. |
| $TIMESECONDS | Display $CONNECTTIME as number of seconds. Equivalent to -ts command-line option. No output. |
| $TIMECLOCK | Display $CONNECTTIME in clock format (DhDDmDDs). Equivalent to -tc command-line option. No output. |
| $TIMESTOPWATCH | Display $CONNECTTIME in stop-watch format (DD:DD:DD). Equivalent to -tsw command-line option. No output. |
| $RULENAME | The server rule name. |
| $RULEVALUE | The server rule value. |
These options maybe used with the $IF and $IFNOT variables. For example, to display player information, the following could be used in the server template:
$(IF:PLAYERS)$(IF:FLAG(-P))
The server has $(PLAYERS) players:
$(PLAYERTEMPLATE)
$(ENDIF)$(ENDIF)
The template between the $IF and $ENDIF variables will only be
displayed if the server has one or more players and the -P
flag was given to QStat.
| GAME | True if the server is running a "mod." | ||||||||||||
| PLAYERS | True if the server has one or more players. | ||||||||||||
| QUAKE | True if the server is running Quake (the original). | ||||||||||||
| QUAKE2 | True if the server is running Quake II. | ||||||||||||
| Q2MASTER | True if the server is a Quake II master. | ||||||||||||
| QUAKEWORLD | True if the server is running QuakeWorld. | ||||||||||||
| QWMASTER | True if the server is a QuakeWorld master. | ||||||||||||
| HEXEN2 | True if the server is running Hexen II. | ||||||||||||
| HEXENWORLD | True if the server is running HexenWorld. | ||||||||||||
| UNREAL | True if the server is running Unreal. | ||||||||||||
| UNREALTOURNAMENT2003 | True if the server is running Unreal Tournament 2003. | ||||||||||||
| HALFLIFE | True if the server is running Half-Life. | ||||||||||||
| HLMASTER | True if the server is a Half-Life master. | ||||||||||||
| SIN | True if the server is running Sin. | ||||||||||||
| TRIBES | True if the server is running Tribes. | ||||||||||||
| TRIBESMASTER | True if the server is a Tribes master. | ||||||||||||
| TRIBES2 | True if the server is running Tribes 2. | ||||||||||||
| TRIBES2MASTER | True if the server is a Tribes 2 master. | ||||||||||||
| SHOGO | True if the server is running Shogo. | ||||||||||||
| QUAKE3 | True if the server is running Quake III. | ||||||||||||
| Q3MASTER | True if the server is a Quake III master. | ||||||||||||
| BFRIS | True if the server is running BFRIS. | ||||||||||||
| KINGPIN | True if the server is running Kingpin. | ||||||||||||
| HERETIC2 | True if the server is running Heretic II. | ||||||||||||
| SOLDIEROFFORTUNE | True if the server is running Soldier of Fortune. | ||||||||||||
| DESCENT3 | True if the server is running Descent 3. | ||||||||||||
| GAMESPYMASTER | True if the server is a Gamespy Master. | ||||||||||||
| GAMESPYPROTOCOL | True if the server is running a "Gamespy style" status protocol. | ||||||||||||
| RULE(name) | True if the rule name is set on the server. Server rule names can include any alpha-numeric character plus '*', '_', or '.'. If $RULENAMESPACES is enabled, then rule names may contain a ' ' (space). | ||||||||||||
| FLAG(name) | True if the flag name was used on the QStat command-line. The only flag names supported are: -H, -P, and -R. Any other flag name returns false. | ||||||||||||
| UP | True if the server is up and running. | ||||||||||||
| DOWN | True if the server is known to be not running. This is true if the server computer returns an ICMP indicating that nothing is running on the port. Only supported by some operating systems. | ||||||||||||
| TIMEOUT | True if the server never responded to a status query. | ||||||||||||
| HOSTNOTFOUND | True if the host name lookup failed. | ||||||||||||
| ISEMPTY | True if the server has no players. | ||||||||||||
| ISMASTER | True if this is a master server. | ||||||||||||
| ISFULL | True if the server has the maximum players. | ||||||||||||
| ISTEAM | True if the player is a team. Only available
with Tribes and Tribes 2 servers. Only applies to the player template.
| ISBOT | True if the player is a bot. Only available
with Tribes 2 servers. Only applies to the player template.
| ISALIAS | True if the player is using an alias.
Only available with Tribes 2 servers. Only applies to the player template.
| TRIBETAG | True if the player has a tribe tag.
Only available with Tribes 2 servers. Only applies to the player template.
| RULENAME | True if the rule name matches the
variable argument. For example $(IF:RULENAME(version)) will be true
when the rule template is outputing a "version" server rule.
Only applies to the rule template.
| RULEVALUE | True if the rule value matches the
variable argument. For example $(IF:RULEVALUE(1)) will be true
when the rule template is outputing a server rule whose value is "1".
Only applies to the rule template.
| DEATHS | True if the player has recorded DEATHS in Descent 3 or if the
player is dead in Ghost Recon. NOTE if the Ghost Recon player
has spawns available they can go from dead to alive.
| |
Please refer to the default configuration file for examples. The default configuration file qstat.cfg can be found in the QStat package.
Unix Note: The sysconfdir is determined when qstat is compiled. For Unix compiles, the QStat makefiles default to /etc. To compile with a different sysconfdir, set SYSCONFDIR when compiling with gmake. For example, to set sysconfdir to /usr/local/etc
Windows Note: The location-of-qstat.exe is the directory where the QStat executable (qstat.exe) is located. Just put the default qstat.cfg in the same directory as qstat.exe.
The text in bold are keywords that must be used as shown.
gametype type-string (modify | new extend type-string) parameter-name = parameter-value ... end
Parameter names are one or more words separated by spaces. The supported parameters and their meaning are listed in Gametype Parameters. Extra white space before, after and within a parameter name is ignored. An equal sign ('=') must separate the parameter name and the parameter value. There can be one parameter setting per line.
Parameter values are one more characters or escape sequences. Leading and trailing spaces are ignored. All characters are used as-is except for backslash ('\') which begins an escape sequence.
\\ A single backslash ('\') \n A newline (ASCII char 10) \r A carriage return (ASCII char 13) \(space) A space (ASCII char 32). This escape should be entered as two characters: backslash followed by one space. \xHH A single character represented by the two-digit hexadecimal code. The hex digits H must be 0-9, A-F, or a-f. \DDD A single character represented by the three-digit octal code. The octal digits D must be 0-7.
The new-type-string must not be a built-in type string. If a new gametype is defined multiple times in configuration files, only the last definition is used. The existing-type-string can be any built-in or configuration defined game type. However, QStat has the best support for extending Q3S, Q2S, GPS, UNS, and Q3M game types.
gametype new-type-string new extend existing-type-string parameter-name = parameter-value ... end
The new game type has command-line option, type string and type prefix derived from new-type-string. The case of new-type-string is ignored. The command-line option and type string are always lower-case and the type prefix is always upper case.
The new game type starts with the same parameters as the existing-type-string except for the type string itself. Game type parameters are set by the following parameter setting lines. Some parameters may only be used with master server and some only with game servers.
We suggest that new-type-strings be as short as possible and end with an 's' for game servers and an 'm' for master servers. New game types should, but are not required to, set the name, default port, and template var parameters. The template var should be all upper-case and should not contain any spaces.
The existing-type-string can be a built-in game type or a configuration defined game type.
gametype existing-type-string modify parameter-name = parameter-value ... end
Only certain parameters can be modified: master protocol, master query, and master packet.
A request packet can only be set if the extended game type uses the same type of request packet. If a game type only uses the status packet, then an extending game type can only set the status packet.
Request packet typically contain binary characters (those beyond the printable ASCII character set). These can be specified using the hex and octal character escapes.
If the master packet parameter is set, the master protocol and master query parameters will be ignored.
| name | Sets the name of the game type. Should be the full game name as used by the publisher. |
| flags | set the query flags. Bitwise OR of the following constants:
|
| default port | Default network port used by the status protocol. |
| status port offset | Offset of the status/query port from the game port. |
| game rule | The server rule containing the name of the game style or game mod. |
| template var | The template variable used to test whether a server is of this game type. |
| status packet | The status request packet. This is the first packet sent to a server of this game type. |
| status2 packet | The second status request packet. If the server responded to the first status packet, then this packet is sent, but only if player or rule info is needed (command-line options -P or -R). |
| player packet | The player request packet. Requests player information. |
| rule packet | The rule request packet. Requests server rule information. |
| master for gametype | Sets the type of game returned by this master. The value must be a built-in or configuration defined game type. |
| master protocol | The protocol number to use in the master request.
The master server will respond with servers that match the protocol number.
The numbers change with each version of the game that uses an incompatible
network protocol. The master protocol is used mainly with Quake 3 based
games.
The master request packet will combine the master protocol and master query values. |
| master query | The query string to use in the master request.
The master query string provides additional filtering for the master
server.
The default master request packet will combine the master protocol and master query values. |
| master packet | The master request packet. Requests a server list from the master server. If master packet is set, master protocol and master query are ignored. |