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

Finalized 2.0 release notes

Browse source
This commit is contained in:
mmorrison 2019-01-12 22:22:26 -06:00
parent 6496660633
commit fdc08b5c09
2 changed files with 48 additions and 66 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

111
README.md
View file

@ -14,75 +14,53 @@ Usage from Node.js
npm install gamedig npm install gamedig
``` ```
Promise:
```javascript ```javascript
const Gamedig = require('gamedig'); const Gamedig = require('gamedig');
Gamedig.query({ Gamedig.query({
type: 'minecraft', type: 'minecraft',
host: 'mc.example.com' host: 'mc.example.com'
}).then((state) => { }).then((state) => {
console.log(state); console.log(state);
}).catch((error) => { }).catch((error) => {
console.log("Server is offline"); console.log("Server is offline");
}); });
``` ```
or Node.JS Callback:
```javascript
const Gamedig = require('gamedig');
Gamedig.query({
type: 'minecraft',
host: 'mc.example.com'
},
function(e,state) {
if(e) console.log("Server is offline");
else console.log(state);
});
```
> Is NPM out of date? If you're feeling lucky, you can install the latest code with
> ```shell
> npm install sonicsnes/node-gamedig
> ```
### Query Options ### Query Options
**Typical** **Typical**
* **type**: One of the game IDs listed in the game list below * **type**: string - One of the game IDs listed in the game list below
* **host**: Hostname or IP of the game server * **host**: string - Hostname or IP of the game server
* **port**: (optional) Uses the protocol default if not set * **port**: number (optional) - Connection port or query port for the game server. Some
games utilize a separate "query" port. If specifying the game port does not seem to work as expected, passing in
this query port may work instead. (defaults to protocol default port)
**Advanced** **Advanced**
* **notes**: (optional) An object passed through in the return value. * **maxAttempts**: number - Number of attempts to query server in case of failure. (default 1)
* **maxAttempts**: (optional) Number of attempts to query server in case of failure. (default 1) * **socketTimeout**: number - Milliseconds to wait for a single packet. Beware that increasing this
* **socketTimeout**: (optional) Milliseconds to wait for a single packet. Beware that increasing this
will cause many queries to take longer even if the server is online. (default 2000) will cause many queries to take longer even if the server is online. (default 2000)
* **attemptTimeout**: (optional) Milliseconds allowed for an entire query attempt. This timeout is not commonly hit, * **attemptTimeout**: number - Milliseconds allowed for an entire query attempt. This timeout is not commonly hit,
as the socketTimeout typically fires first. (default 10000) as the socketTimeout typically fires first. (default 10000)
* **debug**: boolean - Enables massive amounts of debug logging to stdout. (default false)
### Return Value ### Return Value
The returned state object will contain the following keys: The returned state object will contain the following keys:
**Stable, always present:** * **name**: string - Server name
* **map**: string - Current server game map
* **name** * **password**: boolean - If a password is required
* **map** * **maxplayers**: number
* **password**: Boolean * **players**: array of objects
* **maxplayers** * Each object **may or may not** contain name, ping, score, team, address.
* **players**: (array of objects) Each object **may** contain name, ping, score, team, address * The number of players online can be determined by `players.length`.
* **bots**: Same schema as players * For servers which do not provide player names, this may be an array
* **notes**: Passed through from the input of empty objects (ex. `[{},{},{}]`), one for each player without a name.
* **bots**: array of objects - Same schema as players
**Unstable, not guaranteed:** * **raw**: freeform object - Contains all information received from the server in a disorganized format. The content of this
field is unstable, and may change on a per-protocol basis between GameDig patch releases (although not typical).
* **raw**: Contains all information received from the server
* **query**: Details about the query performed
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.
Games List Games List
--- ---
@ -365,8 +343,6 @@ Games List
> __Know how to code?__ Protocols for most of the games above are documented > __Know how to code?__ Protocols for most of 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!
<!-- -->
> Don't see your game listed here? > Don't see your game listed here?
> >
> First, let us know so we can fix it. Then, you can try using some common query > First, let us know so we can fix it. Then, you can try using some common query
@ -392,7 +368,7 @@ have set the cvar: host_players_show 2
### 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 query port into GameDig instead.
### Mumble ### Mumble
For full query results from Mumble, you must be running the For full query results from Mumble, you must be running the
@ -435,26 +411,29 @@ You'll still need npm to install gamedig:
npm install gamedig -g npm install gamedig -g
``` ```
After installing gamedig globally, you can call gamedig via the command line After installing gamedig globally, you can call gamedig via the command line:
using the same parameters mentioned in the API above:
```shell ```shell
gamedig --type minecraft --host mc.example.com --port 11234 gamedig --type minecraft mc.example.com:11234
``` ```
The output of the command will be in JSON format. The output of the command will be in JSON format. Additional advanced parameters can be passed in
as well: `--debug`, `--pretty`, `--socketTimeout 5000`, etc.
Changelog Changelog
--- ---
### 2.0 ### 2.0
##### Breaking changes
* Node 8 is now required ##### Breaking API changes
* **Node 8 is now required**
* Removed the `port_query` option. You can now pass either the server's game port **or** query port in the `port` option, and * Removed the `port_query` option. You can now pass either the server's game port **or** query port in the `port` option, and
GameDig will automatically discover the proper port to query. Passing the query port is more likely be successful in GameDig will automatically discover the proper port to query. Passing the query port is more likely be successful in
unusual cases, as otherwise it must be automatically derived from the game port. unusual cases, as otherwise it must be automatically derived from the game port.
* Removed `callback` parameter from Gamedig.query. Only promises are now supported. If you would like to continue * Removed `callback` parameter from Gamedig.query. Only promises are now supported. If you would like to continue
using callbacks, you can use node's `util.callbackify` function to convert the method to callback format. using callbacks, you can use node's `util.callbackify` function to convert the method to callback format.
* Removed `query` field from response object, as it was poorly documented and unstable. * Removed `query` field from response object, as it was poorly documented and unstable.
* Removed `notes` field from options / response object. Data can be passed through a standard javascript context if needed.
##### Minor Changes ##### Minor Changes
* Rewrote core to use promises extensively for better error-handling. Async chains have been dramatically simplified * Rewrote core to use promises extensively for better error-handling. Async chains have been dramatically simplified
by using async/await across the codebase, eliminating callback chains and the 'async' dependency. by using async/await across the codebase, eliminating callback chains and the 'async' dependency.
@ -464,18 +443,24 @@ by using async/await across the codebase, eliminating callback chains and the 'a
* Automatic query port detection -- If provided with a non-standard port, gamedig will attempt to discover if it is a * Automatic query port detection -- If provided with a non-standard port, gamedig will attempt to discover if it is a
game port or query port by querying twice: once to the port provided, and once to the port including the game's query game port or query port by querying twice: once to the port provided, and once to the port including the game's query
port offset (if available). port offset (if available).
* Simplified detection of BC2 when using battlefield protocol.
* Fixed buildandshoot not reading player list
* Added new `connect` field to the response object. This will typically include the game's `ip:port` (the port will reflect the server's * Added new `connect` field to the response object. This will typically include the game's `ip:port` (the port will reflect the server's
game port, even if you passed in a query port in your request). For some games, this may be a server ID or connection url game port, even if you passed in a query port in your request). For some games, this may be a server ID or connection url
if an IP:Port is not appropriate. if an IP:Port is not appropriate.
* Added new `ping` field (in milliseconds) to the response object. Since icmp packets are often blocked by NATs, and node has poor support * Added new `ping` field (in milliseconds) to the response object. As icmp packets are often blocked by NATs, and node has poor support
for raw sockets, this time is derived from the rtt of one of the UDP requests, tcp socket connection, or http requests made for raw sockets, this time is derived from the rtt of one of the UDP requests, or the time required to open a TCP socket
during the query. during the query.
* Improved debug logging across all parts of GameDig
* Removed global `Gamedig.debug`. `debug` is now an option on each query.
##### Protocol Changes
* Added support for games using older versions of battlefield protocol.
* Simplified detection of BC2 when using battlefield protocol.
* Fixed buildandshoot not reading player list
* Standardized all doom3 games into a single protocol, which can discover protocol discrepancies automatically.
* Standardized all gamespy2 games into a single protocol, which can discover protocol discrepancies automatically.
* Standardized all gamespy3 games into a single protocol, which can discover protocol discrepancies automatically.
* Improved valve protocol challenge key retry process
### 1.0 ### 1.0
* First official release * First official release
* Node.js 6.0 is now required * Node.js 6 is now required

3
protocols/core.js
View file

@ -89,9 +89,6 @@ class Core extends EventEmitter {
await this.run(state); await this.run(state);
if (this.options.notes)
state.notes = this.options.notes;
// because lots of servers prefix with spaces to try to appear first // because lots of servers prefix with spaces to try to appear first
state.name = (state.name || '').trim(); state.name = (state.name || '').trim();