-
Notifications
You must be signed in to change notification settings - Fork 33
/
qstatdoc.html
1752 lines (1594 loc) · 73 KB
/
qstatdoc.html
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
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<html>
<head>
<title>QStat 2.10 documentation</title>
</head>
<BODY bgcolor=#543540 text=#e5e5e5 link=#ccffff vlink=#90e0e0>
<dl>
<H3><dt>NAME</H3>
<dd>
qstat - Get statistics from on-line game servers
<H3><dt>SYNOPSIS</H3>
<dd>
<b>qstat</b> [<i>options</i> ...]
[<b>-f</b> <i>file</i>]
[<b>-of</b>|<b>-af</b> <i>output-file</i>]
[<b>-<i>server-option</i></b> <i>host</i>[:<i>port</i>]]
<br>
[<b>-raw</b> <i>delimiter</i>]
[<b>-default</b> <i>server-type</i>]
<i>host</i>[:<i>port</i>[<i>-port_max</i>]</i>] ...
<H3><dt>Version 2.10</H3>
<H3><dt>DESCRIPTION</H3>
<dd><p>
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.
<p>
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.
<b>Note for Tribes 2:</b> QStat only supports Tribes 2 builds
numbered 22075 or higher.
<b>Note for Ghost Recon</b> QStat only supports GhostRecon patch 1.2,
1.3, 1.4, Desert Siege, and Island Thunder.
<p>
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 <b>-uns</b> flag. Unreal Tournament is also
supported by the <b>-uns</b> 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).
<p>
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.
<p>
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.
<p>
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 <b>-f</b> option, a text file.
<H3><dt>DISPLAY MODES</H3>
<dd><p>
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.
<p>
QStat supports three additional display modes: <i>raw</i>,
<i>templates</i>, and <i>XML</i>. 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 <b>-raw</b> option, template
output is enabled using <b>-Ts</b>, and XML output is enabled
with <b>-xml</b>.
<H3><dt>GAME OPTIONS</H3>
<dd><p>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 <b>-f</b>.) 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.
<p>
The following table shows the command-line option and type strings
for the supported game types. The type string is used with the
<b>-default</b> option and in files with the <b>-f</b> option.
<p>
<table border=1 cellspacing=1>
<tr><th width=70>Option<th width=80>Type String<th>Default Port<th>Game Server
<tr><td>-qs<td>qs<td>26000<td>Quake
<tr><td>-h2s<td>h2s<td>26900<td>Hexen II
<tr><td>-qws<td>qws<td>27500<td>QuakeWorld
<tr><td>-hws<td>hws<td>26950<td>HexenWorld
<tr><td>-q2s<td>q2s<td>27910<td>Quake II
<tr><td>-uns<td>uns<td>7777<td>Unreal
<tr><td>-ut2s<td>ut2s<td>7777<td>Unreal Tournament 2003
<tr><td>-ut2004m<td>ut2004m<td>28902<td>Unreal Tournament 2004 Master <b>requires CD Key</b>
<tr><td>-hls<td>hls<td>27015<td>Half-Life
<tr><td>-sns<td>sns<td>22450<td>Sin
<tr><td>-sgs<td>sgs<td>27888<td>Shogo: Mobile Armor Division
<tr><td>-tbs<td>tbs<td>28001<td>Starsiege: Tribes
<tr><td>-t2s<td>t2s<td>28000<td>Tribes 2
<tr><td>-qwm<td>qwm<td>27000<td>QuakeWorld master
<tr><td>-hwm<td>hwm<td>26900<td>HexenWorld master
<tr><td>-q2m<td>q2m<td>27900<td>Quake II master
<tr><td>-hlm<td>hlm<td>27010<td>Half-Life master
<tr><td>-stm<td>stm<td>27010<td>Half-Life master (Steam)
<tr><td>-tbm<td>tbm<td>28000<td>Tribes master
<tr><td>-t2m<td>t2m<td>28002<td>Tribes 2 master
<tr><td>-q3s<td>q3s<td>27960<td>Quake III
<tr><td>-q3m<td>q3m<td>27950<td>Quake III master
<tr><td>-dm3s<td>dm3s<td>27666<td>Doom 3
<tr><td>-dm3m<td>dm3m<td>27650<td>Doom 3 master
<tr><td>-bfs<td>bfs<td>44001<td>BFRIS
<tr><td>-kps<td>kps<td>31510<td>Kingpin
<tr><td>-hrs<td>hrs<td>28910<td>Heretic II
<tr><td>-sfs<td>sfs<td>28910<td>Soldier of Fortune
<tr><td>-gsm<td>gsm<td>28900<td>Gamespy master
<tr><td>-gps<td>gps<td>-<td>Game using "Gamespy style" protocol
<tr><td>-gps<td>gs2<td>-<td>Game using "Gamespy2 style" protocol
<tr><td>-d3m<td>d3m<td>3445<td>Descent 3 PXO master
<tr><td>-d3p<td>d3p<td>2092<td>Descent 3, PXO server
<tr><td>-d3s<td>d3s<td>2092<td>Descent 3, LAN server
<tr><td>-d3g<td>d3g<td>20142<td>Descent 3, Gamespy protocol
<tr><td>-rws<td>rws<td>27960<td>Return to Castle Wolfestein
<tr><td>-rwm<td>rwm<td>27950<td>Return to Castle Wolfestein master
<tr><td>-efs<td>efs<td>27960<td>Star Trek: Elite Force
<tr><td>-efm<td>efm<td>27953<td>Star Trek: Elite Force master
<tr><td>-efs<td>efs<td>29070<td>Jedi Knight: Jedi Academy
<tr><td>-efm<td>efm<td>29060<td>Jedi Knight: Jedi Academy master
<tr><td>-grs<td>grs<td>2346<td>Ghost Recon
<tr><td>-etqws<td>etqws<td>27733<td>QuakeWars server
</table>
<p>
The command-line options can be specified multiple times, one for
each server to be queried.
<h4>Configuration Files</h4>
The games supported by QStat can be customized with configuration
files. The query parameters
of built-in game types can be modified and new games can be defined.
<p>
For built-in game types, certain parameters can be modified. The
parameters are limited to the master server protocol and master
server query string.
<p>
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 <b>-q3s</b>
or <b>-gps</b>, 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.
<p>
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 <b>-cfg</b>
command-line option. See <a href="#APPENDIXB">Appendix B</a> for
a description of the configuration file format.
<h4>Descent 3</h4>
Support for Descent 3 is a bit fragmented. There are three different
protocols for getting status information from a Descent 3 server: PXO,
LAN, and Gamespy. If the server was acquired from the PXO master
server, then the PXO protocol is used. If the server is running on
the local LAN (not reporting to a master server), then the LAN
protocol should be used. Finally, if the server's Gamespy query
port is known (default is 20142) then the Gamespy protcol can be
used. The gamespy protocol can be used on servers listed in the PXO
master.
<p>
Each protocol reports different information. The Gamespy protocol
provides player names, frags, deaths, and ping. The PXO and LAN
protocols only provide player names.
<p>
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:<pre>qstat -d3m,outfile gt.pxo.net,d3pxo.txt</pre>
Then convert the file from "d3p" to "d3g" and remove the port numbers:
<pre>sed -e 's/d3p/d3g/' -e 's/:.*$//' d3pxo.txt > d3gs.txt</pre>
Then run the servers in d3gs.txt with -f:
<pre>qstat -f d3gs.txt</pre>
This technique will retrieve the full player info for servers using
the default gamespy query port.
<H4>Broadcast Queries</H4>
<dd>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).
<p>
A broadcast query is specified by prefixing an address with a '<tt>+</tt>'
(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.
<H4>Port Ranges</H4>
Broadcast Queries can scan a range of ports to find game servers that don't run
on the default port. Specify the minimum and maximum port of a range separated
by a dash.
<H4>Query Arguments</H4>
Some game types support customized server queries. For example,
many master servers can return a select list of servers based on
the mod, number of players, or region. Each query can be
customized differently.
<p>
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:
<pre>
<i>-server-option</i>,<i>query-arg</i>[=<i>arg-value</i>][, ...]
</pre>
See the Master Server sections below for more examples.
<H5>General Query Arguments</H5>
The follow query arguments can be applied to any server type.
<table border=1>
<tr><th>Query Argument<th>Description
<tr><td>showgameport<td>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 <b>-showgameport</b> command-line option,
but only applies to one server query.
<tr><td>gp<td>Short-hand for showgameport.
<tr><td>noportoffset<td>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 <b>-noportoffset</b> command-line option,
but only applies to one server query.
<tr><td>qp<td>Short-hand for noportoffset.
</table>
<p>
Some examples of the general query arguments.
<pre>
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 server
</pre>
The 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:
<pre>
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 server
</pre>
Another common usage for "showgameport" is with broadcast queries:
<pre>
qstat -uns,showgameport +255.255.255.255
</pre>
<H4>Master Servers</H4>
Master server addresses don't change very often, but some times they
go off-line. The following is a table of some of the master servers
I know about.
<p>
<table border=1><tr><th align=left>Game<th align=left>Master Servers
<tr><td>QuakeWorld<td>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
<tr><td>Quake II<td>satan.idsoftware.com, q2master.planetquake.com
<tr><td>Half-Life (hlm)<td>half-life.west.won.net, half-life.east.won.net
<tr><td>Half-Life (stm)<td>steam1.steampowered.com:27010, steam2.steampowered.com:27010
<tr><td>Tribes<td>tribes.dynamix.com
<tr><td>Quake III<td>master3.idsoftware.com
<tr><td>Doom 3<td>idnet.ua-corp.com
<tr><td>Gamespy<td>master0.gamespy.com
<tr><td>Tribes 2<td>211.233.32.77:28002, 217.6.160.205:28002
<tr><td>Descent 3<td>gt.pxo.net
<tr><td>Return to Castle Wolfenstein<td>wolfmaster.idsoftware.com
<tr><td>Star Trek: Elite Force<td>master.stef1.ravensoft.com
<tr><td>UT2004<td>ut2004master1.epicgames.com, ut2004master2.epicgames.com, ut2004master3.epicgames.com
</table>
<H4>Gamespy Master</H4>
<b>Access to the gamespy masters has been disabled by Gamespy Inc.</b>
<p>
Server lists can be fetched from Gamespy masters by using the <b>gsm</b>
game type. A <i>query argument</i> 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.
<p>
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 <b>gps</b> game type.
Through experimentation I've found the following query arguments.
<p>
<table border=1>
<tr><th>Query Argument<th>Game
<tr><td>roguespear<td>Rainbow Six: Rogue Spear
<tr><td>redline<td>Redline Racer
<tr><td>turok2<td>Turok 2: Seeds of Evil
<tr><td>blood2<td>Blood 2: The Chosen
<tr><td>drakan<td>Drakan: Order of the Flame
<tr><td>kiss<td>KISS Psycho Circus: The Nightmare Child
<tr><td>nerfarena<td>Nerf Arena Blast
<tr><td>rally<td>Rally Masters: Michelin Race Of Champions
<tr><td>terminous<td>Terminous (?)
<tr><td>wot<td>The Wheel of Time
<tr><td>daikatana<td>Daikatana
</table>
<H4>Tribes 2 Master</H4>
The Tribes 2 master server supports a number of filtering options.
You can set these filters with QStat by appending query arguments
to the server type. The general syntax is:
<blockquote>
<b>t2m,</b><i>query-arg</i><b>=</b><i>value</i><b>,</b> ...
</blockquote>
<table border=1>
<tr><th>Query Argument<th>Values<th>Description
<tr><td>game<td><i>mod path</i><td>Mod path the server is using. The mod
path of unaltered servers is "base". Use <b>query=types</b> to
get the list of known game types.
<tr><td>mission<td>Bounty, Capture the Flag, CnH, Deathmatch, Hunters,
Rabbit, Siege, TeamHunters<td>Mission type the server is currently running.
Use <b>query=types</b> to get the list of known mission types.
<tr><td>minplayers<td><i>0 - 255</i><td>Servers with fewer players than this will not be returned.
<tr><td>maxplayers<td><i>1 - 255</i><td>Servers with more players than this will not be returned.
<tr><td>regions<td><i>list of regions</i> or 0x<i>hex-value</i>
<td>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: <b>regions=0x11</b>.
<tr><td>build<td><i>build version #</i>
<td>Only return servers matching this build version number. <b>[4/20/2001]
This filter only seems to work if the <i>build version #</i> is 22337.
If the filter is 22228, then the master returns 0 servers. This appears
to be a bug in the T2 master.</b>
<tr><td>status<td><i>list of </i>dedicated, linux, nopassword<br>or 0x<i>hex-value</i>
<td>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 <b>status=dedicated:linux</b><br>
If you know a status flag that QStat doesn't support, you can specify
the status flags directly by supplying a hex value: <b>status=0x3</b>
<tr><td>maxbots<td><i>0 - 255</i><td>Servers with more bots than this will not be returned.
<tr><td>mincpu<td><i>0 - 65535</i><td>Servers with lower CPU speed than this will not be returned.
<tr><td>query<td>types<td>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.
</table>
<blockquote>
<h5>Region List</h5>
The region list is one or more region arguments separated by colons (':').
For example, to filter on North American servers specify <b>regions=naeast:nawest</b>
<p>
<table border=1>
<tr><th>Region Argument<th>Geography
<tr><td>naeast<td>North America East
<tr><td>nawest<td>North America West
<tr><td>sa<td>South America
<tr><td>aus<td>Australia
<tr><td>asia<td>Asia
<tr><td>eur<td>Europe
</table>
</blockquote>
The Tribes 2 master query arguments can be used on the command-line
or in a server list file (via the <b>-f</b> 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:
<blockquote>
<b>qstat -t2m,mission=Capture the Flag,minplayers=6</b> <i>master-server-ip</i><br>
<b>qstat -t2m,mission="Capture the Flag",minplayers=6</b> <i>master-server-ip</i><br>
</blockquote>
If you want to do this in a server list file, that would look like
this:
<blockquote>
<b>t2m,mission=Capture the Flag,minplayers=6</b> <i>master-server-ip</i><br>
</blockquote>
Master server filters can be combined with the "<b>outfile</b>" option.
Just put <b>outfile</b> some where in the query argument list and put
the name of the output file after the master IP address:
<blockquote>
<b>t2m,outfile,mission=Siege,minplayers=4</b> <i>master-server-ip</i><b>,siegeservers.txt</b>
</blockquote>
Warning: 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.
<H4>Half-Life Master</H4>
The Half-Like master server supports a number of filtering options.
You can set these filters with QStat by appending query arguments
to the server type. The general syntax is:
<blockquote>
<b>hlm,</b><i>query-arg</i><b>=</b><i>value</i><b>,</b> ...
</blockquote>
<table border=1>
<tr><th>Query Argument<th>Values<th>Description
<tr><td>game<td><i>mod path</i><td>Servers running this "mod".
<tr><td>map<td><i>map name</i><td>Servers running this map.
<tr><td>status<td><i>list of </i>dedicated, linux, notempty, notfull
<td>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 <b>status=dedicated:notempty</b>
</table>
See the Tribes 2 master server above for example usage.
<H4>Half-Life Master (Steam)</H4>
The Half-Life steam master server supports a number of filtering options
different from the old WON master.
<blockquote>
<b>stm,</b><i>query-arg</i><b>=</b><i>value</i><b>,</b> ...
</blockquote>
<table border=1>
<tr><th>Query Argument<th>Values<th>Description
<tr><td>game<td><i>mod path</i><td>Servers running this "mod".
<tr><td>map<td><i>map name</i><td>Servers running this map.
<tr><td>region<td><i>name or number of region</i><td>Geographical Area of the server.
You can specify the name or number of the region:
<ul>
<li>0: US East coast</li>
<li>1: US West coast </li>
<li>2: South America </li>
<li>3: Europe </li>
<li>4: Asia </li>
<li>5: Australia </li>
<li>6: Middle East </li>
<li>7: Africa</li>
</ul>
<tr><td>status<td><i>list of </i>dedicated, linux, notempty, notfull, secure, proxy
<td>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 <b>status=dedicated:notempty</b>
</table>
See the Tribes 2 master server above for example usage.
<H4>Doom 3 Master</H4>
The Doom 3 master server supports a number of filtering options.
You can set these filters with QStat by appending query arguments
to the server type. The general syntax is:
<blockquote>
<b>dm3m,</b><i>query-arg</i><b>=</b><i>value</i><b>,</b> ...
</blockquote>
<table border=1>
<tr><th>Query Argument</th><th>Values</th><th>Description</th></tr>
<tr><td>status</td><td><i>colon separated list</i> of password, nopassword, notfull, notfullnotempty</td>
<td>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 <b>status=nopassword:notfull</b></td></tr>
<tr><td>gametype</td><td><i>one of</i> dm, tdm or tourney</td>
<td>limit servers to those mathing the specified gametype</td></tr>
</table>
See the Tribes 2 master server above for example usage.<br>
A special option is a number major.minor which specifies the protocol version.
<H4>UT2004 Master</H4>
The UT2004 master server supports a number of filtering options.
You can set these filters with QStat by appending query arguments
to the server type. The general syntax is:
<blockquote>
<b>ut2004m,</b><i>query-arg</i><b>=</b><i>value</i><b>,</b> ...
</blockquote>
<table border=1>
<tr>
<th>Query Argument</th>
<th>Values</th>
<th>Description</th>
</tr>
<tr>
<td><b>cdkey</b></td>
<td>path to the UT2004 cdkey file</td>
<td>You MUST specify a valid CD key to be able to query the master server</td>
</tr>
<tr>
<td>status</td>
<td><i>colon separated list</i> of password, nopassword, notfull, notempty,
standard, nostandard, nobots, stats, nostats, weaponstay, noweaponstay,
transloc, notransloc</td>
<td>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
<b>status=standard:nopassword:notfull</b></td>
</tr>
<tr>
<td>gametype</td>
<td>any UT2004 gametype, e.g. xMutantGame</td>
<td>limit servers to those mathing the specified gametype</td>
</tr>
<tr>
<td>mutator</td>
<td><i>colon separated list</i> of Mutators.</td>
<td>limit servers to those running the specified mutators. Prepend a dash
to include servers that do NOT run the specified mutator</td>
</tr>
</table>
You may need to specify at least one filter option like status or gametype for
the master to actually return any server.<br>
Example:
<blockquote>
<b>qstat -ut2004m,cdkey=/usr/local/games/ut2004/System/cdkey,status=nostandard ut2004master1.epicgames.com:28902<br>
</blockquote>
<H4>Option Usage</H4>
<dl>
<dt><b>-cfg</b> <i>configuration-file</i><dd>
Load the QStat configuration file. New game types defined in
the config file can be used in subsequent command-line options.
<dt><b>-<i>server-option</i></b> <i>host</i>[:<i>port</i>]<dd>
Query game server <i>host</i> for status. The GAME OPTIONS
table lists the available <i>server-options</i> and their default
port.
<dt><b>-nocfg</b>
Ignore qstat configuration loaded from any default location
(see <a href="#APPENDIXB">Appendix B</a> for a list of default locations). Must be the
first option on the command-line. Use this option to have
complete control over the configured game types.
<dt><b>-<i>master-server-option</i></b> <i>host</i>[:<i>port</i>]<dd>
Query a game master for its server list and then query all
the servers. The GAME OPTIONS
table lists the available <i>master-server-options</i>
and their default port.
<dt><b>-<i>master-server-option</i>,outfile</b> <i>host</i>[:<i>port</i>],<i>file</i><dd>
Query a game master for its server list and store it
in <i>file</i>. If the master cannot be contacted, then
<i>file</i> is not changed. If <i>file</i> is <b>-</b> (a
single dash), then stdout is used.
The GAME OPTIONS table lists the available
<i>master-server-options</i> and their default port.
<dt><b>-gsm,<i>query-argument</i></b> <i>host</i>[:<i>port</i>]<dd>
Query a Gamespy master for a server list and then query all
the servers. The Gamespy Master section details the supported
values for <i>query-argument</i>.
<dt><b>-gsm,<i>query-argument</i>,outfile</b> <i>host</i>[:<i>port</i>],<i>file</i><dd>
Query a Gamespy master for a server list and store it
in <i>file</i>. If the master cannot be contacted, then
<i>file</i> is not changed. If <i>file</i> is <b>-</b> (a
single dash), then stdout is used.
The Gamespy Master section details the supported
values for <i>query-argument</i>.
<dt><b>-q3m,<i>query-argument</i></b> <i>host</i>[:<i>port</i>]<dd>
Query a Quake 3 Arena master for a protocol-specific server list
and then query all the servers. The <i>query-argument</i> should
be a Quake 3 protocol version. Protocol version 48 is Quake 3
version 1.27, protocol 46 is Quake 3
version 1.25, protocol 45 is Quake 3 1.17, protocol 43 is Quake 3
version 1.11. The default is protocol version 48.
<dt><b>-q3m,<i>query-argument</i>,outfile</b> <i>host</i>[:<i>port</i>],<i>file</i><dd>
Query a Quake 3 Arena master for a protocol-specific server list
and store it in <i>file</i>. The <i>query-argument</i> should
be a Quake 3 protocol version. Protocol version 46 is Quake 3
version 1.25, protocol 45 is Quake 3 1.17, protocol 43 is Quake 3
version 1.11. The default is protocol version 45.
<dt><b>-f</b><i> file</i><dd>
Read host addresses from the given file. If <i>file</i> is <b>-</b>,
then read from stdin. Multiple <b>-f</b> 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 <b>-default</b>
is used. The GAME OPTIONS table lists the available server
type strings and their default port.
<dt><b>-default</b><i> type-string</i><dd>
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 <b>-f</b>).
The GAME OPTIONS table lists the available server
type strings and their default port.
<dt><b>-noportoffset</b><dd>
Do not apply the "status port offset" when
sending server queries. 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 addresses should be an IP address and a query
port (not the game port).
This is the same as the <b>noportoffset</b> server query argument,
but applies to all servers being queried.
</dl>
<H3><dt>INFO OPTIONS</H3>
<dl compact><dt><b>-R</b><dd>
Fetch and display server rules.
<dt><b>-P</b><dd>
Fetch and display player information.
</dl>
<H3><dt>DISPLAY OPTIONS</H3>
<dd><p>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.
<p>
<dl compact>
<dt><b>-of</b> <i>file</i><dd>
Write output to <i>file</i> instead of stdout or the console.
<i>file</i> is over written if it already exists.
<dt><b>-af</b> <i>file</i><dd>
Like <b>-of</b>, but append to the file. If <i>file</i> does
not exist, it is created.
<dt><b>-u</b><dd>
Only display hosts that are up and running a game server.
Does not affect template output.
<dt><b>-nf</b><dd>
Do not display full servers. Does not affect template
output.
<dt><b>-ne</b><dd>
Do not display empty servers. Does not affect template
output.
<dt><b>-nh</b><dd>
Do not display header line (does not apply to raw or
template output.)
<dt><b>-cn</b><dd>
Display color names instead of numbers. This is
the default. Only applies to Quake, QuakeWorld,
Hexen II, and HexenWorld.
<dt><b>-ncn</b><dd>
Display color numbers instead of color names. This is
the default for <b>-raw</b> mode. Only applies to Quake,
QuakeWorld, Hexen II, and HexenWorld.
<dt><b>-hc</b><dd>
Display colors in #rrggbb format. This is nice for
HTML output. Only applies to Quake, QuakeWorld,
Hexen II, and HexenWorld.
<dt><b>-nx</b><dd>
Perform name transforms. Transform game specific player
and server name escape sequences into more readable text.
This setting is ON by default.
<dt><b>-nnx</b><dd>
No name transforms. Do not transform player and server
names. Option <b>-utf8</b> implies <b>-nnx</b>.
<dt><b>-tc</b><dd>
Display time in clock format (DhDDmDDs). This is the default.
<dt><b>-tsw</b><dd>
Display time in stop-watch format (DD:DD:DD).
<dt><b>-ts</b><dd>
Display time in seconds. This is the default for
<b>-raw</b> mode.
<dt><b>-pa</b><dd>
Display player addresses. This is the default for
<b>-raw</b> mode. Only available for Quake and Hexen II.
<dt><b>-sort</b><i> sort-keys</i><dd>
Sort servers and/or players. Servers and players are sorted
according to <i>sort-keys</i>. Lower case sort keys are
for servers and upper case keys are for players. The
following sort keys are supported:
<ul>
<li>p - Sort by ping
<li>g - Sort by game (mod)
<li>i - Sort by IP address
<li>h - Sort by hostname
<li>n - Sort by number of players
<li>l - Sort by list order
<li>P - Sort by player ping
<li>F - Sort by frags
<li>T - Sort by team
</ul>
<p>
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.
<dt><b>-hpn</b><dd>
Display player names in hex.
<dt><b>-old</b><dd>
Use pre-qstat 1.5 display style.
<dt><b>-raw</b><i> delimiter</i><dd>
Display data in "raw" mode. The argument to
<b>-raw</b> is used to separate columns of
information. All information returned by the game
server is displayed.
<br>
<b>POQS output</b> -- 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 <i>rule-name</i>=<i>value</i>. 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.
<br>
<b>QuakeWorld and HexenWorld server output</b> -- 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, game (mod). Server rules are displayed on one
line as <i>rule-name</i>=<i>value</i>. 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.
<br>
<b>All master server output</b> -- 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.
<br>
<b>Quake II, Quake III, Half-Life, Sin, BFRIS, Kingpin, Heretic II, Unreal, Tribes 2, and Shogo server output</b> -- General server information and
server rules are the same as a QuakeWorld server.
The player information varies for each game:
<ul>
<li>Quake II/III, Sin, Kingpin, Heretic II, Shogo: player name, frags, ping time
<li>Half-Life: player name, frags, connect time
<li>Tribes: player name, frags, ping time, team number, packet loss
<li>Tribes 2: player name, frags, team number, team name, player type, tribe tag
<li>Unreal: player name, frags, ping time, team number, skin, mesh, face
<li>BFRIS: player number, ship, team name, ping time, score, frags, player name
<li>Descent 3: player name, frags, deaths, ping time, team
</ul>
Ping time is in milli-seconds. Connect time is in seconds.
A blank line separates each set of server information.
<br>
<b>Ghost Recon server output</b> -- General server information and
server rules are the detailed in the GhostRecon.txt file.
Servers queried using the "Gamespy style" protocol use the
same raw output format as Unreal servers.
<p>
<dt><b>-raw,game</b><i> delimiter</i><dd>
Same as <b>-raw</b> but adds the game or mod name as the last
item of server info.
<dt><b>-raw-arg</b><dd>
When used with <b>-raw</b>, always display the server address
as it appeared in a file or on the command-line. Note that
when <b>-H</b> is used with <b>-raw</b>, 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 <b>-raw-arg</b> is also used, an
additional field, the unresolved server address, is added at the
beginning of all raw output lines.
<dt><b>-progress<i>,count</i></b><dd>
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).<br>
By default, the progress meter is updated for every server.
The updates can be limited by appending <i>,count</i> to
the option where <i>count</i> is a number. The meter
will be updated every <i>count</i> servers. For example,
-progress,10 will update every ten servers.
<dt><b>-Tserver</b><i> file</i><br>
<dt><b>-Tplayer</b><i> file</i><br>
<dt><b>-Trule</b><i> file</i><br>
<dt><b>-Theader</b><i> file</i><br>
<dt><b>-Ttrailer</b><i> file</i><dd>
Output templates. Each template should be a text file containing
QStat variables that are substituted for results from the server
query. The <b>-Tserver</b> flag must present to enable template
output. The other <b>-T</b> 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 <b>-P</b> is also
used). The rule template is output once for each server rule (the
<b>-R</b> option may be required for some game types).
The header template is output once before any servers
are output. The trailer template is output once after all servers
are output. See <a href="#APPENDIXA">Appendix A</a> for the
output template formatting and variables.<br>
NOTE: All of of the <b>-T</b> flags may be abbreviated with two
characters: <b>-Ts</b>, <b>-Tp</b>, <b>-Tr</b>, <b>-Th</b>, and <b>-Tt</b>.
<dt><b>-htmlnames</b><dd>
Colorize Quake 3 and Tribes 2 player names using html font tags.
Enabled by default if <b>$HTML</b> is used in an output template.
<dt><b>-nohtmlnames</b><dd>
Do not colorize Quake 3 and Tribes 2 player names even if
<b>$HTML</b> is used in an output template. The
<b>$HTMLPLAYERNAME</b> variable will always colorize player
names.
<dt><b>-htmlmode</b><dd>
Convert <, >, and & to the equivalent HTML entities.
This is the same as <b>$HTML</b> in an output template, but works for
raw display mode. Using <b>-htmlmode</b> with <b>-xml</b> will
result in double-escaping.
<dt><b>-carets</b><dd>
Display carets in Quake 3 player names. Carets are
used for colorized player names and are remove by default.
This option has no effect if <b>-htmlnames</b> is
enabled.
<dt><b>-xml</b><dd>
Output server information wrapped in XML tags.
<dt><b>-utf8</b><dd>
Use the UTF-8 character encoding for XML output.
<dt><b>-showgameport</b><dd>
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 <b>showgameport</b> server query argument,
but applies to all server queries.
<dt><b>-errors</b><dd>
Display errors.
<dt><b>-d</b><dd>
Enable debug options. By default, enables printing of all
received packets to stderr.
</dl>
<H3><dt>SEARCH OPTIONS</H3>
<dl compact><dt><b>-H</b><dd>
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.
<dt><b>-Hcache</b><i> cache-file</i><dd>
Cache host name and IP address resolutions in <i>cache-file</i>.
If the file does not exist, it is created. If <b>-Hcache</b> is used
without <b>-H</b>, then the cache is only used for host to IP address
resolution. <b>WARNING </b> A host cache file should <i>not</i> 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.
<dt><b>-interval</b><i> seconds</i><dd>
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 <b>-mi</b>.)
<dt><b>-mi</b><i> seconds</i><dd>
Interval in seconds between master server retries. Specify as a
floating point number. Default interval is 2 seconds.
<dt><b>-retry</b><i> number</i><dd>
Number of retries. QStat will send this many packets
to a host before considering it non-responsive. Default
is 3 retries.
<dt><b>-maxsimultaneous</b><i> number</i><dd>
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 <b>-maxsim</b>.
<dt><b>-timeout</b><i> seconds</i><dd>
Total run time in seconds before giving up. Default is
no timeout.
</dl>
<H3><dt>NETWORK OPTIONS</H3>
<dl compact>
<dt><b>-srcport</b> <i>port-number</i> | <i>port-range</i><dd>
Specify the source ports for sending packets. The ports can
be a single number or a range. A range is two numbers
separated by a dash ('-'). The numbers should be positive
and less than 65535. Use this option to get through a
firewall that has source port restrictions. Set <b>-srcport</b>
to the range of ports allowed by the firewall.
<p>
Example: If your firewall will allow outgoing UDP packets on
ports 26000-30000, the qstat option would be <b>-srcport 26000-30000</b>
<p>
<b>Note:</b> The number of source ports given should be greater
than or equal to the <b>-maxsim</b> (defaults to 20). The
number of source ports will limit the number of simultaneous
server queries.
<dt><b>-srcip</b> <i>IP-address</i><dd>
Specify a local IP address from which to send packets. This
is useful on machines that have multiple IP addresses where
the source IP of a packet is checked by the receiver.
Normally this option is never needed.
</dl>
<H3><dt>NOTES</H3>
<dd><p>
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 <b>-P</b> and
<b>-R</b> 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 <b>-P</b> and <b>-R</b> options do
not increase the number of requests to the server.
Half-Life supports three different requests for information;