Robot/node-gamedig
1
0
Fork 0
mirror of https://github.com/gamedig/node-gamedig.git synced 2024-11-13 07:21:11 +01:00
Code Issues Projects Releases Packages Wiki Activity

Document input parameters

Browse source
This commit is contained in:
Michael Morrison 2013-07-12 04:15:11 -05:00
parent e0f3f7ecbf
commit 399dba0d9c
1 changed files with 8 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
README.md
View file

@ -22,6 +22,14 @@ Gamedig.query(
);
```
Input Parameters
---
* type (one of the types from the protocols folder)
* host
* port (uses the protocol default if not set)
* login (required by nadeo protocol)
* password (required by nadeo protocol)
Callback Function
---
The callback function is "guaranteed" to be called exactly once.
@ -64,7 +72,6 @@ Supported Games
* Trackmania Forever
* Trackmania 2
* Shootmania
* (requires additional 'login' and 'password' parameters for User login on server)
* Quake 2 Protocol
* Quake 2
* Quake 3 Protocol