README

GameQ is a PHP library that allows you to query multiple types of multiplayer game & voice servers at the same time.

This repository is a maintained fork of Austinb/GameQ by Krymo Software. While we don't plan to add new games for now, we'll ensure compatibility with the latest PHP versions and fix issues as they arise.

Requirements

PHP 8.1+ - Tested in PHP 8.1, 8.2 and 8.3
Bzip2 - Used for A2S compressed responses

Installation

Composer

This method assumes you already have composer installed and working properly. Add krymosoftware/gameq as a requirement to composer.json by using composer require krymosoftware/gameq:^4.0.0 or by manually adding the following to the composer.json file in the require section:

"krymosoftware/gameq": "^4.0.0"

Update your packages with composer update or install with composer install.

Standalone Library

Download the latest version of the library and unpack it into your project. Add the following to your bootstrap file:

require_once('/path/to/src/GameQ/Autoloader.php');

The Autoloader.php file provides the same autoloading functionality as the Composer installation.

Example

$GameQ = new \GameQ\GameQ();
$GameQ->addServer([
    'type' => 'css',
    'host' => '127.0.0.1:27015',
]);
$results = $GameQ->process();

Need more? See Examples.

Contributing

Please see CONTRIBUTING for details.

License

See LICENSE for more information

Third Party Provider

dev.tkirch.wsc.gameq - Provides this library as a plugin to WoltLab Suite™ Core.

krymosoftware / gameq

Maintainers

Details