Update readme formatting

This commit is contained in:
Michael Morrison 2014-09-13 09:58:29 -05:00
parent 5bb493e83f
commit 3c937055d9
2 changed files with 31 additions and 32 deletions

View file

@ -67,9 +67,10 @@ Otherwise, the returned object is guaranteed to contain the following keys:
It can usually be assumed that the number of players online is equal to the length of the players array. 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. Some servers may return an additional player count number, which may be present in the unstable raw object.
Supported Games Games List
--- ---
###Supported
<!--- BEGIN GENERATED GAMES --> <!--- BEGIN GENERATED GAMES -->
* Age of Chivalry (ageofchivalry) * Age of Chivalry (ageofchivalry)
@ -293,24 +294,7 @@ Supported Games
<!--- END GENERATED GAMES --> <!--- END GENERATED GAMES -->
Don't see your game listed here? ###Not supported (yet)
1. Let us know so we can fix it
1. You can try using some common query protocols directly by using one of these server types:
* protocol-ase
* protocol-battlefield
* protocol-doom3
* protocol-gamespy1
* protocol-gamespy2
* protocol-gamespy3
* protocol-nadeo
* protocol-quake2
* protocol-quake3
* protocol-unreal2
* protocol-valve
Games Not Supported (yet!)
---
* rFactor Engine (rfactor): * rFactor Engine (rfactor):
* rFactor * rFactor
@ -321,6 +305,7 @@ Games Not Supported (yet!)
* Cube 2: Sauerbraten * Cube 2: Sauerbraten
* Blood Frontier * Blood Frontier
* BFRIS * BFRIS
* Call of Duty: Black Ops 1 and 2 (no documentation, may require rcon)
* Counter-Strike 2D * Counter-Strike 2D
* Freelancer * Freelancer
* Ghost Recon * Ghost Recon
@ -340,40 +325,54 @@ Games Not Supported (yet!)
* World in Conflict * World in Conflict
> Want support for one of these games? Please open an issue to show your interest! > Want support for one of these games? Please open an issue to show your interest!
> __Know how to code?__ Protocols for most of the games above are documented
> __Know how to code?__ Protocols for the games above are documented
> in the /reference folder, ready for you to develop into GameDig! > in the /reference folder, ready for you to develop into GameDig!
Not Supported <!-- -->
> Don't see your game listed here?
>
> First, let us know so we can fix it. Then, you can try using some common query
> protocols directly by using one of these server types:
> * protocol-ase
> * protocol-battlefield
> * protocol-doom3
> * protocol-gamespy1
> * protocol-gamespy2
> * protocol-gamespy3
> * protocol-nadeo
> * protocol-quake2
> * protocol-quake3
> * protocol-unreal2
> * protocol-valve
Games with Additional Notes
--- ---
* Call of Duty: Black Ops 1 and 2 (no documentation, may require rcon)
### Games with Additional Notes ### DayZ
#### DayZ
DayZ uses a query port that is separate from its main game port. The query port is usually DayZ uses a query port that is separate from its main game port. The query port is usually
the game port PLUS 24714 or 24715. You may need to pass this port in as the 'port_query' request option. the game port PLUS 24714 or 24715. You may need to pass this port in as the 'port_query' request option.
#### Minecraft ### Minecraft
Some minecraft servers may not respond to a typical status query. If this is the case, try using the 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. 'minecraftping' server type instead, which uses a less accurate but more reliable solution.
#### Mumble ### Mumble
For full query results from Mumble, you must be running the For full query results from Mumble, you must be running the
[GTmurmur plugin](http://www.gametracker.com/downloads/gtmurmurplugin.php). [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, 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 you can use the 'mumbleping' server type instead, which uses a less accurate but more reliable solution
#### Nadeo (ShootMania / TrackMania / etc) ### Nadeo (ShootMania / TrackMania / etc)
The server must have xmlrpc enabled, and you must pass the xmlrpc port to GameDig, not the connection port. 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. You must have a user account on the server with access level User or higher.
Pass the login into to GameDig with the additional options: login, password Pass the login into to GameDig with the additional options: login, password
#### Terraria ### Terraria
Requires tshock server mod, and a REST user token, which can be passed to GameDig with the Requires tshock server mod, and a REST user token, which can be passed to GameDig with the
additional option: token additional option: token
#### Separate Query Port ### Separate Query Port
Games with this note use a query port which is usually not the same as the game's connection port. Games with this note use a query port which is usually not the same as the game's connection port.
Usually, no action will be required from you. The 'port' option you pass GameDig should be the game's 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, connection port. GameDig will attempt to calculate the query port automatically. If the query still fails,

View file

@ -11,7 +11,7 @@
], ],
"main": "lib/index.js", "main": "lib/index.js",
"author": "Michael Morrison", "author": "Michael Morrison",
"version": "0.2.6", "version": "0.2.7",
"repository" : { "repository" : {
"type" : "git", "type" : "git",
"url" : "https://github.com/sonicsnes/node-gamedig.git" "url" : "https://github.com/sonicsnes/node-gamedig.git"