2013-07-10 12:02:48 +02:00
|
|
|
node-GameDig - Game Server Query Library
|
2014-02-01 09:39:06 +01:00
|
|
|
---
|
2014-02-03 01:16:12 +01:00
|
|
|
node-GameDig is a game server query library, capable of querying for the status of
|
|
|
|
|
nearly any game or voice server. If a server makes its status publically available,
|
|
|
|
|
GameDig can fetch it for you.
|
|
|
|
|
|
|
|
|
|
GameDig is available as a node.js module, as well as a
|
|
|
|
|
[command line executable](#usage-from-command-line).
|
2013-07-10 12:02:48 +02:00
|
|
|
|
2014-01-31 23:27:52 +01:00
|
|
|
Usage from Node.js
|
2013-07-10 12:02:48 +02:00
|
|
|
---
|
|
|
|
|
|
2013-07-11 11:25:49 +02:00
|
|
|
```shell
|
2013-07-10 14:23:18 +02:00
|
|
|
npm install gamedig
|
|
|
|
|
```
|
|
|
|
|
|
2013-07-10 12:02:48 +02:00
|
|
|
```javascript
|
|
|
|
|
var Gamedig = require('gamedig');
|
2013-07-10 14:23:18 +02:00
|
|
|
Gamedig.query(
|
|
|
|
|
{
|
|
|
|
|
type: 'minecraft',
|
|
|
|
|
host: 'mc.example.com'
|
|
|
|
|
},
|
|
|
|
|
function(state) {
|
2013-07-10 12:02:48 +02:00
|
|
|
if(state.error) console.log("Server is offline");
|
|
|
|
|
else console.log(state);
|
|
|
|
|
}
|
2013-07-10 14:23:18 +02:00
|
|
|
);
|
2013-07-10 12:02:48 +02:00
|
|
|
```
|
|
|
|
|
|
2014-02-02 13:06:22 +01:00
|
|
|
> Is NPM out of date? If you're feeling lucky, you can install the latest code with
|
|
|
|
|
> ```shell
|
|
|
|
|
> npm install "git+https://github.com/sonicsnes/node-gamedig.git"
|
|
|
|
|
> ```
|
|
|
|
|
|
2013-07-12 11:18:55 +02:00
|
|
|
### Input Parameters
|
|
|
|
|
|
2014-01-31 23:27:52 +01:00
|
|
|
* **type**: One of the game IDs listed in the game list below
|
2013-07-12 11:18:55 +02:00
|
|
|
* **host**
|
2013-07-12 11:20:17 +02:00
|
|
|
* **port**: (optional) Uses the protocol default if not set
|
2013-07-12 11:23:40 +02:00
|
|
|
* **notes**: (optional) Passed through to output
|
2013-07-12 11:18:55 +02:00
|
|
|
|
|
|
|
|
###Callback Function
|
2013-07-12 11:15:11 +02:00
|
|
|
|
2013-07-12 11:12:02 +02:00
|
|
|
The callback function is "guaranteed" to be called exactly once.
|
2013-07-10 12:06:44 +02:00
|
|
|
|
2013-07-12 11:12:02 +02:00
|
|
|
If an error occurs, the returned object will contain an "error" key, indicating the issue.
|
|
|
|
|
If the error key exists, it should be assumed that the game server is offline or unreachable.
|
|
|
|
|
|
2013-07-12 11:12:55 +02:00
|
|
|
Otherwise, the returned object is guaranteed to contain the following keys:
|
2013-07-10 12:02:48 +02:00
|
|
|
|
2013-07-12 15:29:25 +02:00
|
|
|
**Stable, always present:**
|
2013-07-12 15:33:57 +02:00
|
|
|
|
2013-07-12 11:18:55 +02:00
|
|
|
* **name**
|
|
|
|
|
* **map**
|
|
|
|
|
* **password**: Boolean
|
|
|
|
|
* **maxplayers**
|
2013-07-12 15:29:25 +02:00
|
|
|
* **players**: (array of objects) Each object **may** contain name, ping, score, team, address
|
|
|
|
|
* **bots**: Same schema as players
|
2013-07-12 11:18:55 +02:00
|
|
|
* **notes**: Passed through from the input
|
2013-07-12 15:29:25 +02:00
|
|
|
|
|
|
|
|
**Unstable, not guaranteed:**
|
2013-07-12 15:33:57 +02:00
|
|
|
|
2013-07-12 15:29:25 +02:00
|
|
|
* **raw**: Contains all information received from the server
|
2013-07-12 11:18:55 +02:00
|
|
|
* **query**: Details about the query performed
|
2013-07-11 11:13:39 +02:00
|
|
|
|
2013-07-12 11:12:02 +02:00
|
|
|
It can usually be assumed that the number of players online is equal to the length of the players array.
|
|
|
|
|
Some servers may return an additional player count number, which may be present in the unstable raw object.
|
2013-07-10 12:02:48 +02:00
|
|
|
|
|
|
|
|
Supported Games
|
|
|
|
|
---
|
2013-10-12 08:43:16 +02:00
|
|
|
|
2014-02-01 16:48:01 +01:00
|
|
|
* Age of Chivalry (ageofchivalry)
|
2014-02-03 21:00:51 +01:00
|
|
|
* Age of Empires 2 (aoe2) [[Separate Query Port](#separate-query-port)]
|
2014-02-03 23:21:09 +01:00
|
|
|
* Alien Arena (alienarena) [[Separate Query Port](#separate-query-port)]
|
2014-01-31 23:27:52 +01:00
|
|
|
* Alien Swarm (alienswarm)
|
2014-02-02 00:46:10 +01:00
|
|
|
* Aliens vs Predator 2 (avp2)
|
2014-02-03 21:00:51 +01:00
|
|
|
* Aliens vs Predator 2010 (avp2010)
|
|
|
|
|
* America's Army (americasarmy) [[Separate Query Port](#separate-query-port)]
|
|
|
|
|
* America's Army 2 (americasarmy2) [[Separate Query Port](#separate-query-port)]
|
|
|
|
|
* America's Army 3 (americasarmy3) [[Separate Query Port](#separate-query-port)]
|
|
|
|
|
* America's Army: Proving Grounds (americasarmypg) [[Separate Query Port](#separate-query-port)]
|
2014-02-01 16:48:01 +01:00
|
|
|
* ArmA Armed Assault 1 (arma)
|
|
|
|
|
* ArmA Armed Assault 2 (arma2)
|
|
|
|
|
* ArmA Armed Assault 3 (arma3)
|
2014-01-31 23:27:52 +01:00
|
|
|
* Armagetron (armagetron)
|
2014-02-03 21:00:51 +01:00
|
|
|
* Baldur's Gate (baldursgate) [[Separate Query Port](#separate-query-port)]
|
|
|
|
|
* Battlefield 1942 (bf1942) [[Separate Query Port](#separate-query-port)]
|
|
|
|
|
* Battlefield Vietnam (bfv) [[Separate Query Port](#separate-query-port)]
|
|
|
|
|
* Battlefield 2 (bf2) [[Separate Query Port](#separate-query-port)]
|
|
|
|
|
* Battlefield 2142 (bf2142) [[Separate Query Port](#separate-query-port)]
|
|
|
|
|
* Battlefield: Bad Company 2 (bfbc2) [[Separate Query Port](#separate-query-port)]
|
|
|
|
|
* Battlefield 3 (bf3) [[Separate Query Port](#separate-query-port)]
|
|
|
|
|
* Battlefield 4 (bf4) [[Separate Query Port](#separate-query-port)]
|
2014-02-02 21:28:46 +01:00
|
|
|
* Breach (breach)
|
2014-02-03 21:00:51 +01:00
|
|
|
* Breed (breed)
|
|
|
|
|
* Brink (brink) [[Separate Query Port](#separate-query-port)]
|
|
|
|
|
* Build and Shoot (buildandshoot) [[Separate Query Port](#separate-query-port)]
|
2014-02-02 00:46:10 +01:00
|
|
|
* Call of Duty (cod)
|
|
|
|
|
* Call of Duty: United Offensive (coduo)
|
2014-02-03 21:00:51 +01:00
|
|
|
* Call of Duty 2 (cod2)
|
|
|
|
|
* Call of Duty 3 (cod3)
|
|
|
|
|
* Call of Duty 4: Modern Warfare (cod4)
|
2014-02-02 00:46:10 +01:00
|
|
|
* Call of Duty: World at War (codwaw)
|
2014-02-03 21:00:51 +01:00
|
|
|
* Call of Duty: Modern Warfare 2 (codmw2)
|
|
|
|
|
* Call of Duty: Modern Warfare 3 (codmw3) [[Separate Query Port](#separate-query-port)]
|
|
|
|
|
* Call of Juarez (callofjuarez) [[Separate Query Port](#separate-query-port)]
|
|
|
|
|
* Chaser (chaser) [[Separate Query Port](#separate-query-port)]
|
|
|
|
|
* Chrome (chrome) [[Separate Query Port](#separate-query-port)]
|
2014-02-03 23:21:09 +01:00
|
|
|
* Codename Eagle (codenameeagle) [[Separate Query Port](#separate-query-port)]
|
|
|
|
|
* Commandos 3: Destination Berlin (commandos3) [[Separate Query Port](#separate-query-port)]
|
2014-02-03 21:00:51 +01:00
|
|
|
* Command and Conquer: Renegade (cacrenegade) [[Separate Query Port](#separate-query-port)]
|
2014-02-03 23:21:09 +01:00
|
|
|
* Contact J.A.C.K. (contactjack) [[Separate Query Port](#separate-query-port)]
|
2014-01-31 23:27:52 +01:00
|
|
|
* Counter-Strike 1.6 (cs16)
|
2014-02-02 00:46:10 +01:00
|
|
|
* Counter-Strike: Condition Zero (cscz)
|
2014-01-31 23:27:52 +01:00
|
|
|
* Counter-Strike: Source (css)
|
|
|
|
|
* Counter-Strike: Global Offensive (csgo)
|
2014-02-03 21:00:51 +01:00
|
|
|
* Cross Racing Championship (crossracing) [[Separate Query Port](#separate-query-port)]
|
2014-02-02 00:46:10 +01:00
|
|
|
* Crysis (crysis)
|
|
|
|
|
* Crysis Wars (crysiswars)
|
2014-02-03 21:00:51 +01:00
|
|
|
* Crysis 2 (crysis2)
|
|
|
|
|
* Daikatana (daikatana) [[Separate Query Port](#separate-query-port)]
|
|
|
|
|
* Dark Messiah of Might and Magic (dmomam)
|
|
|
|
|
* Darkest Hour (darkesthour) [[Separate Query Port](#separate-query-port)]
|
|
|
|
|
* DayZ (dayz)
|
2014-02-03 23:21:09 +01:00
|
|
|
* Deadly Dozen: Pacific Theater (deadlydozenpt) [[Separate Query Port](#separate-query-port)]
|
2014-02-03 21:00:51 +01:00
|
|
|
* Deer Hunter 2005 (dh2005) [[Separate Query Port](#separate-query-port)]
|
|
|
|
|
* Descent 3 (descent3) [[Separate Query Port](#separate-query-port)]
|
|
|
|
|
* Deus Ex (deusex) [[Separate Query Port](#separate-query-port)]
|
|
|
|
|
* Devastation (devastation) [[Separate Query Port](#separate-query-port)]
|
|
|
|
|
* Dino D-Day (dinodday)
|
|
|
|
|
* Dirt Track Racing 2 (dirttrackracing2) [[Separate Query Port](#separate-query-port)]
|
2014-02-02 00:46:10 +01:00
|
|
|
* Day of Defeat (dod)
|
|
|
|
|
* Day of Defeat: Source (dods)
|
|
|
|
|
* Doom 3 (doom3)
|
|
|
|
|
* DOTA 2 (dota2)
|
2014-02-03 21:00:51 +01:00
|
|
|
* Drakan (drakan) [[Separate Query Port](#separate-query-port)]
|
|
|
|
|
* Enemy Territory Quake Wars (etqw) [[Separate Query Port](#separate-query-port)]
|
2014-02-03 23:21:09 +01:00
|
|
|
* F.E.A.R. (fear) [[Separate Query Port](#separate-query-port)]
|
|
|
|
|
* F1 2002 (f12002) [[Separate Query Port](#separate-query-port)]
|
|
|
|
|
* F1 Challenge 99-02 (f1c9902) [[Separate Query Port](#separate-query-port)]
|
2014-02-03 21:00:51 +01:00
|
|
|
* Far Cry (farcry) [[Separate Query Port](#separate-query-port)]
|
2014-02-03 23:21:09 +01:00
|
|
|
* Far Cry (farcry2) [[Separate Query Port](#separate-query-port)]
|
2014-02-02 00:46:10 +01:00
|
|
|
* Fortress Forever (fortressforever)
|
2014-02-03 21:00:51 +01:00
|
|
|
* Flashpoint (flashpoint) [[Separate Query Port](#separate-query-port)]
|
|
|
|
|
* Frontlines: Fuel of War (ffow) [[Separate Query Port](#separate-query-port)]
|
2014-01-31 23:27:52 +01:00
|
|
|
* Garry's Mod (garrysmod)
|
2014-02-03 23:21:09 +01:00
|
|
|
* Ghost Recon: Advanced Warfighter (graw) [[Separate Query Port](#separate-query-port)]
|
|
|
|
|
* Ghost Recon: Advanced Warfighter 2 (graw2) [[Separate Query Port](#separate-query-port)]
|
|
|
|
|
* Giants: Citizen Kabuto (giantscitizenkabuto) [[Separate Query Port](#separate-query-port)]
|
|
|
|
|
* Global Operations (globaloperations) [[Separate Query Port](#separate-query-port)]
|
2014-02-03 21:00:51 +01:00
|
|
|
* Gore (gore) [[Separate Query Port](#separate-query-port)]
|
|
|
|
|
* Gunman Chronicles (gunmanchronicles)
|
2014-02-02 00:46:10 +01:00
|
|
|
* Half-Life 1 Deathmatch (hldm)
|
|
|
|
|
* Half-Life 2 Deathmatch (hl2dm)
|
|
|
|
|
* Halo (halo)
|
2014-02-03 21:00:51 +01:00
|
|
|
* Halo 2 (halo2)
|
2014-02-03 23:21:09 +01:00
|
|
|
* Heretic 2 (heretic2) [[Separate Query Port](#separate-query-port)]
|
|
|
|
|
* Hexen World (hexenworld) [[Separate Query Port](#separate-query-port)]
|
2014-01-31 23:27:52 +01:00
|
|
|
* The Hidden: Source (hidden)
|
2014-02-03 21:00:51 +01:00
|
|
|
* Hidden and Dangerous 2 (had2) [[Separate Query Port](#separate-query-port)]
|
2014-02-02 00:46:10 +01:00
|
|
|
* Homefront (homefront)
|
2014-02-03 23:21:09 +01:00
|
|
|
* Homeworld 2 (homeworld2) [[Separate Query Port](#separate-query-port)]
|
|
|
|
|
* IGI-2: Covert Strike (igi2) [[Separate Query Port](#separate-query-port)]
|
|
|
|
|
* IL-2 Sturmovik (il2) [[Separate Query Port](#separate-query-port)]
|
2014-02-02 00:46:10 +01:00
|
|
|
* Insurgency (insurgency)
|
2014-02-03 23:21:09 +01:00
|
|
|
* Iron Storm (ironstorm) [[Separate Query Port](#separate-query-port)]
|
|
|
|
|
* James Bond: Nightfire (jamesbondnightfire) [[Separate Query Port](#separate-query-port)]
|
2014-02-02 00:46:10 +01:00
|
|
|
* Just Cause 2 Multiplayer (jc2mp)
|
2014-02-03 21:00:51 +01:00
|
|
|
* Killing Floor (killingfloor) [[Separate Query Port](#separate-query-port)]
|
|
|
|
|
* Kingpin: Life of Crime (kingpin) [[Separate Query Port](#separate-query-port)]
|
|
|
|
|
* KISS Psycho Circus (kisspc) [[Separate Query Port](#separate-query-port)]
|
2014-01-31 23:27:52 +01:00
|
|
|
* KzMod (kzmod)
|
|
|
|
|
* Left 4 Dead (left4dead)
|
|
|
|
|
* Left 4 Dead 2 (left4dead2)
|
2014-02-03 21:00:51 +01:00
|
|
|
* Mafia 2 Multiplayer (m2mp) [[Separate Query Port](#separate-query-port)]
|
|
|
|
|
* Medal of Honor: Allied Assault (mohaa) [[Separate Query Port](#separate-query-port)]
|
|
|
|
|
* Medal of Honor: Pacific Assault (mohpa) [[Separate Query Port](#separate-query-port)]
|
|
|
|
|
* Medal of Honor: Airborne (mohab) [[Separate Query Port](#separate-query-port)]
|
|
|
|
|
* Medal of Honor: Spearhead (mohsh) [[Separate Query Port](#separate-query-port)]
|
|
|
|
|
* Medal of Honor: Breakthrough (mohbt) [[Separate Query Port](#separate-query-port)]
|
|
|
|
|
* Medal of Honor 2010 (moh2010) [[Separate Query Port](#separate-query-port)]
|
|
|
|
|
* Medal of Honor: Warfighter (mohwf) [[Separate Query Port](#separate-query-port)]
|
|
|
|
|
* Minecraft (minecraft)
|
|
|
|
|
* Minecraft (minecraftping)
|
|
|
|
|
* Monday Night Combat (mnc) [[Separate Query Port](#separate-query-port)]
|
|
|
|
|
* Multi Theft Auto: Vice City (mtavc) [[Separate Query Port](#separate-query-port)]
|
|
|
|
|
* Multi Theft Auto: San Andreas (mtasa) [[Separate Query Port](#separate-query-port)]
|
|
|
|
|
* Mumble (mumble) [[Separate Query Port](#separate-query-port)]
|
|
|
|
|
* Mumble (mumbleping)
|
2014-01-31 23:27:52 +01:00
|
|
|
* Mutant Factions (mutantfactions)
|
2014-02-03 23:21:09 +01:00
|
|
|
* Nascar Thunder 2004 (nascarthunder2004) [[Separate Query Port](#separate-query-port)]
|
2014-02-03 21:00:51 +01:00
|
|
|
* netPanzer (netpanzer)
|
2014-01-31 23:27:52 +01:00
|
|
|
* No More Room in Hell (nmrih)
|
2014-02-03 21:00:51 +01:00
|
|
|
* Natural Selection (ns)
|
|
|
|
|
* Natural Selection 2 (ns2) [[Separate Query Port](#separate-query-port)]
|
2014-02-03 23:21:09 +01:00
|
|
|
* Need for Speed: Hot Pursuit 2 (nfshp2) [[Separate Query Port](#separate-query-port)]
|
2014-02-03 21:00:51 +01:00
|
|
|
* Nerf Arena Blast (nab) [[Separate Query Port](#separate-query-port)]
|
2014-02-03 23:21:09 +01:00
|
|
|
* Neverwinter Nights (nwn) [[Separate Query Port](#separate-query-port)]
|
2014-02-03 21:00:51 +01:00
|
|
|
* Neverwinter Nights 2 (nwn2) [[Separate Query Port](#separate-query-port)]
|
2014-02-03 23:21:09 +01:00
|
|
|
* Nexuiz (nexuiz) [[Separate Query Port](#separate-query-port)]
|
|
|
|
|
* Nitro Family (nitrofamily) [[Separate Query Port](#separate-query-port)]
|
|
|
|
|
* No One Lives Forever (nolf) [[Separate Query Port](#separate-query-port)]
|
|
|
|
|
* No One Lives Forever 2 (nolf2) [[Separate Query Port](#separate-query-port)]
|
2014-01-31 23:27:52 +01:00
|
|
|
* Nuclear Dawn (nucleardawn)
|
2014-02-03 23:21:09 +01:00
|
|
|
* OpenArena (openarena) [[Separate Query Port](#separate-query-port)]
|
2014-02-03 21:00:51 +01:00
|
|
|
* Operation Flashpoint (operationflashpoint) [[Separate Query Port](#separate-query-port)]
|
|
|
|
|
* Painkiller (painkiller) [[Separate Query Port](#separate-query-port)]
|
|
|
|
|
* Postal 2 (postal2) [[Separate Query Port](#separate-query-port)]
|
2014-02-03 23:21:09 +01:00
|
|
|
* Prey (prey) [[Separate Query Port](#separate-query-port)]
|
2014-02-03 21:00:51 +01:00
|
|
|
* Quake 1: QuakeWorld (quake1)
|
2014-01-31 23:27:52 +01:00
|
|
|
* Quake 2 (quake2)
|
2014-02-03 21:00:51 +01:00
|
|
|
* Quake 3: Arena (quake3)
|
2014-02-02 00:46:10 +01:00
|
|
|
* Quake 4 (quake4)
|
2014-02-03 21:00:51 +01:00
|
|
|
* Rag Doll Kung Fu (ragdollkungfu)
|
2014-02-03 23:21:09 +01:00
|
|
|
* Rainbow Six (r6) [[Separate Query Port](#separate-query-port)]
|
|
|
|
|
* Rainbow Six 2: Rogue Spear (r6roguespear) [[Separate Query Port](#separate-query-port)]
|
|
|
|
|
* Rainbow Six 3: Raven Shield (r6ravenshield) [[Separate Query Port](#separate-query-port)]
|
|
|
|
|
* RalliSport Challenge (rallisportchallenge) [[Separate Query Port](#separate-query-port)]
|
|
|
|
|
* Rally Masters (rallymasters) [[Separate Query Port](#separate-query-port)]
|
2014-02-03 21:00:51 +01:00
|
|
|
* Red Orchestra (redorchestra) [[Separate Query Port](#separate-query-port)]
|
|
|
|
|
* Red Orchestra: Ostfront 41-45 (redorchestraost) [[Separate Query Port](#separate-query-port)]
|
|
|
|
|
* Red Orchestra 2 (redorchestra2) [[Separate Query Port](#separate-query-port)]
|
2014-02-03 23:21:09 +01:00
|
|
|
* Redline (redline) [[Separate Query Port](#separate-query-port)]
|
|
|
|
|
* Return to Castle Wolfenstein (rtcw) [[Separate Query Port](#separate-query-port)]
|
2014-01-31 23:27:52 +01:00
|
|
|
* Ricochet (ricochet)
|
2014-02-03 23:21:09 +01:00
|
|
|
* Rise of Nations (riseofnations) [[Separate Query Port](#separate-query-port)]
|
2014-02-03 21:00:51 +01:00
|
|
|
* Rune (rune) [[Separate Query Port](#separate-query-port)]
|
|
|
|
|
* Rust (rust) [[Separate Query Port](#separate-query-port)]
|
2014-03-29 15:34:12 +01:00
|
|
|
* San Andreas Multiplayer (samp) [[Separate Query Port](#separate-query-port)]
|
2014-02-03 21:00:51 +01:00
|
|
|
* Serious Sam (ss) [[Separate Query Port](#separate-query-port)]
|
|
|
|
|
* Serious Sam 2 (ss2)
|
|
|
|
|
* Shattered Horizon (shatteredhorizon)
|
2014-01-31 23:27:52 +01:00
|
|
|
* The Ship (ship)
|
2014-02-03 23:21:09 +01:00
|
|
|
* Shogo (shogo) [[Separate Query Port](#separate-query-port)]
|
2014-02-03 21:00:51 +01:00
|
|
|
* Shootmania (shootmania)
|
2014-02-03 23:21:09 +01:00
|
|
|
* SiN (sin) [[Separate Query Port](#separate-query-port)]
|
2014-02-03 21:00:51 +01:00
|
|
|
* SiN Episodes (sinep)
|
|
|
|
|
* Soldat (soldat) [[Separate Query Port](#separate-query-port)]
|
2014-02-03 23:21:09 +01:00
|
|
|
* Soldier of Fortune (sof) [[Separate Query Port](#separate-query-port)]
|
|
|
|
|
* Soldier of Fortune 2 (sof2) [[Separate Query Port](#separate-query-port)]
|
2014-02-03 21:00:51 +01:00
|
|
|
* S.T.A.L.K.E.R. (stalker) [[Separate Query Port](#separate-query-port)]
|
2014-02-03 23:21:09 +01:00
|
|
|
* Star Trek: Bridge Commander (stbc) [[Separate Query Port](#separate-query-port)]
|
|
|
|
|
* Star Trek: Voyager - Elite Force (stvef) [[Separate Query Port](#separate-query-port)]
|
|
|
|
|
* Star Trek: Voyager - Elite Force 2 (stvef2) [[Separate Query Port](#separate-query-port)]
|
|
|
|
|
* Star Wars: Battlefront (swbf) [[Separate Query Port](#separate-query-port)]
|
|
|
|
|
* Star Wars: Battlefront 2 (swbf2) [[Separate Query Port](#separate-query-port)]
|
|
|
|
|
* Star Wars: Jedi Knight (swjk) [[Separate Query Port](#separate-query-port)]
|
|
|
|
|
* Star Wars: Jedi Knight 2 (swjk2) [[Separate Query Port](#separate-query-port)]
|
2014-02-03 21:00:51 +01:00
|
|
|
* Star Wars: Republic Commando (swrc) [[Separate Query Port](#separate-query-port)]
|
2014-01-31 23:27:52 +01:00
|
|
|
* Starbound (starbound)
|
|
|
|
|
* Suicide Survival (suicidesurvival)
|
2014-02-03 21:00:51 +01:00
|
|
|
* SWAT 4 (swat4) [[Separate Query Port](#separate-query-port)]
|
2014-01-31 23:27:52 +01:00
|
|
|
* Sven Coop (svencoop)
|
|
|
|
|
* Synergy (synergy)
|
2014-02-03 21:00:51 +01:00
|
|
|
* Tactical Ops (tacticalops) [[Separate Query Port](#separate-query-port)]
|
2014-02-03 23:21:09 +01:00
|
|
|
* Team Factor (teamfactor) [[Separate Query Port](#separate-query-port)]
|
2014-02-02 00:46:10 +01:00
|
|
|
* Team Fortress Classic (tfc)
|
2014-02-03 21:00:51 +01:00
|
|
|
* Team Fortress 2 (tf2)
|
|
|
|
|
* Teamspeak 2 (teamspeak2) [[Separate Query Port](#separate-query-port)]
|
|
|
|
|
* Teamspeak 3 (teamspeak3) [[Separate Query Port](#separate-query-port)]
|
2014-02-03 23:21:09 +01:00
|
|
|
* Terminus (terminus) [[Separate Query Port](#separate-query-port)]
|
2014-02-03 21:00:51 +01:00
|
|
|
* Terraria (terraria) [[Separate Query Port](#separate-query-port)]
|
2014-02-03 23:21:09 +01:00
|
|
|
* Tony Hawk's Pro Skater 3 (thps3) [[Separate Query Port](#separate-query-port)]
|
|
|
|
|
* Tony Hawk's Pro Skater 4 (thps4) [[Separate Query Port](#separate-query-port)]
|
|
|
|
|
* Tony Hawk's Underground 2 (thu2) [[Separate Query Port](#separate-query-port)]
|
2014-02-03 21:00:51 +01:00
|
|
|
* Trackmania 2 (trackmania2)
|
|
|
|
|
* Trackmania Forever (trackmaniaforever)
|
2014-02-03 23:21:09 +01:00
|
|
|
* Tremulous (tremulous) [[Separate Query Port](#separate-query-port)]
|
2014-02-03 21:00:51 +01:00
|
|
|
* Tribes: Vengeance (tribesvengeance) [[Separate Query Port](#separate-query-port)]
|
2014-02-03 23:21:09 +01:00
|
|
|
* Tron 2.0 (tron20) [[Separate Query Port](#separate-query-port)]
|
|
|
|
|
* Turok 2 (turok2) [[Separate Query Port](#separate-query-port)]
|
2014-02-03 21:00:51 +01:00
|
|
|
* Universal Combat (universalcombat) [[Separate Query Port](#separate-query-port)]
|
|
|
|
|
* Unreal (unreal) [[Separate Query Port](#separate-query-port)]
|
|
|
|
|
* Unreal Tournament (ut) [[Separate Query Port](#separate-query-port)]
|
|
|
|
|
* Unreal Tournament 2003 (ut2003) [[Separate Query Port](#separate-query-port)]
|
|
|
|
|
* Unreal Tournament 2004 (ut2004) [[Separate Query Port](#separate-query-port)]
|
|
|
|
|
* Unreal Tournament 3 (ut3) [[Separate Query Port](#separate-query-port)]
|
2014-02-03 23:21:09 +01:00
|
|
|
* Urban Terror (urbanterror) [[Separate Query Port](#separate-query-port)]
|
|
|
|
|
* V8 Supercar Challenge (v8supercar) [[Separate Query Port](#separate-query-port)]
|
2014-02-02 18:09:58 +01:00
|
|
|
* Ventrilo (ventrilo)
|
2014-02-03 21:00:51 +01:00
|
|
|
* Vietcong (vietcong) [[Separate Query Port](#separate-query-port)]
|
|
|
|
|
* Vietcong 2 (vietcong2) [[Separate Query Port](#separate-query-port)]
|
2014-01-31 23:27:52 +01:00
|
|
|
* Warsow (warsow)
|
2014-02-03 21:00:51 +01:00
|
|
|
* Wheel of Time (wheeloftime) [[Separate Query Port](#separate-query-port)]
|
2014-02-03 23:21:09 +01:00
|
|
|
* Wolfenstein 2009 (wolfenstein2009) [[Separate Query Port](#separate-query-port)]
|
|
|
|
|
* Wolfenstein: Enemy Territory (wolfensteinet) [[Separate Query Port](#separate-query-port)]
|
2014-02-03 21:00:51 +01:00
|
|
|
* Xpand Rally (xpandrally) [[Separate Query Port](#separate-query-port)]
|
2014-02-02 00:46:10 +01:00
|
|
|
* Zombie Master (zombiemaster)
|
|
|
|
|
* Zombie Panic: Source (zps)
|
2014-01-31 23:27:52 +01:00
|
|
|
|
|
|
|
|
Don't see your game listed here?
|
2014-02-01 09:38:40 +01:00
|
|
|
|
2014-01-31 23:27:52 +01:00
|
|
|
1. Let us know so we can fix it
|
2014-02-01 09:38:40 +01:00
|
|
|
1. You can try using some common query protocols directly by using one of these server types:
|
2014-02-02 00:50:32 +01:00
|
|
|
* protocol-ase
|
|
|
|
|
* protocol-battlefield
|
|
|
|
|
* protocol-doom3
|
|
|
|
|
* protocol-gamespy1
|
|
|
|
|
* protocol-gamespy2
|
2014-02-01 09:38:40 +01:00
|
|
|
* protocol-gamespy3
|
|
|
|
|
* protocol-nadeo
|
|
|
|
|
* protocol-quake2
|
|
|
|
|
* protocol-quake3
|
|
|
|
|
* protocol-unreal2
|
|
|
|
|
* protocol-valve
|
2014-02-03 21:00:51 +01:00
|
|
|
|
|
|
|
|
Games Not Supported (yet!)
|
|
|
|
|
---
|
2014-02-03 23:21:09 +01:00
|
|
|
|
|
|
|
|
* rFactor Engine (rfactor):
|
|
|
|
|
* rFactor
|
|
|
|
|
* Arca Sim Racing
|
|
|
|
|
* Cube Engine (cube):
|
|
|
|
|
* Cube 1
|
2014-02-03 21:00:51 +01:00
|
|
|
* Assault Cube
|
|
|
|
|
* Cube 2: Sauerbraten
|
2014-02-03 23:21:09 +01:00
|
|
|
* Blood Frontier
|
2014-02-03 21:00:51 +01:00
|
|
|
* BFRIS
|
|
|
|
|
* Counter-Strike 2D
|
|
|
|
|
* Freelancer
|
|
|
|
|
* Ghost Recon
|
|
|
|
|
* GTR2
|
|
|
|
|
* Haze
|
|
|
|
|
* Hexen 2
|
|
|
|
|
* OpenTTD
|
2014-02-03 23:21:09 +01:00
|
|
|
* Plain Sight
|
2014-02-03 21:00:51 +01:00
|
|
|
* Red Faction
|
|
|
|
|
* Savage: Battle for Newerth
|
|
|
|
|
* Savage 2: A Tortured Soul
|
|
|
|
|
* Sum of All Fears
|
|
|
|
|
* Teeworlds
|
2014-02-03 23:21:09 +01:00
|
|
|
* Tribes 1: Starsiege
|
2014-02-03 21:00:51 +01:00
|
|
|
* Tribes 2
|
2014-02-03 23:21:09 +01:00
|
|
|
* Vice City Multiplayer
|
2014-02-03 21:00:51 +01:00
|
|
|
* World in Conflict
|
|
|
|
|
|
2014-02-03 23:21:09 +01:00
|
|
|
> Want support for one of these games? Please open an issue to show your interest!
|
|
|
|
|
|
|
|
|
|
> __Know how to code?__ Protocols for the games above are documented
|
|
|
|
|
> in the /reference folder, ready for you to develop into GameDig!
|
|
|
|
|
|
|
|
|
|
Not Supported
|
|
|
|
|
---
|
|
|
|
|
* Call of Duty: Black Ops 1 and 2 (no documentation, may require rcon)
|
2014-02-01 09:38:40 +01:00
|
|
|
|
|
|
|
|
### Games with Additional Notes
|
|
|
|
|
|
|
|
|
|
#### Minecraft
|
|
|
|
|
Some minecraft servers may not respond to a typical status query. If this is the case, try using the
|
|
|
|
|
'minecraftping' server type instead, which uses a less accurate but more reliable solution.
|
|
|
|
|
|
2014-02-02 14:20:36 +01:00
|
|
|
#### Mumble
|
|
|
|
|
For full query results from Mumble, you must be running the
|
|
|
|
|
[GTmurmur plugin](http://www.gametracker.com/downloads/gtmurmurplugin.php).
|
|
|
|
|
If you do not wish to run the plugin, or do not require details such as channel and user lists,
|
|
|
|
|
you can use the 'mumbleping' server type instead, which uses a less accurate but more reliable solution
|
|
|
|
|
|
2014-02-01 09:38:40 +01:00
|
|
|
#### Nadeo (ShootMania / TrackMania / etc)
|
2014-02-01 16:48:01 +01:00
|
|
|
The server must have xmlrpc enabled, and you must pass the xmlrpc port to GameDig, not the connection port.
|
|
|
|
|
You must have a user account on the server with access level User or higher.
|
2014-02-01 09:38:40 +01:00
|
|
|
Pass the login into to GameDig with the additional options: login, password
|
|
|
|
|
|
|
|
|
|
#### Terraria
|
|
|
|
|
Requires tshock server mod, and a REST user token, which can be passed to GameDig with the
|
|
|
|
|
additional option: token
|
2014-01-31 23:27:52 +01:00
|
|
|
|
2014-02-01 16:48:01 +01:00
|
|
|
#### Separate Query Port
|
|
|
|
|
Games with this note use a query port which is usually not the same as the game's connection port.
|
2014-02-03 21:00:51 +01:00
|
|
|
Usually, no action will be required from you. The 'port' option you pass GameDig should be the game's
|
|
|
|
|
connection port. GameDig will attempt to calculate the query port automatically. If the query still fails,
|
|
|
|
|
you may need to pass the 'port_query' option to GameDig as well, indicating the separate query port.
|
2014-02-01 16:48:01 +01:00
|
|
|
|
2014-01-31 23:27:52 +01:00
|
|
|
Usage from Command Line
|
|
|
|
|
---
|
2013-10-12 08:43:16 +02:00
|
|
|
|
2014-01-31 23:27:52 +01:00
|
|
|
Want to integrate server queries from a batch script or other programming language?
|
|
|
|
|
You'll still need npm to install gamedig:
|
|
|
|
|
```shell
|
|
|
|
|
npm install gamedig -g
|
2013-10-12 08:43:16 +02:00
|
|
|
```
|
2014-01-31 23:27:52 +01:00
|
|
|
|
|
|
|
|
After installing gamedig globally, you can call gamedig via the command line
|
|
|
|
|
using the same parameters mentioned in the API above:
|
|
|
|
|
```shell
|
|
|
|
|
gamedig --type minecraft --host mc.example.com --port 11234
|
2013-10-12 08:43:16 +02:00
|
|
|
```
|
|
|
|
|
|
2014-01-31 23:27:52 +01:00
|
|
|
The output of the command will be in JSON format.
|
