1
0
mirror of https://github.com/mgerb/ServerStatus synced 2026-01-08 10:32:48 +00:00
Files
ServerStatus/readme.md
Mitchell 50a06b98be Updates and maintenance
- switch from dep to go modules
- update to discordgo v0.27.1
- fix offline/online message bug
2024-03-03 11:32:08 -06:00

1.9 KiB

Server Status

Monitors a list of servers and sends a chat notification when a server goes on or offline.

Features

  • send channel notifications
  • track server up/down time
  • TCP - should work with all servers
  • UDP - Source RCON Protocol is supported
  • Docker

Want to see more features?

Submit a new issue

Configuration

  • Download the latest release here
  • Add your bot token as well as other configurations to config.json
  • Execute the OS specific binary!

Mentioning Roles/Users

  • list of user/role ID's must be in the following format (see below for obtaining ID's)
  • <@userid>
  • <@&roleid>

Polling Interval

The polling interval is how often the bot will try to ping the servers. A good interval is 10 seconds, but this may need some adjustment if it happens to be spamming notifications.

  • time in seconds
  • configurable in config.json

With Docker

docker run -it -v /path/to/your/config.json:/server-status/config.json:ro mgerb/server-status

Docker Compose

version: "2"

services:
  server-status:
    image: mgerb/server-status:latest
    volumes:
    - /path/to/your/config.json:/server-status/config.json

Usage

To get the current status of your servers simply type /server-status in chat.

Server Status

Compiling from source

  • Make sure Go and Make are installed
  • make all

How to get the bot token

https://github.com/reactiflux/discord-irc/wiki/Creating-a-discord-bot-&-getting-a-token

How to get your room ID

To get IDs, turn on Developer Mode in the Discord client (User Settings -> Appearance) and then right-click your name/icon anywhere in the client and select Copy ID.