Game Server Watcher

A simple discord/telegram bot that can be hosted on a free service to monitor your game servers and players in style. 😎

About the Project

The main goals of this repo:

create a (simple, but capable) service/bot to monitor game servers
1. get gamedig & steam api server info (eg.: server name, map, players, etc.)
2. relay real time server information to various channels via APIs (eg.: discord, telegram, slack etc.)
should be able to host on a free service (target atm. is fly.io (node.js 16))
graciously add more features based on community feedback via discord and github

Screenshots

Discord

Telegram

GSW Control Panel

Project Status

The code itself is stable and continuously tested/deployed from the master branch.

The project is in a very early stage. More detailed customization options and features will be added as requested.

Possible features and configuration options to add in the future

optional player list
- with configurable fields. eg.: time,name,ping,score
- configurable field & order to sort by
- max length for player names & nr of players
custom embed fields for discord
~~configurable time zone offset for graph x-axis~~
refresh on reaction
watched players (notify when a watched player enters/leaves the server)
detect when the server goes offline, notify when player number crosses a threshold
bot commands (reinit message, cleanup, start/stop, configure)
more integrations: slack, ms teams, twillio (email, sms)
~~web ui to manage & configure the servers and bots~~
put custom information in the channel name or bot status (online status indicator, number of players, map)
github action workflows to deploy to other cloud providers (aws, linode, atlantic, vultr, pikapods, okteto, ibm cloud etc.)
SQL, JSON or object store database support (postgres, redis etc.)
run as stateless serverless function (aws lambda, azure function, heroku, vercel, fly.io machines etc.)
pterodactyl egg release

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Requirements

node.js (version 16.9.0 or later)

Getting the source

This project is hosted on github. You can clone this project directly using this command:

git clone git@github.com:a-sync/game-server-watcher.git

The latest source and build can also be downloaded as a zip archive.

Installation

Use npm or yarn to install/update all the dependencies:

npm i

If you don't want to build from source, you can skip the development dependencies:

npm i --only=prod

Usage

Build the artifacts from source (optional):

npm run build

Start the built artifacts:

npm start

Build, start and auto restart on source changes:

npm run dev

Settings

The behaviour of the watcher service can be configured via environmental variables (env vars).
.env (dotenv) file is also supported, to look at the avaialable values and defaults check the .env.example file.
To get started, you can simply rename the .env.example file to .env.

Refer to the wiki on how to acquire tokens for:

Managing the service

GSW Control Panel is a web based UI that let's you configure and control the Game Server Watcher instance.
The web app is served at http://localhost:8080 by default.
Make sure to configure a proper SECRET env var to enable access!

Configuration

Updates the configuration file and restarts the service.

Flush data

Flush game servers data

Removes population history data. (configured by Graph history time span server option)

Flush discord data

If the original message created by the bot gets deleted, you might need to flush the bot data to reinitialize the message.
The bot has no cleanup functionality, left over messages must be removed manually.

Flush telegram data

If the original message created by the bot gets deleted, you need to flush the bot data to reinitialize the message.
The bot has no cleanup functionality, left over messages must be removed manually.

Deployment

Check the wiki page for detailed instructions on how to setup a self deploying free cloud instance at fly.io.

Docker Compose

Make sure to configure .env file, after that run:

docker-compose up -d --build

To shutdown the container run:

docker-compose down

Hosting

Make sure all the requirements are met!

Build artifacts (optional)

npm i
npm run build

Minimum required files on host

Copy the ./package.json file and the ./public/ and ./dist/ folders and their contents to your deployment folder.

Install production dependencies on host

Navigate to the deployment folder and execute the following command:

npm i --only=prod

If you can not install dependencies on the host, do a local install and copy the ./node_modules/ folder to the host.

Service configuration

Create environmental variables to enable the required features and to customize the service.

Make sure the service can write to the data storage path. (configured by DATA_PATH env var, default: ./data/)
Make sure you create a unique admin secret. (configured by SECRET env var, default: secret)

Running

Run the program from the deployment folder:

node ./dist/server.js

How to Get Help

Check the wiki
Ask a question
Join the support / test discord

Contributing

Public contributions are welcome!
You can create a new issue for bugs, or feel free to open a pull request for any and all your changes or work-in-progress features.

License

This project is licensed under the AGPL License - see LICENSE file for details.

Authors

Check the list of contributors who participated in this project.

Acknowledgments

This project was inpired by (the sudden disappearance of) "Game Status#5371" bot and its creator Ramzi Saheb on discord.

IP regex stolen from the ip-regex package source.

GSW icon stolen from Marvel’s Voices: Indigenous Voices #1 "The Watcher" by Jeffrey Veregge.

Backgrounds stolen from purple nebulas by Screaming Brain Studios and imgur.

All other libraries and dependencies are listed in the package.json file (dependencies/devDependencies section) and the index.html file (head section).

Similar projects

About

A simple discord/telegram bot that can be hosted on a free service to monitor your game servers and players in style 😎

GNU Affero General Public License v3.0

Languages

Language:TypeScript 52.4%Language:JavaScript 32.4%Language:HTML 11.0%Language:CSS 3.4%Language:Shell 0.5%Language:Dockerfile 0.2%Language:Procfile 0.0%

Cyclops789 / game-server-watcher