diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 31 |
1 files changed, 9 insertions, 22 deletions
@@ -5,34 +5,20 @@ 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 -- **Surge-Based Roleplay Limiter**: Dynamically adjusts roleplay post limits based on subreddit activity +- **Intelligent Roleplay Moderator**: Uses GPT-5-nano to evaluate roleplay 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 -### Roleplay Limiting Options +### Intelligent Roleplay Moderation -The bot supports two roleplay limiting modes: +The bot features an advanced AI-powered roleplay moderator that: -#### Surge-Based Limiting (Default) - -Intelligent surge detection that adjusts limits based on subreddit activity: - -- **Normal Activity** (< 20 roleplay posts): Users can post up to 5 roleplay posts per time window -- **Moderate Surge** (20+ roleplay posts): Users limited to 3 roleplay posts per time window -- **High Surge** (40+ roleplay posts): Users limited to 1 roleplay post per time window -- **Extreme Surge** (60+ roleplay posts): All roleplay posts temporarily blocked - -#### Static Limiting (Optional) - -Fixed limit that doesn't change based on activity: - -- **Fixed Limit**: Users can post a configurable number of roleplay posts per time window (default: 1) -- **Simple**: No surge detection, just enforces the same limit for all users -- **Predictable**: Consistent behavior regardless of subreddit activity - -To switch to static limiting, uncomment the `StaticRoleplayLimiter` line in `src/umabot/bot.py` and comment out the `RoleplayLimiter` line. +- **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 +- **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 ## Quick Start @@ -68,7 +54,8 @@ REDDIT_CLIENT_ID=your_client_id_here REDDIT_CLIENT_SECRET=your_client_secret_here REDDIT_USERNAME=your_reddit_username REDDIT_PASSWORD=your_reddit_password -REDDIT_USER_AGENT=UmaBot/0.1.0 +# OpenAI API Credentials +OPENAI_API_KEY=your_openai_api_key_here # Subreddit Configuration SUBREDDIT_NAME=your_subreddit_name |