ModReplyBot 1.0.0 release
This commit is contained in:
@@ -1,18 +1,18 @@
|
||||
# ModReplyBot Reddit Bot
|
||||
|
||||
This bot watches a subreddit for moderator reports containing triggers, approves posts, and leaves stickied comments. Triggers and comments are configured via a subreddit wiki page. All other settings are handled via environment variables.
|
||||
This bot watches a subreddit for moderator reports containing triggers, approves posts, and leaves stickied comments. Triggers and comments are configured via a local YAML file. All other settings are handled via environment variables.
|
||||
|
||||
## Features
|
||||
- Watches for moderator reports with triggers
|
||||
- Approves posts and leaves stickied comments
|
||||
- Triggers/comments configured via subreddit wiki
|
||||
- Triggers/comments configured via config/config.yaml
|
||||
- Supports multiple triggers/comments
|
||||
- Docker and baremetal support
|
||||
|
||||
## Configuration
|
||||
|
||||
### 1. Subreddit Wiki Page
|
||||
Create a wiki page (e.g. `modreplybot-config`) in your subreddit using Automoderator YAML format. Example:
|
||||
### 1. Trigger and Comment Configuration
|
||||
Edit the file at `config/config.yaml` in your project directory. Example:
|
||||
|
||||
```
|
||||
triggers:
|
||||
@@ -27,7 +27,7 @@ triggers:
|
||||
Your question will be answered soon.
|
||||
```
|
||||
|
||||
Each entry under `triggers` defines a trigger and its associated multi-line comment.
|
||||
Each entry under `triggers` defines a trigger and its associated multi-line comment. The bot will automatically create this file with example content if it does not exist.
|
||||
|
||||
### 2. Environment Variables
|
||||
Create a `.env` file (or set env variables directly) with:
|
||||
@@ -39,7 +39,6 @@ REDDIT_USERNAME=your_username
|
||||
REDDIT_PASSWORD=your_password
|
||||
REDDIT_USER_AGENT=modreplybot by /u/your_username
|
||||
REDDIT_SUBREDDIT=your_subreddit
|
||||
REDDIT_WIKI_PAGE=modreplybot-config
|
||||
```
|
||||
|
||||
## Installation
|
||||
|
||||
Reference in New Issue
Block a user