Robot/node-gamedig
1
0
Fork 0
mirror of https://github.com/gamedig/node-gamedig.git synced 2024-09-29 13:41:31 +02:00
Code Issues Packages Projects Releases Wiki Activity
09d9b87ad6
node-gamedig/README.md

392 lines
15 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
---
Bump readme
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).
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 epic commit 3 Move everything around Add another 50 or so games *** 'port' option should now be CONNECT port, not query port *** add reference for many missing games
2014-02-03 21:00:51 +01:00
* Age of Empires 2 (aoe2) [[Separate Query Port](#separate-query-port)]
* Alien Arena (alienarena)
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)
Super epic commit 3 Move everything around Add another 50 or so games *** 'port' option should now be CONNECT port, not query port *** add reference for many missing games
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)]
Add tons and tons of games and protocols
2014-02-01 16:48:01 +01:00
* 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)
Super epic commit 3 Move everything around Add another 50 or so games *** 'port' option should now be CONNECT port, not query port *** add reference for many missing games
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)]
Added a couple aliases
2014-02-02 21:28:46 +01:00
* Breach (breach)
Super epic commit 3 Move everything around Add another 50 or so games *** 'port' option should now be CONNECT port, not query port *** add reference for many missing games
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)]
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: United Offensive (coduo)
Super epic commit 3 Move everything around Add another 50 or so games *** 'port' option should now be CONNECT port, not query port *** add reference for many missing games
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)
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: World at War (codwaw)
Super epic commit 3 Move everything around Add another 50 or so games *** 'port' option should now be CONNECT port, not query port *** add reference for many missing games
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)]
* Codename Eagle (codenameeagle)
* Commandos 3: Destination Berlin (commandos3)
* Command and Conquer: Renegade (cacrenegade) [[Separate Query Port](#separate-query-port)]
* Contact J.A.C.K. (contactjack)
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 3 Move everything around Add another 50 or so games *** 'port' option should now be CONNECT port, not query port *** add reference for many missing games
2014-02-03 21:00:51 +01:00
* Cross Racing Championship (crossracing) [[Separate Query Port](#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
* Crysis (crysis)
* Crysis Wars (crysiswars)
Super epic commit 3 Move everything around Add another 50 or so games *** 'port' option should now be CONNECT port, not query port *** add reference for many missing games
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)
* Deadly Dozen: Pacific Theater (deadlydozenpt)
* 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)]
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
* Day of Defeat (dod)
* Day of Defeat: Source (dods)
* Doom 3 (doom3)
* DOTA 2 (dota2)
Super epic commit 3 Move everything around Add another 50 or so games *** 'port' option should now be CONNECT port, not query port *** add reference for many missing games
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)]
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
* F.E.A.R. (fear)
Super epic commit 3 Move everything around Add another 50 or so games *** 'port' option should now be CONNECT port, not query port *** add reference for many missing games
2014-02-03 21:00:51 +01:00
* F1 2002 (f12002)
* F1 Challenge 99-02 (f1c9902)
* Far Cry (farcry) [[Separate Query Port](#separate-query-port)]
* Far Cry (farcry2)
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
* Fortress Forever (fortressforever)
Super epic commit 3 Move everything around Add another 50 or so games *** 'port' option should now be CONNECT port, not query port *** add reference for many missing games
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)]
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)
Super epic commit 3 Move everything around Add another 50 or so games *** 'port' option should now be CONNECT port, not query port *** add reference for many missing games
2014-02-03 21:00:51 +01:00
* Giants: Citizen Kabuto (giantscitizenkabuto)
* Global Operations (globaloperations)
* Gore (gore) [[Separate Query Port](#separate-query-port)]
* Gunman Chronicles (gunmanchronicles)
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
* Half-Life 1 Deathmatch (hldm)
* Half-Life 2 Deathmatch (hl2dm)
* Halo (halo)
Super epic commit 3 Move everything around Add another 50 or so games *** 'port' option should now be CONNECT port, not query port *** add reference for many missing games
2014-02-03 21:00:51 +01:00
* Halo 2 (halo2)
* Heretic 2 (heretic2)
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 3 Move everything around Add another 50 or so games *** 'port' option should now be CONNECT port, not query port *** add reference for many missing games
2014-02-03 21:00:51 +01:00
* Hidden and Dangerous 2 (had2) [[Separate Query Port](#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
* Homefront (homefront)
Super epic commit 3 Move everything around Add another 50 or so games *** 'port' option should now be CONNECT port, not query port *** add reference for many missing games
2014-02-03 21:00:51 +01:00
* Homeworld 2 (homeworld2)
* IGI-2: Covert Strike (igi2)
* IL-2 Sturmovik (il2)
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
* Insurgency (insurgency)
Super epic commit 3 Move everything around Add another 50 or so games *** 'port' option should now be CONNECT port, not query port *** add reference for many missing games
2014-02-03 21:00:51 +01:00
* Iron Storm (ironstorm)
* James Bond: Nightfire (jamesbondnightfire)
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
* Just Cause 2 Multiplayer (jc2mp)
Super epic commit 3 Move everything around Add another 50 or so games *** 'port' option should now be CONNECT port, not query port *** add reference for many missing games
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)]
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
* KzMod (kzmod)
* Left 4 Dead (left4dead)
* Left 4 Dead 2 (left4dead2)
Super epic commit 3 Move everything around Add another 50 or so games *** 'port' option should now be CONNECT port, not query port *** add reference for many missing games
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)
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)
Super epic commit 3 Move everything around Add another 50 or so games *** 'port' option should now be CONNECT port, not query port *** add reference for many missing games
2014-02-03 21:00:51 +01:00
* Nascar Thunder 2004 (nascarthunder2004)
* netPanzer (netpanzer)
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)
Super epic commit 3 Move everything around Add another 50 or so games *** 'port' option should now be CONNECT port, not query port *** add reference for many missing games
2014-02-03 21:00:51 +01:00
* Natural Selection (ns)
* Natural Selection 2 (ns2) [[Separate Query Port](#separate-query-port)]
* Need for Speed: Hot Pursuit 2 (nfshp2)
* Nerf Arena Blast (nab) [[Separate Query Port](#separate-query-port)]
* Neverwinter Nights (nwn)
* Neverwinter Nights 2 (nwn2) [[Separate Query Port](#separate-query-port)]
* Nexuiz (nexuiz)
* Nitro Family (nitrofamily)
* No One Lives Forever (nolf)
* No One Lives Forever 2 (nolf2)
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
* Nuclear Dawn (nucleardawn)
Super epic commit 3 Move everything around Add another 50 or so games *** 'port' option should now be CONNECT port, not query port *** add reference for many missing games
2014-02-03 21:00:51 +01:00
* OpenArena (openarena)
* 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)]
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)
Super epic commit 3 Move everything around Add another 50 or so games *** 'port' option should now be CONNECT port, not query port *** add reference for many missing games
2014-02-03 21:00:51 +01:00
* Quake 1: QuakeWorld (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)
Super epic commit 3 Move everything around Add another 50 or so games *** 'port' option should now be CONNECT port, not query port *** add reference for many missing games
2014-02-03 21:00:51 +01:00
* Quake 3: Arena (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)
Super epic commit 3 Move everything around Add another 50 or so games *** 'port' option should now be CONNECT port, not query port *** add reference for many missing games
2014-02-03 21:00:51 +01:00
* Rag Doll Kung Fu (ragdollkungfu)
* Rainbow Six (r6)
* Rainbow Six: Raven Shield (r6ravenshield) [[Separate Query Port](#separate-query-port)]
* Rainbow Six: Rogue Spear (r6roguespear)
* RalliSport Challenge (rallisportchallenge)
* Rally Masters (rallymasters)
* 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)]
* Redline (redline)
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
* 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)
Super epic commit 3 Move everything around Add another 50 or so games *** 'port' option should now be CONNECT port, not query port *** add reference for many missing games
2014-02-03 21:00:51 +01:00
* Rise of Nations (riseofnations)
* Rune (rune) [[Separate Query Port](#separate-query-port)]
* Rust (rust) [[Separate Query Port](#separate-query-port)]
* Serious Sam (ss) [[Separate Query Port](#separate-query-port)]
* Serious Sam 2 (ss2)
* Shattered Horizon (shatteredhorizon)
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 Ship (ship)
Super epic commit 3 Move everything around Add another 50 or so games *** 'port' option should now be CONNECT port, not query port *** add reference for many missing games
2014-02-03 21:00:51 +01:00
* Shogo (shogo)
* Shootmania (shootmania)
* SiN (sin)
* SiN Episodes (sinep)
* Soldat (soldat) [[Separate Query Port](#separate-query-port)]
* Soldier of Fortune (sof)
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)
Super epic commit 3 Move everything around Add another 50 or so games *** 'port' option should now be CONNECT port, not query port *** add reference for many missing games
2014-02-03 21:00:51 +01:00
* S.T.A.L.K.E.R. (stalker) [[Separate Query Port](#separate-query-port)]
* Star Trek: Bridge Commander (stbc)
* Star Trek: Voyager - Elite Force (stvef)
* Star Trek: Voyager - Elite Force 2 (stvef2)
* Star Wars: Battlefront (swbf)
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
* Star Wars: Battlefront 2 (swbf2)
* Star Wars: Jedi Knight (swjk)
* Star Wars: Jedi Knight 2 (swjk2)
Super epic commit 3 Move everything around Add another 50 or so games *** 'port' option should now be CONNECT port, not query port *** add reference for many missing games
2014-02-03 21:00:51 +01:00
* Star Wars: Republic Commando (swrc) [[Separate Query Port](#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
* Starbound (starbound)
* Suicide Survival (suicidesurvival)
Super epic commit 3 Move everything around Add another 50 or so games *** 'port' option should now be CONNECT port, not query port *** add reference for many missing games
2014-02-03 21:00:51 +01:00
* SWAT 4 (swat4) [[Separate Query Port](#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)
Super epic commit 3 Move everything around Add another 50 or so games *** 'port' option should now be CONNECT port, not query port *** add reference for many missing games
2014-02-03 21:00:51 +01:00
* Tactical Ops (tacticalops) [[Separate Query Port](#separate-query-port)]
* Team Factor (teamfactor)
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)
Super epic commit 3 Move everything around Add another 50 or so games *** 'port' option should now be CONNECT port, not query port *** add reference for many missing games
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)]
* Terminus (terminus)
* Terraria (terraria) [[Separate Query Port](#separate-query-port)]
* Tony Hawk's Pro Skater 3 (thps3)
* Tony Hawk's Pro Skater 4 (thps4)
* Tony Hawk's Underground 2 (thu2)
* Trackmania 2 (trackmania2)
* Trackmania Forever (trackmaniaforever)
* Tremulous (tremulous)
* Tribes: Vengeance (tribesvengeance) [[Separate Query Port](#separate-query-port)]
* Tron 2.0 (tron20)
* Turok 2 (turok2)
* 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)]
Added a couple aliases
2014-02-02 21:28:46 +01:00
* Urban Terror (urbanterror)
Super epic commit 3 Move everything around Add another 50 or so games *** 'port' option should now be CONNECT port, not query port *** add reference for many missing games
2014-02-03 21:00:51 +01:00
* V8 Supercar Challenge (v8supercar)
Add the most annoying protocol of them all -- ventrilo
2014-02-02 18:09:58 +01:00
* Ventrilo (ventrilo)
Super epic commit 3 Move everything around Add another 50 or so games *** 'port' option should now be CONNECT port, not query port *** add reference for many missing games
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)]
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 3 Move everything around Add another 50 or so games *** 'port' option should now be CONNECT port, not query port *** add reference for many missing games
2014-02-03 21:00:51 +01:00
* Wheel of Time (wheeloftime) [[Separate Query Port](#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
* Wolfenstein 2009 (wolfenstein2009)
* Wolfenstein: Enemy Territory (wolfensteinet)
Super epic commit 3 Move everything around Add another 50 or so games *** 'port' option should now be CONNECT port, not query port *** add reference for many missing games
2014-02-03 21:00:51 +01:00
* Xpand Rally (xpandrally) [[Separate Query Port](#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
* 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
Super epic commit 3 Move everything around Add another 50 or so games *** 'port' option should now be CONNECT port, not query port *** add reference for many missing games
2014-02-03 21:00:51 +01:00
Games Not Supported (yet!)
---
(Want support for one of these games? Please open an issue!)
* Arca Sim Racing
* Cube Engine:
* Assault Cube
* Cube 2: Sauerbraten
* Blood Frontier
* BFRIS
* Call of Duty: Black Ops
* Call of Duty: Black Ops 2
* Counter-Strike 2D
* Delta Force: Land Warrior
* Enemy Territory: Quake Wars
* Flashpoint
* Freelancer
* Ghost Recon
* GTR2
* Haze
* Hexen 2
* Hexen World
* Hidden and Dangerous 2
* Mohawk Voice Server
* OpenTTD
* Pariah
* Raven Shield
* Red Faction
* rFactor
* San Andreas: Multiplayer
* Savage: Battle for Newerth
* Savage 2: A Tortured Soul
* Shattered Horizons
* Starsiege
* Sum of All Fears
* Teeworlds
* Tribes 1
* Tribes 2
* World in Conflict
> '''Know how to code?''' Many of the protocols for these games are documented
> in the /reference folder, ready for you to write code for!
Update README.md
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.
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.
Super epic commit 3 Move everything around Add another 50 or so games *** 'port' option should now be CONNECT port, not query port *** add reference for many missing games
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.
Add tons and tons of games and protocols
2014-02-01 16:48:01 +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
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.
Reference in New Issue Copy Permalink