1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715
|
NAME
qstat - Get statistics from on-line game servers
SYNOPSIS
qstat [options ...] [-f file] [-server-option host[:port]]
[-raw delimiter] [-default server-type] host[:port] ...
Version 2.3g
DESCRIPTION
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, Quake III: Arena,
BFRIS, Kingpin, and Heretic II.
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.
DISPLAY MODES
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 two additional display modes: raw and templates. 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 raw mode is enabled using the -raw option and template
output is enabled using -Ts.
GAME OPTIONS
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 Default Port Game Server
String
-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
-hls hls 27015 Half-Life
-sns sns 22450 Sin
-sgs sgs 27888 Shogo: Mobile Armor Division
-tbs tbs 28001 Starsiege: Tribes
-qwm qwm 27000 QuakeWorld master
-q2m q2m 27900 Quake II master
-hlm hlm 27010 Half-Life master
-tbm tbm 28000 Tribes master
-q3s q3s 27960 Quake III
-q3m q3m 27950 Quake III master
-bfs bfs 44001 BFRIS
-kps kps 31510 Kingpin
-hrs hrs 28910 Heretic II
-sfs sfs 28910 Soldier of Fortune
The command-line options can be specified multiple times, one for each
server to be queried.
Master Servers
Master server addresses don't change very often, but some times they go
off-line. The following is a list of some of the master servers I know
about.
o 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
o Quake II - satan.idsoftware.com, q2master.planetquake.com,
www.telefragged.com
o Half-Life - half-life.west.won.net (128.11.20.143),
half-life.east.won.net
o Tribes - tribes.dynamix.com
o Quake III - master3.idsoftware.com (192.246.40.56),
q3master.splatterworld.de [German]
Broadcast Queries
QStat has limited support for broadcast queries. Broadcast queries use
one network packet to find all the game servers on a local network. A
broadcast returns servers of one type on one port. You may only
broadcast to networks to which you computer is directly attached (ie.
local networks). In this release, broadcast queries are only supported
for: Quake II servers.
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 a local network. On Unixes, 'ifconfig -a' will display the
broadcast address for all attached networks.
Option Usage
-server-option host[:port]
Query game server host for status. The GAME OPTIONS table lists
the available server-options and their default port.
-master-server-option host[:port]
Query a game master for its server list and then query all the
servers. The GAME OPTIONS table lists the available
master-server-options and their default port.
-master-server-option,outfile host[:port],file
Query a game master for its server list and store it in file. If
the master cannot be contacted, then file is not changed. If file
is - (a single dash), then stdout is used. The GAME OPTIONS table
lists the available master-server-options and their default port.
-f file
Read host addresses from the given file. If file is -, then read
from stdin. Multiple -f options may be used. The file should
contain host names or IP addresses separated by white-space (tabs,
new-lines, spaces, etc). If an address is preceded by a server
type string, then QStat queries the address according to the
server type. Otherwise QS is assumed, unless -default is used. The
GAME OPTIONS table lists the available server type strings and
their default port.
-default type-string
Set the default server type for addresses where the type is not
obvious. This affects the addresses at the end of the qstat
command-line and those in a file not prefixed by a server type
(see -f). The GAME OPTIONS table lists the available server type
strings and their default port.
INFO OPTIONS
-R Fetch and display server rules.
-P Fetch and display player information.
DISPLAY OPTIONS
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.
-u Only display hosts that are up and running a game server. Does
not affect template output.
-nf Do not display full servers. Does not affect template output.
-ne Do not display empty servers. Does not affect template output.
-nh Do not display header line (does not apply to raw or template
output.)
-cn Display color names instead of numbers. This is the default.
-ncn Display color numbers instead of color names. This is the default
for -raw mode.
-hc Display colors in #rrggbb format. This is nice for HTML output.
-tc Display time in clock format (DhDDmDDs). This is the default.
-tsw Display time in stop-watch format (DD:DD:DD).
-ts Display time in seconds. This is the default for -raw mode.
-pa Display player addresses. This is the default for -raw mode. Only
available for Quake and Hexen II.
-sort sort-key
Sort servers before display. Servers are sorted according to the
sort-key which is one or more of:
* p - Sort by ping
* g - Sort by game
-hpn Display player names in hex.
-old Use pre-qstat 1.5 display style.
-raw delimiter
Display data in "raw" mode. The argument to -raw is used to
separate columns of information. All information returned by the
game server is displayed.
POQS output -- General server information is displayed in this
order: command-line arg (IP address or host name), server name,
server address (as returned by Quake server), protocol version,
map name, maximum players, current players, average response time,
number of retries. Server rules are displayed on one line as
rule-name=value. If significant packet loss occurs, rules may be
missing. Missing rules are indicated by a "?" as the last rule.
Player information is displayed one per line: player number,
player name, player address, frags, connect time, shirt color,
pants color. A blank line separates each set of server
information.
QuakeWorld and HexenWorld server output -- General server
information is displayed in this order: command-line arg (IP
address or host name), server name, map name, maximum players,
current players, average response time, number of retries. Server
rules are displayed on one line as rule-name=value. Player
information is displayed one per line: player number, player name,
frags, connect time, shirt color, pants color, ping time
(milliseconds), skin name. A blank line separates each set of
server information.
All master server output -- Master server information is displayed
in this order: command-line arg (IP address or host name), number
of servers. No other information is displayed about master
servers.
Quake II, Quake III, Half-Life, Sin, BFRIS, Kingpin, Heretic II,
Unreal, and Shogo server output -- General server information and
server rules are the same as a QuakeWorld server. The player
information varies for each game:
+ Quake II/III, Sin, Kingpin, Heretic II, Shogo: player name,
frags, ping time
+ Half-Life: player name, frags, connect time
+ Tribes: player name, frags, ping time, team number, packet
loss
+ Unreal: player name, frags, ping time, team number, skin,
mesh, face
+ BFRIS: player number, ship, team name, ping time, score,
frags, player name
Ping time is in milli-seconds. Connect time is in seconds. A blank
line separates each set of server information.
-raw-arg
When used with -raw, always display the server address as it
appeared in a file or on the command-line. Note that when -H is
used with -raw, the first field of the raw output could be a
hostname if the server IP address was resolved. This can make
matching up input servers addresses with raw output lines fairly
difficult. When -raw-arg is also used, an additional field, the
unresolved server address, is added at the beginning of all raw
output lines.
-progress
Print a progress meter. Displays total servers processed,
including timeouts and down servers. The meter is just a line of
text that writes over itself with <cr>. Handy for interactive use
when you are redirecting output to a file (the meter is printed on
stderr).
-Tserver file
-Tplayer file
-Theader file
-Ttrailer file
Output templates. Each template should be a text file containing
QStat variables that are substituted for results from the server
query. The -Tserver flag must present to enable template output.
The other -T flags are optional. The server template is output
once for each server queried. The player template, if present, is
output once for each player (if -P is also used). The header
template is output once before any servers are output. The trailer
template is output once after all servers are processed. See
Appendix A for the output template formatting and variables.
NOTE: All of of the -T flags may be abbreviated with two
characters: -Ts, -Tp, -Th, and -Tt.
-errors
Display errors.
SEARCH OPTIONS
-H Resolve IP addresses to host names. Use with caution as many game
servers do not have registered host names. QStat may take up to a
minute to timeout on each unregistered IP address. The duration of
the timeout is controlled by your operating system. Names are
resolved before attempting to query any servers.
-Hcache cache-file
Cache host name and IP address resolutions in cache-file. If the
file does not exist, it is created. If -Hcache is used without -H,
then the cache is only used for host to IP address resolution.
WARNING A host cache file should not be shared by QStat programs
running at the same time. If you run several QStats at the same
time, each should have its own cache file.
-interval seconds
Interval in seconds between server retries. Specify as a floating
point number. Default interval is 0.5 seconds. This option does
not apply to master servers (see -mi.)
-mi seconds
Interval in seconds between master server retries. Specify as a
floating point number. Default interval is 2 seconds.
-retry number
Number of retries. QStat will send this many packets to a host
before considering it non-responsive. Default is 3 retries.
-maxsimultaneous number
Number of simultaneous servers to query. Unix systems have an
operating system imposed limit on the number of open sockets per
process. This limit varies between 32 and 100 depending on the
platform. On Windows 95 and Windows NT, the "select" winsock
function limits the number of simultaneous queries to 64. These
limits can be increased by minor changes to the code, but the
change is different for each platform. Default is 20 simultaneous
queries. This option may be abbreviated -maxsim.
-timeout seconds
Total run time in seconds before giving up. Default is no timeout.
NOTES
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.
EXAMPLES
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
IMPLEMENTATION NOTES
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.
BUGS
PORTABILITY
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.
VERSION
This is QStat version 2.3g. 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.activesw.com/people/steve/qstat.html
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 was created by Dynamix, Inc. BFRIS
created by Aegis Simulation Technologies. Kingpin created by Xatrix
Entertainment Inc.
AUTHOR
Steve Jankowski
steve@activesw.com
COPYRIGHT
Copyright 1996,1997,1998,1999 by Steve Jankowski
Permission granted to use this software for any purpose you desire
provided that existing copywrite notices are retained verbatim in all
copies and derived works.
------------------------------------------------------------------------
APPENDIX A - Output Templates
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:
TemplateOption
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.
header -Th Output once before any servers are queried.
trailer -Tt Output once after all servers are queried.
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 template. 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.
Download considerations
If you are generating output to be downloaded, then you'll want to make your
output as small as possible. In the case of HTML, you can reduce the size of
your pages by excluding stuff.
*Remove unneeded spaces (indenting and newlines)
*Remove unneeded end tags. The HTML spec says the following tags can always
be left out: </TD> </TR> </TH>
*When creating a table, "width" modifiers are only needed on one cell of a
column. Put them on the cells of the first row of the table.
Display options
The display options -u, -ne, and -nf have no affect on template output. Use
the $IF:UP, $IF:ISEMPTY, and $IF:ISFULL conditions to accomplish the same
thing.
General Variables
$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.
$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.
$\ 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.
Server Variables
$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.
$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
Half-Life
Half-Life Master
Sin
Tribes
Tribes Master
Shogo: Mobile Armor Division
Quake III: Arena
Quake III Master
BFRIS
Kingpin
Heretic II
Soldier of Fortune
If the server type is not known, nothing is output.
$TYPESTRING The server's type string (see GAME OPTIONS table.)
$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.
$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.
Player Variables
The player template is only invoked if $PLAYERTEMPLATE is used in the server
template.
$PLAYERNAME The name of the player.
$FRAGS The number of frags scored.
$PLAYERPING The player's ping time to the server. This value is not
available from Half-Life 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 ?? 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 and Tribes servers.
$TEAMNAME The player's team name. This value is only available
from Tribes 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.
Display $SHIRTCOLOR and $PANTSCOLOR using #rrggbb
$COLORRGB 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.
Conditional Options
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.
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.
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.
RULE(name) True if the rule name is set on the server.
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.
ISFULL True if the server has the maximum players.
ISTEAM True if the player is a team. Only available with
Tribes servers. Only applies to the player template.
|