https://github.com/mgerb/serverstatus
A Discord bot to display the status of servers.
https://github.com/mgerb/serverstatus
bot discord go hacktoberfest server status
Last synced: 3 months ago
JSON representation
A Discord bot to display the status of servers.
- Host: GitHub
- URL: https://github.com/mgerb/serverstatus
- Owner: mgerb
- Created: 2017-01-15T21:09:59.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2024-03-03T22:10:05.000Z (almost 2 years ago)
- Last Synced: 2025-05-07T21:11:33.793Z (8 months ago)
- Topics: bot, discord, go, hacktoberfest, server, status
- Language: Go
- Homepage: https://hub.docker.com/r/mgerb/server-status
- Size: 16.4 MB
- Stars: 78
- Watchers: 10
- Forks: 17
- Open Issues: 6
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# 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](https://developer.valvesoftware.com/wiki/Source_RCON_Protocol) is supported
- [Docker](https://hub.docker.com/r/mgerb/server-status)
### Want to see more features?
[Submit a new issue](https://github.com/mgerb/ServerStatus/issues/new/choose)
## Configuration
- Download the latest release [here](https://github.com/mgerb/ServerStatus/releases)
- 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.
## 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.
