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

Making `requestRules` more evident

This commit is contained in:
Pedro Ivo Hudson 2021-07-21 20:10:48 -03:00
parent a8b7cad002
commit c3e5cd570c
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@ -45,6 +45,7 @@ this query port may work instead. (defaults to protocol default port)
as the socketTimeout typically fires first. (default 10000) as the socketTimeout typically fires first. (default 10000)
* **givenPortOnly**: boolean - Only attempt to query server on given port. (default false) * **givenPortOnly**: boolean - Only attempt to query server on given port. (default false)
* **debug**: boolean - Enables massive amounts of debug logging to stdout. (default false) * **debug**: boolean - Enables massive amounts of debug logging to stdout. (default false)
* **requestRules**: boolean - Valve games only. Additional 'rules' may be fetched into the `raw` field. (default false)
### Return Value ### Return Value
@ -517,4 +518,4 @@ gamedig --type minecraft mc.example.com:11234
``` ```
The output of the command will be in JSON format. Additional advanced parameters can be passed in The output of the command will be in JSON format. Additional advanced parameters can be passed in
as well: `--debug`, `--pretty`, `--socketTimeout 5000`, etc. as well: `--debug`, `--pretty`, `--socketTimeout 5000`, `--requestRules` etc.