PHP library to query and send RCON commands to servers based on "Source Engine Query" protocol

Fund package maintenance!

Installs: 57 389

Dependents: 3

Suggesters: 0

Security: 0

Stars: 496

Watchers: 56

Forks: 150

2.1.0 2020-12-04 08:20 UTC

This package is auto-updated.

Last update: 2021-12-29 09:07:05 UTC


Packagist Downloads Packagist Version

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.

⚠️ Do not send me emails if this does not work for you, I will not help you.


Protocol Specifications

Supported Games

AppID Game Query RCON Notes
~ All HL1/HL2 games and mods
10 Counter-Strike 1.6
440 Team Fortress 2
550 Left 4 Dead 2
730 Counter-Strike: Global Offensive host_name_store 1; host_info_show 2; host_players_show 2
1002 Rag Doll Kung Fu
2400 The Ship
4000 Garry's Mod
17710 Nuclear Dawn
70000 Dino D-Day
107410 Arma 3 Add +1 to the server port
115300 Call of Duty: Modern Warfare 3
211820 Starbound Call SetUseOldGetChallengeMethod method after connecting
244850 Space Engineers Add +1 to the server port
304930 Unturned Add +1 to the server port
251570 7 Days to Die
252490 Rust
282440 Quake Live Quake Live uses the ZMQ messaging queue protocol for rcon control.
346110 ARK: Survival Evolved
~ Minecraft

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.


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 examples folder to work things out.


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
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