TeeWorlds Server Stats: Query information from a TeeWorlds 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

    TeeWorldsServerStats is a simple PHP script for displaying live Tee Worlds
    server statistics.
    The following information is available: server name, version, ping,
    map name, gametype, 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 TeeWorldsServer.php in your PHP script
    2. Create a TeeWorldsServer 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 (8303), 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
    getPlayers()	-> returns player list as an array of TeeWorldsPlayer objects 
    
	Example (server address = localhost, port = 8305, timeout = 5 s):
	
	include ('TeeWorldsServer.php');
	
	$server = new TeeWorldServer('localhost', 8305, 5);
	$server->queryServer();
	
	echo $server->getName();
	
	Two more examples (normal and console version) are located in the
	directory examples/.