diff --git a/README.md b/README.md index ac880cd..7372d4c 100644 --- a/README.md +++ b/README.md @@ -40,9 +40,48 @@ GuardDen is a comprehensive Discord moderation bot designed to protect your comm ### Prerequisites - Python 3.11+ - PostgreSQL 15+ -- Discord Bot Token ([Discord Developer Portal](https://discord.com/developers/applications)) +- Discord Bot Token (see setup below) - (Optional) Anthropic or OpenAI API key for AI features +### Discord Bot Setup + +1. Go to the [Discord Developer Portal](https://discord.com/developers/applications) +2. Click **New Application** and give it a name (e.g., "GuardDen") +3. Go to the **Bot** tab and click **Add Bot** + +4. **Configure Bot Settings:** + - Disable **Public Bot** if you only want yourself to add it + - Copy the **Token** (click "Reset Token") - this is your `DISCORD_TOKEN` + +5. **Enable Privileged Gateway Intents** (all three required): + - **Presence Intent** - for user status tracking + - **Server Members Intent** - for member join/leave events, verification + - **Message Content Intent** - for reading messages (automod, AI moderation) + +6. **Generate Invite URL** - Go to **OAuth2** > **URL Generator**: + + **Scopes:** + - `bot` + - `applications.commands` + + **Bot Permissions:** + - Manage Roles + - Kick Members + - Ban Members + - Moderate Members (timeout) + - Manage Channels + - View Channels + - Send Messages + - Manage Messages + - Embed Links + - Attach Files + - Read Message History + - Add Reactions + + Or use permission integer: `1239943348294` + +7. Use the generated URL to invite the bot to your server + ### Docker Deployment (Recommended) 1. Clone the repository: