mirror of
https://github.com/skylord123/node-red-contrib-gamedig.git
synced 2025-04-18 20:13:06 -06:00
Skylar Sadlier
787ee61c4e
- New option "Output options" that you can enable from config to output `msg.options` object that contains all options we passed to GameDig to query the server. This overrides all other options (whether set from the UI or from `msg.*` variables) so take note of that when chaining multiple server query nodes together with this enabled. - Breaking Change: This node no longer returns `msg.max_attempts`, `msg.socket_timeout`, and `msg.attempt_timeout`, instead see "Output options" mentioned above if you need this.
31 lines
2.1 KiB
Markdown
31 lines
2.1 KiB
Markdown
# node-red-contrib-gamedig
|
|
|
|
Query for server information of most game/voice servers using Node-RED.
|
|
|
|
This package adds the node "Query Game Server" that uses the NPM package [GameDig](https://www.npmjs.com/package/gamedig) to query if a server is online or not and if so returns the data of the server.
|
|
|
|
You can pass the server type, host, and port on the input message or define them on the node (settings defined on the node will override msg values).
|
|
|
|
You can also specify manual GameDig options using `msg.options` as an input. This will override any other options. For example: you can set `msg.options.guildId` that is required for querying Discord servers.
|
|
|
|
Visit the [GameDig GitLab page](https://github.com/gamedig/node-gamedig#return-value) if you want more information about what this library parses and standardizes from the server response.
|
|
|
|
### Usage Examples
|
|
- #### Inserting query data into InfluxDB and using Grafana to view results
|
|
|
|
I created a post on my website about how to use this node to query gameservers and store the results in InfluxDB. I then give a dashboard in Grafana that can be used to display the data. Check it out here:
|
|
https://skylar.tech/tracking-game-server-statistics-using-node-red-influxdb-and-grafana/
|
|
|
|
- #### Automatically restarting servers when unavailable
|
|
Ever host a server and have it stop responding but the process doesn't crash so it doesn't auto restart? If you pair this with something like [node-red-contrib-dockerode](https://flows.nodered.org/node/node-red-contrib-dockerode) you can automatically restart the container/process if the query fails X times to respond.
|
|
|
|
### Other Packages
|
|
|
|
- [node-red-contrib-matrix-chat](https://www.npmjs.com/package/node-red-contrib-gamedig) - Matrix chat server client for Node-RED
|
|
|
|
### Developers
|
|
So far me (skylord123) is the only person that has contributed towards this package. Feel free to do any pull-requests to get your name here!
|
|
|
|
### License
|
|
This project is licensed under the MIT License. Check [here](LICENSE) for more information.
|