Skip to content

Simple discord bot to show a subreddit's mod queue

License

Notifications You must be signed in to change notification settings

Galarzaa90/ModOverseer

Repository files navigation

ModOverseer

GitHub License GitHub code size in bytes

A basic bot that displays a subreddit's Mod Queue in a designated channel.

Entries are kept up to date and removed when handled.

This bot is made for personal use, but I'm sharing it in case anyone finds it useful.

Usage

To use, create a file called config.ini, you can check the example file to see the structure.

To use this, you need to create your own reddit web application, in order to get a client id and client secret.

Once you have created it, you need to get a refresh token via reddit's oauth method.
I acquired it using this script, I might add one in the future that doesn't require PRAW.
The account used to get the token must be a moderator of the subreddit.

Once you have acquired all the required information, you need to specify a discord server id and a discord channel id. This is all the info you will need for config.ini, apart from a token for your discord bot.

You may notice a file queue.json is created, this serves as a map to keep track of which discord message belongs to which queue entry. Deleting or tampering this file may lead to duplicate and/or orphaned messages.

Example

image

Running from Docker

Docker Pulls Docker Image Size

An image is available on Dockerhub

To run, you have to mount the configuration file. It is also highly recommended that you mount an empty JSON file so the current queue list can be preserved on restarts.

docker run --rm -ti \
  -v ${PWD}/config.ini:/app/config.ini \
  -v ${PWD}/queue.json:/app/queue.json \
  --name mod-overseer \
  galarzaa90/mod-overseer

About

Simple discord bot to show a subreddit's mod queue

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages