discord-bot-wow-status

Introduction
Installation
Usage
Development

Introduction

This repository contains the source files of a Node server written in TypeScript for a Discord bot that automatically posts messages related to World of Warcraft. The bot is mostly for private use but it can be installed and used on any Discord server, however it must be hosted manually.

Features of the bot include:

Monitors realms and posts messages when the status of a realm changes (useful for weekly maintenance)
Posts a message when daily quests and weekly raids reset

More features will be added when the APIs relating to features being introduced in Shadowlands are released.

Installation

The following is required before installing and using the bot:

For both the Discord app and Blizzard API client, redirect and service URLs are not required.

The Discord app bot must be manually connected to a Discord gateway and server:

https://discord.com/developers/docs/topics/gateway#get-gateway-bot

The following environment variables are required when running the server:

Variable	Description
`DISCORD_BOT_TOKEN`	The token of the bot from the Discord app
`DISCORD_CHANNEL_ID`	The ID of the Discord channel to post to
`BLIZZARD_CLIENT_ID`	The client ID of the Blizzard API client
`BLIZZARD_CLIENT_SECRET`	The client secret of the Blizzard API client
`REALM_SLUGS`	Comma-delimited list of World of Warcraft realm slugs (US region only) to monitor, e.g. `frostwolf,moonguard,tichondrius`

Docker images of the server are published to and can be pulled from the GitHub Packages Registry:

https://github.com/Flamov/discord-bot-wow-status/packages

Alternatively, a Docker image of the server can be built locally by cloning this repository and running:

docker build . -t discord-bot-wow-status

The server can be run by passing in the required environment variables (in detached mode):

docker run \
  -e DISCORD_BOT_TOKEN= \
  -e DISCORD_CHANNEL_ID= \
  -e BLIZZARD_CLIENT_ID= \
  -e BLIZZARD_CLIENT_SECRET= \
  -e REALM_SLUGS= \
  -d discord-bot-wow-status

Docker Compose can also be used to more easily manage environment variables, for example:

version: "3"

services:
  bot:
    image: docker.pkg.github.com/flamov/discord-bot-wow-status/discord-bot-wow-status:latest
    restart: unless-stopped
    environment:
      - DISCORD_BOT_TOKEN=
      - DISCORD_CHANNEL_ID=
      - BLIZZARD_CLIENT_ID=
      - BLIZZARD_CLIENT_SECRET=
      - REALM_SLUGS=

The server can also be built and run locally without Docker — see Development for more details.

Usage

Once the server is running, it will post messages to a single Discord channel (DISCORD_CHANNEL_ID defined in Installation) when:

The status of a realm (for each in REALM_SLUGS defined in Installation) changes
- The server will poll the World of Warcraft API every 60 seconds
- The server will only post a message when the status of a realm changes from its previous state (i.e. it won't post messages for the same status multiple times)
- The realm status is provided in the API from the connected realm data instead of the realm data itself – the server will automatically retrieve the connected realm data from the realm slug
Daily quests and weekly raids reset
- The server will post a message every day when daily quests reset and a message on Tuesday when weekly raids reset, both at a fixed time of 1500 UTC (based on the US reset time)

Development

Below are the NPM commands that can be used for development:

Command	Description
`npm run start`	Runs the server (`npm run build` should be run before)
`npm run build`	Compiles TypeScript files into JavaScript
`npm run test`	Runs TypeScript, ESLint, and unit/integration tests consecutively
`npm run test:eslint`	Runs ESLint tests
`npm run test:typescript`	Runs TypeScript tests
`npm run test:typescript:watch`	Runs `npm run test:typescript` in watch mode
`npm run test:unit`	Runs unit/integration tests ¹
`npm run test:unit:coverage`	Runs `npm run test:unit` and also generates a coverage report ¹
`npm run test:unit:watch`	Runs `npm run test:unit:coverage` in watch mode ¹

¹ Can be run without needing to run npm run build

wallind / discord-bot-wow-status Goto Github PK