Skip to content

Latest commit

 

History

History
44 lines (28 loc) · 1.86 KB

README.md

File metadata and controls

44 lines (28 loc) · 1.86 KB
Raw

Momentum Mod Discord Bot

Momentum Mod

A Discord bot for Momentum Mod's Official Discord, running in a dockerized .NET Core container, using DSharpPlus.

.NET Core

Purpose

The bot is used to manage and accompany the Discord server:

  • Monitor Twitch livestreams playing Momentum Mod
  • Get custom notification roles
  • Force users to read the FAQ

Dependencies

Dev Setup

Firstly, you will need to make a test Discord server with the various roles and channels used by the bot.

Then, clone the repo using a CLI.

  1. Navigate to the root folder: cd discord-bot
  2. Copy env.TEMPLATE to .env.dev: cp env.TEMPLATE .env.dev
  3. In config/, copy config.template.json.TEMPLATE to config.json: cd config/ && cp config.json.TEMPLATE config.json
  4. Initialise the SQLite DB by running data/setup-db.sh
  5. Build and run the Docker containers using Docker Compose with docker-compose up -d. For testing changes, you'll need to rebuild with docker-compose build.

Contributing

Contributions are welcome, though we encourage you either tackle existing issues or ask about ideas in the Momentum Mod Discord server first.

Whilst we originally planned to include integrations with Momentum Mod's official API for stat tracking, WR announcements, etc., we've since decided to move that work to a separate repository. Therefore we expect to make relatively few additions in the future, mostly just small housekeeping features.