koshatul/php-source-query

:elephant: PHP library to query servers that implement Source Engine Query protocol

PHP Source Query

This class was created to query game server which use the Source query protocol, this includes all source games, and all the games that implement Steamworks.

The class also allows you to query servers using RCON although this only works for half-life 1 and source engine games.

Minecraft 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 engine.

This library requires a modern version of PHP, so make sure you are using at least PHP 5.4 or newer.

Protocol specifications can be found over at VDC

• https://developer.valvesoftware.com/wiki/Server_queries
• https://developer.valvesoftware.com/wiki/Source_RCON_Protocol

Supported Games

• All multiplayer games released by Valve: Counter-Strike 1.6, Counter-Strike: Global Offensive, Team Fortress 2, etc...
• Rag Doll Kung Fu
• The Ship
• Dino D-Day
• Nuclear Dawn
• Call of Duty: Modern Warfare 3
• Starbound (use SetUseOldGetChallengeMethod method after connecting)
• Arma 3 (add +1 to the server port, their implementation also violates Source query protocol spec.)
• Minecraft (RCON ONLY!)
• and many other games that implement Source Query Protocol

Functions

Connect( $Ip, $Port, $Timeout, $Engine )	Opens connection to a server
Disconnect( )	Closes all open connections
Ping( )	Ping the server to see if it exists Warning: Source engine may not answer to this
GetInfo( )	Returns server info in an array
GetPlayers( )	Returns players on the server in an array
GetRules( )	Returns public rules (cvars) in an array
SetRconPassword( $Password )	Sets rcon password for later use with Rcon()
Rcon( $Command )	Execute rcon command on the server

Also refer to an example to work things out.

License

PHP Source Query
Copyright (C) 2012-2015 Pavel Djundik

This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA