ModReplyBot Reddit Bot

ModReplyBot is a Reddit bot for moderators that watches for mod comments containing triggers, approves posts, and leaves stickied comments. It also posts automatic comments based on post tags, and notifies mods when its configuration changes. All configuration is handled via a subreddit wiki page and environment variables.

Features

Responds only to moderator comments containing triggers (ignores non-mod comments)
Approves posts and leaves stickied comments
Posts automatic comments based on tags in post titles (e.g., [Bedrock], [Java])
Triggers, tag comments, and bot config are managed via a subreddit wiki page
Notifies mods via modmail when the config wiki page changes
Persistent database for auto-commented posts (survives restarts and container recreations)
Docker and baremetal support

Configuration

1. Wiki Page Configuration

Edit your subreddit wiki page (name set by REDDIT_WIKI_PAGE env variable) with YAML like:

triggers:
  - trigger: help
    comment: |
      Thank you for your report!
      This post is now approved.
  - trigger: question
    comment: |
      This post has been approved.
      Your question will be answered soon.

post_tags:
  - tag: Bedrock, Java
    comment: |
      __[Click here if your post says "Sorry, this post was removed by Reddit’s filters"](...)__

Triggers: Bot responds to mod comments containing !trigger (e.g., !help) with the configured comment.
post_tags: Bot posts the comment automatically on new posts with matching tags in the title.

2. Environment Variables

Create a .env file (or set env variables directly) with:

REDDIT_CLIENT_ID=your_client_id
REDDIT_CLIENT_SECRET=your_client_secret
REDDIT_USERNAME=your_username
REDDIT_PASSWORD=your_password
REDDIT_USER_AGENT=modreplybot by /u/your_username
REDDIT_SUBREDDIT=your_subreddit
REDDIT_WIKI_PAGE=modbot-config

Installation

Docker Compose (Recommended)

Copy .env.example to .env and fill in your values.
Run:

docker compose up -d

The DB folder is mounted for persistent database storage.

Docker Run

Copy .env.example to .env and fill in your values.
Run:

docker run --env-file .env -v $(pwd)/DB:/app/DB slfhstd.uk/slfhstd/modreplybot:latest

Baremetal (Direct Python)

Install Python 3.11+
Install dependencies:

pip install -r requirements.txt

Set environment variables or create a .env file.
Run:

python modreplybot.py

Troubleshooting

Ensure your Reddit credentials are correct and have moderator permissions.
The bot must be able to read the wiki page and approve posts.
Check logs for errors.
The bot only responds to mod comments for triggers.
Database is stored in DB/commented_posts.txt and survives container restarts.

License

MIT

2.8 KiB Raw Blame History Unescape Escape