Soldat Server Stats: Query information from a Soldat game server

     _________________________________________________________________

                                  README

  Content:

  1. About
  2. Description
  3. System requirements
  4. Usage
  5. Contact


     _________________________________________________________________


  (1) ABOUT

    VERSION: 1.0
    AUTHOR: Tomaž Muraus <kami[at]k5-storitve[dot]net>
    WEBSITE: http://www.tomaz-muraus.info
    
    
  (2) DESCRIPTION

    SoldatServerStats is a simple PHP script for displaying live Soldat
    server statistics.
    The following information is available: server name, version, ping,
    map name, gametype, server rules, current number of players, maximum number of
    players and list of players currently playing on the server.


  (3) SYSTEM REQUIREMENTS

    - PHP >= 4.3.0
    - 1 MB of free disk space


  (4) USAGE

    1. Include a file SoldatServer.php in your PHP script
    2. Create a SoldatServer object - first parameter is the server
    address, second one is the server port and the third one is the timeout
    in seconds.
    If the default port is used (23073), second parameter can be omitted.
    3. Call queryServer() method on the previously created object
    4. If nothing went wrong, you can now access the server information with
    the following methods:
    
    getIp()			-> returns server IP address
    getPort()		-> returns server port
    getName() 		-> returns server name
    getVersion()	-> returns server version
    getMap() 		-> returns map name
    getGametype() 	-> returns gametype
    getPing()		-> returns server ping
    getRules()		-> returns server rules as a key-value pairs
    getPlayers()	-> returns player list as an array of SoldatPlayer objects 
    
	Example (server address = localhost, port = 23073, timeout = 5 s):
	
	include ('SoldatServer.php');
	
	$server = new SoldatServer('localhost', 23073, 5);
	$server->queryServer();
	
	echo $server->getName();
	
	Two more examples (normal and console version) are located in the
	directory examples/.