Robot
/
node-gamedig
mirror of https://github.com/gamedig/node-gamedig.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
node-gamedig/README.md

238 lines
8.8 KiB
Markdown
Raw Normal View History

initial commit
2013-07-10 12:02:48 +02:00
node-GameDig - Game Server Query Library
Update README.md
2014-02-01 09:39:06 +01:00
---
Explain what gamedig is in the readme
2014-02-02 03:10:52 +01:00
node-GameDig is a game server library, capable of querying for the status of
nearly any game server. If has a node.js api, as well as a command line interface.
initial commit
2013-07-10 12:02:48 +02:00
Super mega-commit 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.
2014-01-31 23:27:52 +01:00
Usage from Node.js
initial commit
2013-07-10 12:02:48 +02:00
---
Attempt to fix readme on npm
2013-07-11 11:25:49 +02:00
```shell
Add install instructions
2013-07-10 14:23:18 +02:00
npm install gamedig
```
initial commit
2013-07-10 12:02:48 +02:00
```javascript
var Gamedig = require('gamedig');
Add install instructions
2013-07-10 14:23:18 +02:00
Gamedig.query(
{
type: 'minecraft',
host: 'mc.example.com'
},
function(state) {
initial commit
2013-07-10 12:02:48 +02:00
if(state.error) console.log("Server is offline");
else console.log(state);
}
Add install instructions
2013-07-10 14:23:18 +02:00
);
initial commit
2013-07-10 12:02:48 +02:00
```
Include note about cloning from trunk
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"
> ```
Readme formatting
2013-07-12 11:18:55 +02:00
### Input Parameters
Super mega-commit 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.
2014-01-31 23:27:52 +01:00
* **type**: One of the game IDs listed in the game list below
Readme formatting
2013-07-12 11:18:55 +02:00
* **host**
Clarification about input
2013-07-12 11:20:17 +02:00
* **port**: (optional) Uses the protocol default if not set
clarify notes input
2013-07-12 11:23:40 +02:00
* **notes**: (optional) Passed through to output
Readme formatting
2013-07-12 11:18:55 +02:00
###Callback Function
Document input parameters
2013-07-12 11:15:11 +02:00
Massive revamp for standardization of output
2013-07-12 11:12:02 +02:00
The callback function is "guaranteed" to be called exactly once.
Change to callback method
2013-07-10 12:06:44 +02:00
Massive revamp for standardization of output
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.
Fix typo
2013-07-12 11:12:55 +02:00
Otherwise, the returned object is guaranteed to contain the following keys:
initial commit
2013-07-10 12:02:48 +02:00
Change readme to clarify a stable API
2013-07-12 15:29:25 +02:00
**Stable, always present:**
Fix markdown on npm directory
2013-07-12 15:33:57 +02:00
Readme formatting
2013-07-12 11:18:55 +02:00
* **name**
* **map**
* **password**: Boolean
* **maxplayers**
Change readme to clarify a stable API
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
Readme formatting
2013-07-12 11:18:55 +02:00
* **notes**: Passed through from the input
Change readme to clarify a stable API
2013-07-12 15:29:25 +02:00
**Unstable, not guaranteed:**
Fix markdown on npm directory
2013-07-12 15:33:57 +02:00
Change readme to clarify a stable API
2013-07-12 15:29:25 +02:00
* **raw**: Contains all information received from the server
Readme formatting
2013-07-12 11:18:55 +02:00
* **query**: Details about the query performed
Update readme with new games
2013-07-11 11:13:39 +02:00
Massive revamp for standardization of output
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.
initial commit
2013-07-10 12:02:48 +02:00
Supported Games
---
Update tshock support for terraria 1.2
2013-10-12 08:43:16 +02:00
Add tons and tons of games and protocols
2014-02-01 16:48:01 +01:00
* Age of Chivalry (ageofchivalry)
Super mega-commit 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.
2014-01-31 23:27:52 +01:00
* Alien Swarm (alienswarm)
Super epic commit 2 Added pretty much every game ever Tons of new protocols and game definitions Cleaned up and discovered some new tricks in gamespy3 and quake2
2014-02-02 00:46:10 +01:00
* Aliens vs Predator 2 (avp2)
Add tons and tons of games and protocols
2014-02-01 16:48:01 +01:00
* America's Army 1 (americasarmy) [[Separate Query Port - Usually port+1](#separate-query-port)]
* America's Army 2 (americasarmy2) [[Separate Query Port - Usually port+1](#separate-query-port)]
* America's Army 3 (americasarmy3) [[Separate Query Port - Usually 27020](#separate-query-port)]
* America's Army: Proving Grounds (americasarmypg) [[Separate Query Port - Usually 27020](#separate-query-port)]
* ArmA Armed Assault 1 (arma)
* ArmA Armed Assault 2 (arma2)
* ArmA Armed Assault 3 (arma3)
Super mega-commit 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.
2014-01-31 23:27:52 +01:00
* Armagetron (armagetron)
Add tons and tons of games and protocols
2014-02-01 16:48:01 +01:00
* Battlefield 1942 (bf1942) [[Separate Query Port - Usually 23000](#separate-query-port)]
* Battlefield 2 (bf2) [[Separate Query Port - Usually 29900](#separate-query-port)]
Super epic commit 2 Added pretty much every game ever Tons of new protocols and game definitions Cleaned up and discovered some new tricks in gamespy3 and quake2
2014-02-02 00:46:10 +01:00
* Battlefield 3 (bf3) [[Separate Query Port - Usually port+22000](#separate-query-port)]
* Battlefield 4 (bf4) [[Separate Query Port - Usually port+22000](#separate-query-port)]
* Battlefield: Bad Company 2 (bfbc2) [[Separate Query Port - Usually 48888](#separate-query-port)]
* Battlefield: Vietnam (bfv) [[Separate Query Port - Usually 48888](#separate-query-port)]
Add tons and tons of games and protocols
2014-02-01 16:48:01 +01:00
* Brink (brink) [[Separate Query Port - Usually port+1](#separate-query-port)]
Super mega-commit 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.
2014-01-31 23:27:52 +01:00
* Build and Shoot (buildandshoot)
Super epic commit 2 Added pretty much every game ever Tons of new protocols and game definitions Cleaned up and discovered some new tricks in gamespy3 and quake2
2014-02-02 00:46:10 +01:00
* Call of Duty (cod)
* Call of Duty 2 (cod2)
* Call of Duty 4 (cod4)
* Call of Duty: Modern Warfare 3 (codmw3) [[Separate Query Port - Usually port+2](#separate-query-port)]
* Call of Duty: United Offensive (coduo)
* Call of Duty: World at War (codwaw)
Super mega-commit 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.
2014-01-31 23:27:52 +01:00
* Counter-Strike 1.6 (cs16)
Super epic commit 2 Added pretty much every game ever Tons of new protocols and game definitions Cleaned up and discovered some new tricks in gamespy3 and quake2
2014-02-02 00:46:10 +01:00
* Counter-Strike: Condition Zero (cscz)
Super mega-commit 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.
2014-01-31 23:27:52 +01:00
* Counter-Strike: Source (css)
* Counter-Strike: Global Offensive (csgo)
Super epic commit 2 Added pretty much every game ever Tons of new protocols and game definitions Cleaned up and discovered some new tricks in gamespy3 and quake2
2014-02-02 00:46:10 +01:00
* Crysis (crysis)
* Crysis 2 (crysis2)
* Crysis Wars (crysiswars)
* Darkest Hour (darkesthour) [[Separate Query Port - Usually port+1](#separate-query-port)]
* Day of Defeat (dod)
* Day of Defeat: Source (dods)
* DayZ (dayz) [[Separate Query Port - Usually 27016-27020](#separate-query-port)]
Super mega-commit 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.
2014-01-31 23:27:52 +01:00
* Dino D-Day (dinodday)
Super epic commit 2 Added pretty much every game ever Tons of new protocols and game definitions Cleaned up and discovered some new tricks in gamespy3 and quake2
2014-02-02 00:46:10 +01:00
* Doom 3 (doom3)
* DOTA 2 (dota2)
* Enemy Territory Quake Wars (etqw)
* F.E.A.R. (fear)
* Fortress Forever (fortressforever)
* Frontlines: Fuel of War (ffow)
Super mega-commit 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.
2014-01-31 23:27:52 +01:00
* Garry's Mod (garrysmod)
Super epic commit 2 Added pretty much every game ever Tons of new protocols and game definitions Cleaned up and discovered some new tricks in gamespy3 and quake2
2014-02-02 00:46:10 +01:00
* Ghost Recon: Advanced Warfighter (graw)
* Ghost Recon: Advanced Warfighter 2 (graw2)
* Gore (gore)
* Half-Life 1 Deathmatch (hldm)
* Half-Life 2 Deathmatch (hl2dm)
* Halo (halo)
Super mega-commit 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.
2014-01-31 23:27:52 +01:00
* The Hidden: Source (hidden)
Super epic commit 2 Added pretty much every game ever Tons of new protocols and game definitions Cleaned up and discovered some new tricks in gamespy3 and quake2
2014-02-02 00:46:10 +01:00
* Homefront (homefront)
* Insurgency (insurgency)
* Just Cause 2 Multiplayer (jc2mp)
Super mega-commit 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.
2014-01-31 23:27:52 +01:00
* Killing Floor (killingfloor)
* KzMod (kzmod)
* Left 4 Dead (left4dead)
* Left 4 Dead 2 (left4dead2)
Super epic commit 2 Added pretty much every game ever Tons of new protocols and game definitions Cleaned up and discovered some new tricks in gamespy3 and quake2
2014-02-02 00:46:10 +01:00
* Mafia 2 Multiplayer (m2mp) [[Separate Query Port - Usually port+1](#separate-query-port)]
* Medal of Honor: Allied Assault (mohaa) [[Separate Query Port - Usually port+97](#separate-query-port)]
* Medal of Honor: Spearhead (mohsh) [[Separate Query Port - Usually port+97](#separate-query-port)]
* Medal of Honor: Breakthrough (mohbt) [[Separate Query Port - Usually port+97](#separate-query-port)]
* Medal of Honor 2010 (moh2010) [[Separate Query Port - Usually 48888](#separate-query-port)]
* Medal of Honor: Warfighter (mohwf)
Update README.md
2014-02-01 09:38:40 +01:00
* Minecraft (minecraft) [[Additional Notes](#minecraft)]
Super epic commit 2 Added pretty much every game ever Tons of new protocols and game definitions Cleaned up and discovered some new tricks in gamespy3 and quake2
2014-02-02 00:46:10 +01:00
* Monday Night Combat (mnc)
* Multi Theft Auto [[Separate Query Port - Usually port+123](#separate-query-port)]
Add mumble support
2014-02-02 14:20:36 +01:00
* Mumble [[Additional Notes](#mumble)]
Super mega-commit 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.
2014-01-31 23:27:52 +01:00
* Mutant Factions (mutantfactions)
* Natural Selection (ns)
Add tons and tons of games and protocols
2014-02-01 16:48:01 +01:00
* Natural Selection 2 (ns2) [[Separate Query Port - Usually port+1](#separate-query-port)]
Super mega-commit 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.
2014-01-31 23:27:52 +01:00
* No More Room in Hell (nmrih)
* Nuclear Dawn (nucleardawn)
Super epic commit 2 Added pretty much every game ever Tons of new protocols and game definitions Cleaned up and discovered some new tricks in gamespy3 and quake2
2014-02-02 00:46:10 +01:00
* Prey (prey)
* Quake 1 (quake1)
Super mega-commit 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.
2014-01-31 23:27:52 +01:00
* Quake 2 (quake2)
* Quake 3 (quake3)
Super epic commit 2 Added pretty much every game ever Tons of new protocols and game definitions Cleaned up and discovered some new tricks in gamespy3 and quake2
2014-02-02 00:46:10 +01:00
* Quake 4 (quake4)
* Red Orchestra: Ostfront 41-45 (redorchestraost) [[Separate Query Port - Usually port+10](#separate-query-port)]
* Red Orchestra 2 (redorchestra2) [[Separate Query Port - Usually 27015](#separate-query-port)]
* Return to Castle Wolfenstein (rtcw)
Super mega-commit 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.
2014-01-31 23:27:52 +01:00
* Ricochet (ricochet)
* Rust (rust)
* The Ship (ship)
Update README.md
2014-02-01 09:38:40 +01:00
* ShootMania (shootmania) [[Additional Notes](#nadeo-shootmania--trackmania--etc)]
Super epic commit 2 Added pretty much every game ever Tons of new protocols and game definitions Cleaned up and discovered some new tricks in gamespy3 and quake2
2014-02-02 00:46:10 +01:00
* Soldier of Fortune 2 (sof2)
* Star Wars: Battlefront 2 (swbf2)
* Star Wars: Jedi Knight (swjk)
* Star Wars: Jedi Knight 2 (swjk2)
Super mega-commit 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.
2014-01-31 23:27:52 +01:00
* Starbound (starbound)
* Suicide Survival (suicidesurvival)
Super epic commit 2 Added pretty much every game ever Tons of new protocols and game definitions Cleaned up and discovered some new tricks in gamespy3 and quake2
2014-02-02 00:46:10 +01:00
* SWAT 4 (swat4) [[Separate Query Port - Usually port+2](#separate-query-port)]
Super mega-commit 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.
2014-01-31 23:27:52 +01:00
* Sven Coop (svencoop)
* Synergy (synergy)
* Team Fortress 2 (tf2)
Super epic commit 2 Added pretty much every game ever Tons of new protocols and game definitions Cleaned up and discovered some new tricks in gamespy3 and quake2
2014-02-02 00:46:10 +01:00
* Team Fortress Classic (tfc)
Add support for teamspeak 3
2014-02-02 13:55:28 +01:00
* Teamspeak 2 (teamspeak2)
* Teamspeak 3 (teamspeak3)
Update README.md
2014-02-01 09:38:40 +01:00
* Terraria (terraria) [[Additional Notes](#terraria)]
* TrackMania 2 (trackmania2) [[Additional Notes](#nadeo-shootmania--trackmania--etc)]
* TrackMania Forever (trackmaniaforever) [[Additional Notes](#nadeo-shootmania--trackmania--etc)]
Super epic commit 2 Added pretty much every game ever Tons of new protocols and game definitions Cleaned up and discovered some new tricks in gamespy3 and quake2
2014-02-02 00:46:10 +01:00
* Unreal Tournament (ut) [[Separate Query Port - Usually port+1](#separate-query-port)]
Fix issues with corrupt strings in unreal2 protocol
2014-02-02 03:04:41 +01:00
* Unreal Tournament 2004 (ut2004) [[Separate Query Port - Usually port+1](#separate-query-port)]
Super epic commit 2 Added pretty much every game ever Tons of new protocols and game definitions Cleaned up and discovered some new tricks in gamespy3 and quake2
2014-02-02 00:46:10 +01:00
* Unreal Tournament 3 (ut3) [[Separate Query Port - Usually 6500](#separate-query-port)]
Add the most annoying protocol of them all -- ventrilo
2014-02-02 18:09:58 +01:00
* Ventrilo (ventrilo)
Super mega-commit 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.
2014-01-31 23:27:52 +01:00
* Warsow (warsow)
Super epic commit 2 Added pretty much every game ever Tons of new protocols and game definitions Cleaned up and discovered some new tricks in gamespy3 and quake2
2014-02-02 00:46:10 +01:00
* Wolfenstein 2009 (wolfenstein2009)
* Wolfenstein: Enemy Territory (wolfensteinet)
* Zombie Master (zombiemaster)
* Zombie Panic: Source (zps)
Super mega-commit 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.
2014-01-31 23:27:52 +01:00
Don't see your game listed here?
Update README.md
2014-02-01 09:38:40 +01:00
Super mega-commit 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.
2014-01-31 23:27:52 +01:00
1. Let us know so we can fix it
Update README.md
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:
bump readme with new protocol types
2014-02-02 00:50:32 +01:00
* protocol-ase
* protocol-battlefield
* protocol-doom3
* protocol-gamespy1
* protocol-gamespy2
Update README.md
2014-02-01 09:38:40 +01:00
* protocol-gamespy3
* protocol-nadeo
* protocol-quake2
* protocol-quake3
* protocol-unreal2
* protocol-valve
* protocol-valvegold
### 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.
Add mumble support
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
Update README.md
2014-02-01 09:38:40 +01:00
#### Nadeo (ShootMania / TrackMania / etc)
Add tons and tons of games and protocols
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.
Update README.md
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
Super mega-commit 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.
2014-01-31 23:27:52 +01:00
Add tons and tons of games and protocols
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.
You must pass the query port to GameDig, not the connection port.
Super mega-commit 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.
2014-01-31 23:27:52 +01:00
Usage from Command Line
---
Update tshock support for terraria 1.2
2013-10-12 08:43:16 +02:00
Super mega-commit 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.
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
Update tshock support for terraria 1.2
2013-10-12 08:43:16 +02:00
```
Super mega-commit 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.
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
Update tshock support for terraria 1.2
2013-10-12 08:43:16 +02:00
```
Super mega-commit 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.
2014-01-31 23:27:52 +01:00
The output of the command will be in JSON format.