Steam Game Server Queries

Description

This Python script is a command line tool that reads a list of IP:PORT Steam servers from stdin and outputs information about the servers in a pretty format.

Read more about A2S_INFO and A2S_PLAYER at Valve's Server queries wiki.

Get Started

To get started, just clone the repository. A list of Left 4 Dead 2 servers is provided in the serverList directory.

Since the script reads from stdin, just redirect your list of IP:PORT like so:

 $ ./a2sInfoPlayer.py < serverlist/compList 
SirPlease NY #1 | Zonemod v1.9.4           192.223.24.99:27015     25 ms  c5m1_waterfront            10
SirPlease NY #3                            192.223.24.99:27017     26 ms  c2m1_highway                0
Asylum NY T100 #1 | Zonemod v1.9.3         192.223.24.187:27015    28 ms  c2m3_coaster                1
[2] Larry's L4D2 Realism                   104.153.108.80:27016    31 ms  c1m3_mall                   0
SirPlease CHI #2                           74.91.122.107:27016     31 ms  c2m1_highway                0
SirPlease NY #2 | Zone :X: Skeet           192.223.24.99:27016     32 ms  c2m2_fairgrounds            1
[...]

The server list file must respect the IP:PORT format, for example:

192.223.24.99:27015
192.223.24.99:27016
192.223.24.99:27017
192.223.24.99:27018
192.223.24.99:27019
192.223.24.99:27020

Any line that doesn't match what an IP:PORT should look like is ignored.

Advanced usage

There are many command line options available, here's the help page:

 $ ./a2sInfoPlayer.py -h
usage: a2sInfoPlayer.py [-h] [-a] [-e] [-v] [-s] [-n NAME] [-p PLAYER]
                        [-m MINPLAYER] [-x MAXPLAYER] [-t TIMEOUT] [-r RETRY]
                        [-c THREADCOUNT] [-o OUTPUTFILESUCCESS]
                        [-f OUTPUTFILEFAILED] [-w OUTPUTFILESHOW]
                        [--sort {name,ip,ping,map,player}] [--sortreverse]
                        [--printestimate]

Make A2S_INFO and A2S_PLAYER requests to steam game servers. The ip:port list
is read from stdin.

optional arguments:
  -h, --help            show this help message and exit
  -a, --active          only show active servers
  -e, --empty           only show empty servers
  -v, --verbose         verbose information
  -s, --showplayers     show players
  -n NAME, --name NAME  search for server name, accepts multiple values
                        (disjunction)
  -p PLAYER, --player PLAYER
                        search for player, accepts multiple values
                        (disjunction)
  -m MINPLAYER, --minplayer MINPLAYER
                        minimum player count (inclusive)
  -x MAXPLAYER, --maxplayer MAXPLAYER
                        maximum player count (inclusive)
  -t TIMEOUT, --timeout TIMEOUT
                        timeout before retry (ms)
  -r RETRY, --retry RETRY
                        request retry amount
  -c THREADCOUNT, --threadcount THREADCOUNT
                        max requests at once (MAX_THREAD_COUNT)
  -o OUTPUTFILESUCCESS, --outputfilesuccess OUTPUTFILESUCCESS
                        output destination file for successful connections
  -f OUTPUTFILEFAILED, --outputfilefailed OUTPUTFILEFAILED
                        output destination file for failed connections
  -w OUTPUTFILESHOW, --outputfileshow OUTPUTFILESHOW
                        output destination file for showing connections
  --sort {name,ip,ping,map,player}
                        sort by field
  --sortreverse         reverse sort
  --printestimate       prints an execution time estimate

Increasing --threadcount improves performance but can easily overload your network card if the value is too high. You will get more failed connections because of dropped UDP packets. Increasing --retry to 2 (default is 1 try) will increase reliability but also increase execution time and load on the network card. The --timeout option can also be viewed as a maximum ping filter.

Helper scripts

Finally, the bash directory contains quick one liner bash commands that I use frequently.