diff options
| author | Fuwn <[email protected]> | 2025-09-19 16:08:58 -0700 |
|---|---|---|
| committer | Fuwn <[email protected]> | 2025-09-19 16:08:58 -0700 |
| commit | b28fc51ef081f80e688e95e47072b21236710b71 (patch) | |
| tree | a13e42192ee79f139f043c1c60d5412cc3652171 /README.md | |
| parent | fix(irm): Missing media attribute handling (diff) | |
| download | umabot-b28fc51ef081f80e688e95e47072b21236710b71.tar.xz umabot-b28fc51ef081f80e688e95e47072b21236710b71.zip | |
feat: Update strings from roleplay to in character
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 48 |
1 files changed, 24 insertions, 24 deletions
@@ -5,18 +5,18 @@ A modular Reddit bot for automated post moderation built with Python and PRAW. ## Features - **Spam Detection**: Automatically removes posts from users who post more than 3 times in 24 hours -- **Intelligent Roleplay Moderator**: Uses GPT-5-nano to evaluate roleplay posts and make smart moderation decisions +- **Intelligent In-Character Moderator**: Uses GPT-5-nano to evaluate in-character posts and make smart moderation decisions - **Modular Design**: Easy to add new moderation rules - **Configurable Messages**: Customizable removal messages - **Dry Run Mode**: Test the bot without actually removing posts - **Comprehensive Logging**: Detailed logs for monitoring and debugging -### Intelligent Roleplay Moderation +### Intelligent In-Character Moderation -The bot features an advanced AI-powered roleplay moderator that: +The bot features an advanced AI-powered in-character moderator that: -- **Auto-Flairing**: Automatically changes roleplay posts to "Art" flair when they're primarily showcasing artwork -- **Quality Control**: Removes low-effort roleplay posts while preserving high-quality content +- **Auto-Flairing**: Automatically changes in-character posts to "Art" flair when they're primarily showcasing artwork +- **Quality Control**: Removes low-effort in-character posts while preserving high-quality content - **Smart Evaluation**: Uses GPT-5-nano to analyze post content, creativity, effort, and engagement potential - **User Communication**: Sends detailed mod mail explaining decisions and providing guidance @@ -61,7 +61,7 @@ OPENAI_API_KEY=your_openai_api_key_here SUBREDDIT_NAME=your_subreddit_name # Bot Messages -ROLEPLAY_MESSAGE=Your post has been removed. Only one roleplay post is allowed per user. +ROLEPLAY_MESSAGE=Your post has been removed. Only one in-character post is allowed per user. # Bot Settings CHECK_INTERVAL=60 @@ -158,24 +158,24 @@ The bot can be deployed on any platform that supports Python: ### Environment Variables -| Variable | Description | Default | -| ----------------------------- | ------------------------------------------ | -------------- | -| `REDDIT_CLIENT_ID` | Reddit API client ID | Required | -| `REDDIT_CLIENT_SECRET` | Reddit API client secret | Required | -| `REDDIT_USERNAME` | Reddit bot username | Required | -| `REDDIT_PASSWORD` | Reddit bot password | Required | -| `REDDIT_USER_AGENT` | User agent string | `UmaBot/0.1.0` | -| `SUBREDDIT_NAME` | Target subreddit name | Required | -| `ROLEPLAY_MESSAGE` | Message for roleplay removals | Customizable | -| `CHECK_INTERVAL` | Seconds between checks | `60` | -| `MAX_POSTS_PER_DAY` | Max posts per user in time window | `3` | -| `MAX_ROLEPLAY_POSTS_PER_DAY` | Max roleplay posts per user in time window | `1` | -| `POST_LIMIT_WINDOW_HOURS` | Time window for post limits (hours) | `24` | -| `ROLEPLAY_LIMIT_WINDOW_HOURS` | Time window for roleplay limits (hours) | `24` | -| `ROLEPLAY_SURGE_THRESHOLD_1` | First surge threshold for roleplay posts | `20` | -| `ROLEPLAY_SURGE_THRESHOLD_2` | Second surge threshold for roleplay posts | `40` | -| `ROLEPLAY_SURGE_THRESHOLD_3` | Third surge threshold for roleplay posts | `60` | -| `DRY_RUN` | Enable dry-run mode | `false` | +| Variable | Description | Default | +| ----------------------------- | ---------------------------------------------- | -------------- | +| `REDDIT_CLIENT_ID` | Reddit API client ID | Required | +| `REDDIT_CLIENT_SECRET` | Reddit API client secret | Required | +| `REDDIT_USERNAME` | Reddit bot username | Required | +| `REDDIT_PASSWORD` | Reddit bot password | Required | +| `REDDIT_USER_AGENT` | User agent string | `UmaBot/0.1.0` | +| `SUBREDDIT_NAME` | Target subreddit name | Required | +| `ROLEPLAY_MESSAGE` | Message for in-character removals | Customizable | +| `CHECK_INTERVAL` | Seconds between checks | `60` | +| `MAX_POSTS_PER_DAY` | Max posts per user in time window | `3` | +| `MAX_ROLEPLAY_POSTS_PER_DAY` | Max in-character posts per user in time window | `1` | +| `POST_LIMIT_WINDOW_HOURS` | Time window for post limits (hours) | `24` | +| `ROLEPLAY_LIMIT_WINDOW_HOURS` | Time window for in-character limits (hours) | `24` | +| `ROLEPLAY_SURGE_THRESHOLD_1` | First surge threshold for in-character posts | `20` | +| `ROLEPLAY_SURGE_THRESHOLD_2` | Second surge threshold for in-character posts | `40` | +| `ROLEPLAY_SURGE_THRESHOLD_3` | Third surge threshold for in-character posts | `60` | +| `DRY_RUN` | Enable dry-run mode | `false` | ## Development |