mitchell/ServerStatus
1
0
Fork 0
mirror of https://github.com/mgerb/ServerStatus synced 2026-01-09 18:52:50 +00:00
Code Issues Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
Mitchell
2019-01-19 20:30:27 -06:00
parent 92d94ed4d4
commit 68bfed3f3b
1 changed files with 6 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
readme.md
View File

@@ -1,19 +1,18 @@
# Server Status # Server Status
Scans a list of servers checking checking which are currently online. Monitors a list of servers and sends a chat notification when a server goes on or offline.
This bot will send a chat notification when the status of a server changes (goes on or offline).
- **TCP** - should work with all servers - **TCP** - should work with all servers
- **UDP** - [Source RCON Protocol](https://developer.valvesoftware.com/wiki/Source_RCON_Protocol) is supported - **UDP** - [Source RCON Protocol](https://developer.valvesoftware.com/wiki/Source_RCON_Protocol) is supported
## Configuration ## Configuration
- Download the latest release [here](https://github.com/mgerb/ServerStatus/releases) - Download the latest release [here](https://github.com/mgerb/ServerStatus/releases)
- Add your bot token as well as other configurations to config.json - Add your bot token as well as other configurations to **config.json**
- Execute the OS specific binary! - Execute the OS specific binary!
### Mentioning Roles/Users ### Mentioning Roles/Users
- you must first get your role/user id (see below of obtaining ID's) - list of user/role ID's must be in the following format (see below for obtaining ID's)
- for user `<@userid>` - `<@userid>`
- for role `<@&roleid>` - `<@&roleid>`
### Polling Interval ### Polling Interval
The polling interval is how often the bot will try to ping the servers. The polling interval is how often the bot will try to ping the servers.
@@ -21,7 +20,7 @@ A good interval is 10 seconds, but this may need some adjustment if
it happens to be spamming notifications. it happens to be spamming notifications.
- time in seconds - time in seconds
- configurable in `config.json` - configurable in **config.json**
## With Docker ## With Docker