tribufu/node-gamedig
1
0
Fork 0
mirror of https://github.com/tribufu/node-gamedig synced 2026-06-01 09:42:41 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Super mega-commit

Browse source 
Organize files
Rewrite readme for new game IDs and command line
Add command line access
Replace some dependencies that required binaries with simpler alternatives
Switch gbxremote back to upstream, Closes #2
Moved simple aliases into an alias file, rather than seperate files for each
Patched nearly every protocol variant with tons of bug fixes
Re-tested every combination of server and protocol types except nadeo
Added alternative minecraft query check (minecraftping)
Fixed mutant factions query
Fixed valve gold not working at all
Stripped colors more reliably from protocols that support colors
Added a couple more fields to ut2004 and killing floor
and more that I probably forgot.

This shouldn't break compatibility too bad -- at the most, some game IDs may have changed.
This commit is contained in:
Michael Morrison 2014-01-31 16:27:52 -06:00
parent a89fb7bbdf
commit c82554ad1a
31 changed files with 573 additions and 135 deletions
Download patch file Download diff file Expand all files Collapse all files

115
README.md
View file

@ -1,7 +1,7 @@
node-GameDig - Game Server Query Library
---
Usage
Usage from Node.js
---
```shell
@ -24,7 +24,7 @@ Gamedig.query(
### Input Parameters
* **type**: One of the types from the protocols folder
* **type**: One of the game IDs listed in the game list below
* **host**
* **port**: (optional) Uses the protocol default if not set
* **notes**: (optional) Passed through to output
@ -59,45 +59,84 @@ Some servers may return an additional player count number, which may be present
Supported Games
---
###Armagetron
###Gamespy 3 Protocol
* Minecraft
* Unreal Tournament 3
###GoldSrc Engine
* Half Life: Death Match
* Ricochet
* Counter-Strike: 1.6
* \+ others
###Nadeo Protocol
* Alien Swarm (alienswarm)
* Armagetron (armagetron)
* Build and Shoot (buildandshoot)
* Counter-Strike 1.6 (cs16)
* Counter-Strike: Source (css)
* Counter-Strike: Global Offensive (csgo)
* Dino D-Day (dinodday)
* Garry's Mod (garrysmod)
* The Hidden: Source (hidden)
* Just Cause Multiplayer (jcmp)
* Killing Floor (killingfloor)
* KzMod (kzmod)
* Left 4 Dead (left4dead)
* Left 4 Dead 2 (left4dead2)
* Minecraft (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.
```
* Mutant Factions (mutantfactions)
* Natural Selection (ns)
* Natural Selection 2 (ns2)
* No More Room in Hell (nmrih)
* Nuclear Dawn (nucleardawn)
* Quake 2 (quake2)
* Quake 3 (quake3)
* Ricochet (ricochet)
* Rust (rust)
* The Ship (ship)
* ShootMania (shootmania)
```
Requires additional parameters: login, password
```
* Trackmania Forever
* Trackmania 2
* Shootmania
###Quake 2 Protocol
* Quake 2
###Quake 3 Protocol
* Quake 3 Arena
* Quake 3 Team Arena
* Warsow
###Source Engine
* Counter-Strike: Source
* Counter-Strike: Global Offensive
* Team Fortress 2
* \+ others
###Terraria (tshock)
* Starbound (starbound)
* Suicide Survival (suicidesurvival)
* Sven Coop (svencoop)
* Synergy (synergy)
* Team Fortress 2 (tf2)
* Terraria (terraria)
```
Requires additional parameter: token
Requires tshock server mod, and an additional parameter: token
```
* TrackMania 2 (trackmania2)
```
Requires additional parameters: login, password
```
* TrackMania Forever (trackmaniaforever)
```
Requires additional parameters: login, password
```
* Unreal Tournament 2004 (ut2004)
* Unreal Tournament 3 (ut3)
* Warsow (warsow)
Don't see your game listed here?
1. Let us know so we can fix it
2. You can try using some common query protocols directly by using one of these server types:
* protocol-gamespy3
* protocol-nadeo
* protocol-quake2
* protocol-quake3
* protocol-unreal2
* protocol-valve
* protocol-valvegold
Usage from Command Line
---
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
```
###Unreal 2 Protocol
* Killing Floor
* Unreal Tournament 2004
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
```
The output of the command will be in JSON format.