Updated readme

README.md

@@ -1,29 +1,83 @@
-PHP SourceQuery
+PHP Source Query
-===============
+================
 
 ### Description
+This class was created to query game server which use the Source query protocol, this includes all source games, half-life 1 engine games and Call of Duty: Modern Warfare 3
 
-This class was created to query servers that use 'Source Query' protocol, for games like HL1, HL2, The Ship, SiN 1, Rag Doll Kung Fu and more.
+The class also allows you to query servers using RCON although this only works for half-life 1 and source engine games.
 
-This also works for **Call of Duty: Modern Warfare 3**, as it uses Source Query protocol as well.
+[Minecraft](http://minecraft.net) also uses Source RCON protocol, and this means you can use this class to send commands to your minecraft server while having engine set to source.
 
-You can find protocol specifications here: http://developer.valvesoftware.com/wiki/Server_queries
+##### Protocol specifications can be found over at VDC
+* https://developer.valvesoftware.com/wiki/Server_queries
+* https://developer.valvesoftware.com/wiki/Source_RCON_Protocol
 
 ### Usage
+You can find easy examples on how to use it in `View.php`
 
-You can find easy examples on how to use it in `Test.php` file, or just run `view.php`
+### Example
+```php
+<?php
+	require 'SourceQuery.class.php';
+	
+	$Query = new SourceQuery( );
+	
+	try
+	{
+		$Query->Connect( 'localhost', 27015, 3, SourceQuery :: GOLDSOURCE );
+		
+		print_r( $Query->GetInfo( ) );
+		print_r( $Query->GetPlayers( ) );
+		print_r( $Query->GetRules( ) );
+		
+		$Query->SetRconPassword( 'this_is_your_leet_rcon_password' );
+		echo $Query->Rcon( 'status' );
+	}
+	catch( SQueryException $e )
+	{
+		echo $e->getMessage( );
+	}
+	
+	$Query->Disconnect( );
+?>
+```
 
 ### Functions
-
+<table>
-Open connection to a server: `Connect( $IP, $Port );`
+	<tr>
-
+		<td>Connect( $Ip, $Port, $Timeout, $Engine )</td>
-Close connection: `Disconnect( );`
+		<td>Opens connection to a server</td>
-
+	</tr>
-Set rcon password for future use: `SetRconPassword( $RconPassword );`
+	<tr>
-
+		<td>Disconnect( )</td>
-Execute Rcon command: `Rcon( $Command );`
+		<td>Closes all open connections</td>
+	</tr>
+	<tr>
+		<td>Ping( )</td>
+		<td>Ping the server to see if it exists<br><b>Warning:</b> Source engine may not answer to this</td>
+	</tr>
+	<tr>
+		<td>GetInfo( )</td>
+		<td>Returns server info in an array</td>
+	</tr>
+	<tr>
+		<td>GetPlayers( )</td>
+		<td>Returns players on the server in an array</td>
+	</tr>
+	<tr>
+		<td>GetRules( )</td>
+		<td>Returns public rules <i>(cvars)</i> in an array</td>
+	</tr>
+	<tr>
+		<td>SetRconPassword( $Password )</td>
+		<td>Sets rcon password for later use with <i>Rcon()</i></td>
+	</tr>
+	<tr>
+		<td>Rcon( $Command )</td>
+		<td>Execute rcon command on the server</td>
+	</tr>
+</table>
 
 ### License
-
 > *This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported License.<br>
-> To view a copy of this license, visit http://creativecommons.org/licenses/by-nc-sa/3.0/*
+> To view a copy of this license, visit http://creativecommons.org/licenses/by-nc-sa/3.0/*

SourceQuery.class.php

@@ -62,19 +62,12 @@ class SourceQuery
 		$this->Disconnect( );
 	}
 	
-	public function Connect( $Ip, $Port, $Timeout = 3, $Engine = -1 )
+	public function Connect( $Ip, $Port, $Timeout = 3, $Engine = self :: SOURCE )
 	{
 		$this->Disconnect( );
 		$this->Buffer->Reset( );
 		$this->Challenge = 0;
 		
-		if( $Engine == -1 )
-		{
-			$Engine = self :: SOURCE;
-			
-			Trigger_Error( 'You should pass $Engine variable to Connect(), defaulting to Source.' );
-		}
-		
 		if( !$this->Socket->Open( $Ip, (int)$Port, (int)$Timeout, (int)$Engine ) )
 		{
 			throw new SourceQueryException( 'Can\'t connect to the server.' );