Note: Most things are down at the moment, but you can still access the svn repo @ http://www.terragate.net/svn/gameservermodule/ (Some details can be found on the gsQuery home page).

I have bundled a snapshot of the current trunk of the module (including gsQuery) which can be downloaded here. Mail me if you have problems/questions.

Document updated 26-05-04

The beta 0.1.0 has been released!

Details can be found here This PHPNuke module displays infos from game servers. It can query "Game Server Query Protocol" compatible servers (most of the available game servers support that protocol). Futhermore the protocol used by Halflife (and HL mods) and the protocol used by Quake III based games is also supported. This Gameserver module includes gsQuery, a PHP class for querying game servers which can be downloaded separatly here.

The current version of Gameserver is 0.0.4.
You can download it here and see it in action right here.

1. General Notes

Please send any suggestions, comments, patches and bug reports to the Forum on this site.


2. Supported Games

Currently the following games are supported:

Generally every game that supports the Gameserver Query protocol can be queried by this module. Unfortunately there are a couple of games that do not understand this protocol. This particularly concerns all games based on a Quake Engine (e.g. Quake I-III).
Halflife is supported since 0.0.2 and Quake III since 0.0.4.


3. Requirements



4. Basic Installaton

Simply copy the content of the html directory to your PHPNuke installation and go to the PHPNuke administration site. A new entry called 'Gameserver' should be there. Click on it. If no error message appears the module is ready for use. If the Gameserver module is unable to create its table, please add table creation rights to the db user PHPNuke is using.


5. Updating from previous versions

Please delete tables used by previous versions (e.g. nuke_gameserver if your prefix is nuke). If you do not want to enter your game servers again take a look at the gameserver.sql in the sql directory and alter your table accordingly if neccessary (you need to know SQL for this).


6. About the query port

If you want to add a server that is talking the gsqp (Game Server Query Protocol) you have to know the query port for it. Sometimes it can be hard to figure out that so, here is a small overview of games where the query port is known:

Unreal Tournamentqueryport=gameport+1 (e.g. 7777+1=7778)
Unreal Tournament 2003queryport=gameport+10 (e.g. 7777+10=7787)
Battlefield 1942Default queryport is 23000 (no rule found yet)
America's Armyqueryport=gameport+1 (e.g. 1716+1=1717)

In most cases you can use the same query port (or better: the same rule) for games based on the same engine, but not always e.g. Americas Army is based on the UT2003 Engine and is using gameport+1 (1716+1=1717) as the default query port (UT2003 has changed the default query port after the first patch from 7778 to 7787). If you figure out more query ports please let us know about it and post them to the mailing list.
In case of the Halflife (hlife) and the Quake III (q3a) protocol the query port is identicial to the game port.


7. Additional features

This module can display gamelogos and map thumbnails.

7.1 Game logos

If you want a game logo being displayed on the details page simply put a logo.png in Gameserver/images/$gamename. Where gamename is the "qameserver query protocol" name (e.g. ut2003 has ut2 and battlefield has bfield1942).
Logos for UT2003 and Battlefield 1942 are included in this package. If you have other logos you can send me and I will include them in the next release.

7.1.1 Game names for Halflife mods

The gsqp name for Halflife is hlife_modname (e.g. hlife_cstrike for Counterstrike) .

7.1.2 Game names for other games

You can use The All Seeing Eye (a Gamespy like tool) to get the game name.

6.2 Map thumbnails

Simply put a Mapname.jpg in the Gameserver/images/$gamename directory. Currently there are no thumbnails included in this package (not enough time). But you can take the mapshot Packs from www.qtracker.com and simply extract them with unzip to the Gameserver/images/$gamename directory.
If you have free map shots please send it to me and I will include them in the next release.


8. Changelog

Changes in 0.0.4:

Changes in 0.0.3:

Changes in 0.0.2: