skylord123/node-red-contrib-gamedig
1
0
Fork 0
mirror of https://github.com/skylord123/node-red-contrib-gamedig.git synced 2025-04-10 08:03:08 -06:00
Code Issues Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Skylar Sadlier 2019-12-06 01:37:51 -07:00 committed by GitHub
parent 52bddfa603
commit 6836b82b0b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 17 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -1,4 +1,19 @@
# node-red-contrib-gamedig
Query for the status of any game server using Node Red.
This package adds the node "Query Game Server" that uses GameDig to query if a server is online or not and if so returns the data of the server.
Query for the status of any game server 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).
### Usage Examples
#### Inserting query data into InfluxDB and using Grafana to view results
![Flow Preview](https://skylar.tech/content/images/2019/12/image-2.png)
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/
### 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.