V2 release
This commit is contained in:
+26
-5
@@ -1,3 +1,4 @@
|
||||
|
||||
# ModReplyBot Moderator Guide
|
||||
|
||||
## Wiki Configuration Page
|
||||
@@ -12,7 +13,7 @@ https://old.reddit.com/r/<your_subreddit>/wiki/<wiki_page>
|
||||
|
||||
## Triggers
|
||||
|
||||
Triggers allow moderators to perform bot actions by commenting with a trigger phrase or by reporting a post with a trigger phrase in the report reason. Triggers must start with a `!` (ex: `!help`).
|
||||
Triggers allow moderators to perform bot actions by commenting with a trigger phrase or by reporting a post with a trigger phrase in the report reason. Triggers must start with a `!` (ex: `!test`).
|
||||
|
||||
### Example Trigger Configuration
|
||||
```
|
||||
@@ -22,6 +23,10 @@ triggers:
|
||||
Thank you for your report!
|
||||
This post is now approved.
|
||||
status: enabled
|
||||
flair_id: 12345678-aaaa-bbbb-cccc-1234567890ab
|
||||
stickied: true
|
||||
lock_post: false
|
||||
lock_comment: false
|
||||
- trigger: wc
|
||||
comment: |
|
||||
Welcome to the community!
|
||||
@@ -31,9 +36,13 @@ triggers:
|
||||
- **trigger**: The phrase (without the `!`) that mods use in comments or report reasons.
|
||||
- **comment**: The text the bot will post as a stickied comment.
|
||||
- **status**:
|
||||
- `enabled`: Bot will approve the post and comment.
|
||||
- `log-only`: Bot will approve the post but not comment.
|
||||
- `enabled`: Bot will comment and perform actions.
|
||||
- `log-only`: Bot will log but not comment.
|
||||
- `disabled`: Bot will not act on this trigger.
|
||||
- **flair_id**: Optional. Set post flair by ID.
|
||||
- **stickied**: Optional. Sticky the bot's comment.
|
||||
- **lock_post**: Optional. Lock the post.
|
||||
- **lock_comment**: Optional. Lock the bot's comment.
|
||||
|
||||
## Auto-Post Tags
|
||||
|
||||
@@ -46,6 +55,7 @@ post_tags:
|
||||
comment: |
|
||||
__[Click here if your post says "Sorry, this post was removed by Reddit’s filters"](...)__
|
||||
status: enabled
|
||||
flair_id: 12345678-aaaa-bbbb-cccc-1234567890ab
|
||||
```
|
||||
|
||||
- **tag**: Comma-separated list of tags. The bot matches tags in post titles (case-insensitive).
|
||||
@@ -54,17 +64,23 @@ post_tags:
|
||||
- `enabled`: Bot will comment automatically.
|
||||
- `log-only`: Bot will log but not comment.
|
||||
- `disabled`: Bot will not act on this tag.
|
||||
- **flair_id**: Optional. Set post flair by ID.
|
||||
|
||||
## Chat-Based Config Reload
|
||||
- To reload the wiki config, send a chat message containing `reload-config` to the bot account from a moderator account.
|
||||
- The bot will reply to the chat message indicating whether the config is valid or not.
|
||||
- Chat message IDs are tracked in `/DB/chat_wiki_requests.txt` to prevent duplicate reloads after restarts.
|
||||
|
||||
## Additional Notes
|
||||
- The bot only comments once per trigger per post (even if triggered multiple times).
|
||||
- The bot only auto-comments once per post for each tag.
|
||||
- All bot actions are logged for transparency.
|
||||
- If the wiki config is invalid, the bot will notify mods via modmail and pause until fixed.
|
||||
- If the wiki config is invalid, the bot will reply to the chat message with an error.
|
||||
|
||||
## Troubleshooting
|
||||
- Make sure your wiki config is valid YAML and includes both `triggers` and `post_tags` sections.
|
||||
- Use old.reddit.com for wiki editing to avoid formatting issues.
|
||||
- Check bot logs for errors and modmail for config issues.
|
||||
- Check bot logs for errors and chat replies for config issues.
|
||||
|
||||
## Example Wiki Config Excerpt
|
||||
```
|
||||
@@ -74,9 +90,14 @@ triggers:
|
||||
Thank you for your report!
|
||||
This post is now approved.
|
||||
status: enabled
|
||||
flair_id: 12345678-aaaa-bbbb-cccc-1234567890ab
|
||||
stickied: true
|
||||
lock_post: false
|
||||
lock_comment: false
|
||||
post_tags:
|
||||
- tag: Bedrock, Java
|
||||
comment: |
|
||||
__[Click here if your post says "Sorry, this post was removed by Reddit’s filters"](...)__
|
||||
status: enabled
|
||||
flair_id: 12345678-aaaa-bbbb-cccc-1234567890ab
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user