Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
:elephant: PHP library to query servers that implement Source Engine Query protocol
PHP
Branch: master

README.md

PHP Source Query Packagist

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

Supported Games

AppID Game Query RCON Notes
~ All HL1/HL2 games and mods :white_check_mark: :white_check_mark:
10 Counter-Strike 1.6 :white_check_mark: :white_check_mark:
730 Counter-Strike: Global Offensive :white_check_mark: :white_check_mark:
440 Team Fortress 2 :white_check_mark: :white_check_mark:
550 Left 4 Dead 2 :white_check_mark: :white_check_mark:
1002 Rag Doll Kung Fu :white_check_mark: :white_check_mark:
2400 The Ship :white_check_mark: :white_check_mark:
4000 Garry's Mod :white_check_mark: :white_check_mark:
17710 Nuclear Dawn :white_check_mark: :white_check_mark:
70000 Dino D-Day :white_check_mark: :white_check_mark:
107410 Arma 3 :white_check_mark: :white_check_mark: Add +1 to the server port
115300 Call of Duty: Modern Warfare 3 :white_check_mark: :white_check_mark:
211820 Starbound :white_check_mark: :white_check_mark: Call SetUseOldGetChallengeMethod method after connecting
252490 Rust :white_check_mark: :white_check_mark: Add +1 to the server port
Minecraft :x: :white_check_mark:

Open a pull request if you know another game which supports Source Query and/or RCON protocols.

How to tell if the game supports Source Query Protocol?

Add your server to your favourites in Steam server browser, and if Steam can display information about your server, then the protocol is supported.

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
Something went wrong with that request. Please try again.