From 2df0d504d0f4cad7532e6c14902dd2967c3cd5cf Mon Sep 17 00:00:00 2001 From: Viktor Date: Thu, 14 May 2026 20:38:04 +0000 Subject: [PATCH] docs: add per-cog README files for all 8 cogs Generated comprehensive README documentation for each cog: - dashboard (EveDash): Web dashboard setup & commands - newhelpmenu: Components V2 help system - nexuscore: All-in-one management (tickets, mod, economy, etc.) - selfbotguard: 14-layer selfbot detection - serverwhitelist: Server join management - userslash: User-installable slash commands - voicemeister: Temporary voice channels - wormhole: Cross-server relay (100+ commands) Each README includes: features, installation, commands, data statement. --- dashboard/README.md | 53 +++++++++++++ newhelpmenu/README.md | 59 +++++++++++++++ nexuscore/README.md | 93 +++++++++++++++++++++++ selfbotguard/README.md | 74 ++++++++++++++++++ serverwhitelist/README.md | 84 +++++++++++++++++++++ userslash/README.md | 84 +++++++++++++++++++++ voicemeister/README.md | 95 +++++++++++++++++++++++ wormhole/README.md | 154 ++++++++++++++++++++++++++++++++++++++ 8 files changed, 696 insertions(+) create mode 100644 dashboard/README.md create mode 100644 newhelpmenu/README.md create mode 100644 nexuscore/README.md create mode 100644 selfbotguard/README.md create mode 100644 serverwhitelist/README.md create mode 100644 userslash/README.md create mode 100644 voicemeister/README.md create mode 100644 wormhole/README.md diff --git a/dashboard/README.md b/dashboard/README.md new file mode 100644 index 0000000..422f46e --- /dev/null +++ b/dashboard/README.md @@ -0,0 +1,53 @@ +# EveDash + +A modern, self-contained web dashboard for Red-DiscordBot. + +## Features + +- **Discord OAuth2 Login** — Secure authentication via Discord +- **Guild Management** — View and manage all guilds the bot is in +- **Cog Control** — Load, unload, and reload cogs from the browser +- **Command Toggles** — Enable/disable commands per-guild +- **Real-Time WebSocket** — Live updates for messages, members, and events +- **SDK for Cogs** — Any cog can register its own settings pages with just a few lines of code + +## Requirements + +- `aiohttp` +- Red-DiscordBot >= 3.5.0 + +## Installation + +``` +[p]repo add EveCogs https://github.com/everestmcarthur/EveCogs +[p]cog install EveCogs dashboard +[p]load dashboard +``` + +## Setup + +``` +[p]evedash setup +``` + +Follow the interactive setup wizard to configure Discord OAuth2 credentials and server settings. + +## Commands + +| Command | Description | +|---------|-------------| +| `[p]evedash` | Show dashboard status and URL | +| `[p]evedash setup` | Interactive setup wizard | +| `[p]evedash port ` | Set the web server port | +| `[p]evedash host ` | Set the web server host/bind address | +| `[p]evedash secret ` | Set the Discord OAuth2 client secret | +| `[p]evedash clientid ` | Set the Discord OAuth2 client ID | +| `[p]evedash redirect ` | Set the OAuth2 redirect URI | + +## Data Statement + +This cog stores Discord user IDs for authentication sessions and blacklist management. No message content is stored. + +## License + +MIT diff --git a/newhelpmenu/README.md b/newhelpmenu/README.md new file mode 100644 index 0000000..b217306 --- /dev/null +++ b/newhelpmenu/README.md @@ -0,0 +1,59 @@ +# NewHelpMenu + +Components V2 help menu + global embed/menu override for Red-DiscordBot. + +## Features + +- **Components V2 Help** — Replaces Red's entire help system with Discord's Components V2 (containers, sections, text displays, thumbnails, media galleries, separators) +- **Global Embed Override** — Optionally converts ALL bot embeds and menus into Components V2 layouts +- **Categories** — Group cogs into custom categories for organized help pages +- **Accent Colours** — Customizable colour scheme per-server +- **Layout Modes** — Multiple layout styles for help pages +- **Paginated Navigation** — Interactive buttons for browsing commands +- **Select Menus** — Quick-jump to any cog or command + +## Requirements + +- Red-DiscordBot >= 3.5.21 +- Python >= 3.9 + +## Installation + +``` +[p]repo add EveCogs https://github.com/everestmcarthur/EveCogs +[p]cog install EveCogs newhelpmenu +[p]load newhelpmenu +``` + +> ⚠️ This cog replaces Red's built-in `help` command. The original is restored on unload. + +## Quick Start + +``` +[p]cv2 toggle # Enable Components V2 (off by default) +[p]cv2 settings # View all current settings +[p]cv2 color # Set accent colour +[p]cv2 category add ... # Group cogs into categories +``` + +## Commands + +| Command | Description | +|---------|-------------| +| `[p]cv2 toggle` | Enable/disable Components V2 mode | +| `[p]cv2 settings` | View current configuration | +| `[p]cv2 color ` | Set accent colour | +| `[p]cv2 category add ` | Create a cog category | +| `[p]cv2 category remove ` | Remove a category | +| `[p]cv2 category list` | List all categories | +| `[p]help` | Show the help menu (replaced) | +| `[p]help ` | Show help for a specific command | +| `[p]help ` | Show help for a specific cog | + +## Data Statement + +This cog stores per-guild configuration. No personal user data is stored. + +## License + +MIT diff --git a/nexuscore/README.md b/nexuscore/README.md new file mode 100644 index 0000000..9b9aaca --- /dev/null +++ b/nexuscore/README.md @@ -0,0 +1,93 @@ +# NexusCore v2.0.0 + +The ultimate all-in-one server management cog for Red-DiscordBot. 10 modules, 100+ commands. + +## Modules + +| Module | Description | +|--------|-------------| +| 🎫 **Tickets** | Panel-based creation, categories, custom questions, staff claim, priority levels, HTML transcripts, auto-close, feedback | +| 📝 **Applications** | Multi-type forms, multi-page modals (10+ questions), review system, auto-role, staff notes, cooldowns | +| 💡 **Suggestions** | Voting, 10 status types, anonymous mode, auto-thread, staff responses, categories, leaderboard | +| 🎭 **Reaction Roles** | Button/select/reaction modes, exclusive groups, sticky/temp roles, max picks, persistent | +| 🎉 **Giveaways** | Button-entry, role requirements, bonus entries, drop mode, recurring, DM notifications | +| 📋 **Server Logging** | 30+ event types, per-event routing, message cache, invite tracking, ignore filters | +| 🛡️ **Moderation** | Case system, warnings with auto-escalation, quarantine, reputation, appeal system, anti-raid/nuke | +| 💰 **Economy** | Wallet/bank, daily/weekly, work/crime, gambling (coinflip/slots/blackjack/roulette/dice), shop, pets, heist, auction house | +| 🎨 **Embed Builder** | Webhook-based, Sapphire-style, templates, scheduling, variables | +| 📊 **Dashboard** | Web config integration for all modules (requires EveDash) | + +## Requirements + +- Red-DiscordBot >= 3.5.0 +- Python >= 3.9 + +## Installation + +``` +[p]repo add EveCogs https://github.com/everestmcarthur/EveCogs +[p]cog install EveCogs nexuscore +[p]load nexuscore +``` + +## Quick Start + +``` +[p]nexus # Module overview & version +[p]ticket setup #category #logs # Set up tickets +[p]apply setup #review # Set up applications +[p]suggest setup #suggestions # Set up suggestions +[p]roles create #channel button Title # Create a role panel +[p]gw start #channel 1d 1 Prize # Start a giveaway +[p]serverlog enable #logs # Enable logging (30+ events) +[p]nmod setup #modlog # Set up moderation +[p]eco balance # Check economy balance +[p]eb create # Interactive embed builder +``` + +## Key Commands + +### Tickets +| Command | Description | +|---------|-------------| +| `[p]ticket setup ` | Set up the ticket system | +| `[p]ticket panel ` | Send a ticket creation panel | +| `[p]ticket close [reason]` | Close a ticket | +| `[p]ticket add/remove ` | Add/remove user from ticket | +| `[p]ticket claim` | Claim a ticket as staff | +| `[p]ticket priority ` | Set ticket priority | +| `[p]ticket transcript` | Export HTML transcript | + +### Moderation +| Command | Description | +|---------|-------------| +| `[p]nmod setup ` | Set up moderation | +| `[p]nmod warn [reason]` | Warn a user (auto-escalates) | +| `[p]nmod mute/unmute ` | Mute/unmute | +| `[p]nmod kick/ban ` | Kick/ban | +| `[p]nmod case ` | View a case | +| `[p]nmod history ` | User's moderation history | +| `[p]nmod quarantine ` | Quarantine a user | +| `[p]nmod lockdown` | Lock the server | + +### Economy +| Command | Description | +|---------|-------------| +| `[p]eco balance` | Check balance | +| `[p]eco daily / weekly` | Claim rewards | +| `[p]eco work / crime` | Earn money | +| `[p]eco coinflip / slots / blackjack` | Gamble | +| `[p]eco shop / buy / inventory` | Shop system | +| `[p]eco pet adopt ` | Adopt a pet | +| `[p]eco heist ` | Start a multiplayer heist | +| `[p]eco leaderboard` | View rankings | + +*Full command reference: `[p]help NexusCore`* + +## Data Statement + +This cog stores Discord user IDs, guild IDs, and channel IDs. Per-user data includes: ticket history, application submissions, suggestion authorship, moderation cases/warnings/notes, economy balances/inventories/pets/transactions, giveaway entries, and reaction role state. + +## License + +MIT diff --git a/selfbotguard/README.md b/selfbotguard/README.md new file mode 100644 index 0000000..3b8ab14 --- /dev/null +++ b/selfbotguard/README.md @@ -0,0 +1,74 @@ +# SelfbotGuard v1.2.0 + +Advanced selfbot detection with 14 heuristic layers and configurable per-server punishments for Red-DiscordBot. + +## Detection Layers + +| # | Heuristic | What it detects | +|---|-----------|-----------------| +| 1 | Rich-embed abuse | Selfbots sending embeds (regular users can't) | +| 2 | Inhuman response time | Replies faster than humanly possible | +| 3 | Timing precision | Unnaturally consistent message intervals | +| 4 | 24/7 activity | No sleep/break patterns | +| 5 | Pattern matching | Automated command-response sequences | +| 6 | Burst detection | Rapid-fire message floods | +| 7 | Cross-channel spam | Same message blasted across channels | +| 8 | Cross-server activity | Messages in different servers within impossible windows | +| 9 | Edit cadence | Suspiciously regular edit timing | +| 10 | Presence anomalies | Messaging while offline/invisible | +| 11 | Reaction sniping | Reacting inhumanly fast (giveaway sniping) | +| 12 | Formatting analysis | Suspiciously clean formatting at speed | +| 13 | Trigger-word sniping | Instant response to giveaway/nitro keywords | +| 14 | Self-delete patterns | Automated self-deletion behaviour | + +Each heuristic contributes to a cumulative suspicion score per user. When the score exceeds the configurable threshold, action is taken. + +## Requirements + +- Red-DiscordBot >= 3.5.0 +- Python >= 3.9 + +## Installation + +``` +[p]repo add EveCogs https://github.com/everestmcarthur/EveCogs +[p]cog install EveCogs selfbotguard +[p]load selfbotguard +``` + +> ⚠️ The cog is **disabled by default** — enable per-server with `[p]sbguard enable`. + +## Commands + +### Prefix Commands (`[p]sbguard`) +| Command | Description | +|---------|-------------| +| `[p]sbguard enable` | Enable detection in this server | +| `[p]sbguard disable` | Disable detection | +| `[p]sbguard action ` | Set punishment: `warn`, `mute`, `kick`, `ban`, `log` | +| `[p]sbguard sensitivity ` | Set sensitivity: `low`, `medium`, `high`, `paranoid` | +| `[p]sbguard threshold ` | Set custom suspicion threshold | +| `[p]sbguard logchannel <#channel>` | Set the alert/log channel | +| `[p]sbguard muteduration