Skip to content

README.md

Latest commit

 

History

History
85 lines (58 loc) · 3.57 KB

README.md

File metadata and controls

85 lines (58 loc) · 3.57 KB

RotMG Raid Bot — Documentation

Complete documentation for the Discord raid coordination bot designed for Realm of the Mad God guilds.

Documentation Version: Reflects v1.1 behavior and features. Last updated December 2025.

Overview

This bot provides automated raid management, member verification, quota tracking, and moderation tools for large-scale Realm of the Mad God raiding guilds. It combines a Discord bot with a REST API backend and PostgreSQL database.

Start Here

Choose your path:

Your Role Read This First Then Read
Guild Administrator (first-time setup) Setup Guide Verification
Organizer (running raids) Raid Management Quota System
Security/Officer (moderation) Moderation Verification
Developer (contributing code) Architecture All operator docs

Documentation Files

Document Purpose Audience
setup.md Initial bot installation and guild configuration Administrators
verification.md Member verification workflows (RealmEye + manual) Security, Admins
raid-management.md Creating runs, headcounts, party finder, key tracking Organizers
quota-system.md Quota requirements, points, leaderboards Officers, Organizers
moderation.md Punishments, modmail, notes, message management Security, Officers
architecture.md Technical architecture and development guide Contributors

Role Hierarchy

The bot enforces this permission hierarchy (higher roles inherit all permissions of roles below them):

Role Typical Use Key Permissions
Administrator Guild owner, head staff All commands, bulk sync, force verification
Moderator Senior staff Message purge, all moderation actions
Head Organizer Lead raid organizers All raid commands, quota adjustments
Officer Promoted staff Kick/ban, quota management, modmail blacklist
Security Verification & discipline Verify, warn, suspend, mute, notes
Organizer Run raid events Create runs, log runs, log keys
Team Special access group (Optional custom permissions)
Verified Raider Verified members Join runs, create party finder posts

Note: Roles are mapped to Discord roles during setup. See setup.md for configuration.

Quick Start Flow

For new guilds getting started:

  1. Install the bot — Invite bot, configure environment
  2. Map roles — Run /setroles to map internal roles to Discord roles
  3. Map channels — Run /setchannels to configure log channels
  4. Test verification — Verify yourself to confirm setup
  5. Create first run — Test the raid system
  6. Configure quota — Set organizer requirements (optional)

Support

  • Issues & Bugs: Open an issue in the repository
  • Questions: Review relevant documentation first
  • Contributing: See architecture.md for development setup

Version

Current Version: 1.1
Last Updated: December 2025
Status: Production Ready