Serverbrowse (XML Service)

From HLSW Wiki

The serverbrowser XML Service is located at http://xml.hlsw.org/serverbrowse . It provides a small list of global available game servers that are known to HLSW. Several filters are possible as optional parameters that can be used to e.g. get only servers from one game etc.

Filters

The filters are added after the serverbrowse string.

Parameter	Description
/game=_GAME_	Comma seperated list of game identifiers. A complete list of game ids can be found at http://phphlswconfig.hlsw.org/hlsw_gamelist2.php .
/mod=_MOD_	Comma seperated list of mod identifiers. A complete list of mod ids can be found at http://phphlswconfig.hlsw.org/hlsw_gamelist2.php .
/country=_COUNTRY_	Comma seperated list of two letter country codes (ISO 3166-1 alpha-2)
/no_password/	Get only password unprotected servers.
/server_name=_PHRASE_/	Find any server name containing the phrase.
/slots_available=_X_/	Minimum number of free slots.
/limit=_LIMIT_/	Set the maximum number of returned servers. (Default 10)
/offset=_OFFSET_/	Set the offset of the first server that is returned. (Default 0)

Examples:

• http://xml.hlsw.org/serverbrowse/game=hl2/mod=cstrike/country=de,fr returns all Counter-Strike Source servers from Germany and France
• http://xml.hlsw.org/serverbrowse/server_name=HLSW returns all server with HLSW in their name

Format

<?xml version="1.0" encoding="UTF-8"?>
<hlsw>
 <serverbrowse>
  <server>
   <name><![CDATA[#hlsw-serverbrowser.L4D]]></name>
   <ip>213.202.194.250</ip>
   <port>27015</port>
   <connectport>27015</connectport>

   <addrstr>213.202.194.250:27015</addrstr>
   <game>L4D</game>
   <mod></mod>
   <map>l4d_vs_hospital04_interior</map>
   <password>0</password>
   <clientcount>8</clientcount>

   <clientmax>8</clientmax>
   <botcount>0</botcount>
   <reservedslots>0</reservedslots>
   <country>DE</country>
   <hlswurl>hlsw://213.202.194.250:27015?Game=L4D</hlswurl>
  </server>
  <server>
   ...
  </server>
  ...
 </serverbrowse>
</hlsw>

Key	Description
name	Game server name
ip	Game server ip address
port	Game server query port
connectport	Game server connect port
addrstr	Game server address string (ip:port)
game	HLSW game identifier
mod	Mod identifier
map	Map name
password	Set to 1 if server is password protected
clientcount	Number of players that are playing on the server (human + bots)
clientmax	Maximum number of players
botcount	Number of bots that ere playing on the server
reservedslots	Slots that are reserved on the server for admins or privileged players
country	Country of the server
hlswurl	HLSW URL for the game server