diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..40041a9 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +wormhole/__pycache__/ diff --git a/README.md b/README.md index 493e2ea..0c99644 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# ๐ŸŒ€ EveCogs +# EveCogs A premium cog repository for [Red-DiscordBot](https://github.com/Cog-Creators/Red-DiscordBot). @@ -6,438 +6,164 @@ A premium cog repository for [Red-DiscordBot](https://github.com/Cog-Creators/Re ``` [p]repo add EveCogs https://github.com/everestmcarthur/EveCogs -[p]cog install EveCogs -[p]load +[p]cog install EveCogs wormhole +[p]load wormhole ``` -### Available Cogs - -| Cog | Description | -|-----|-------------| -| **[Wormhole](#-wormhole-v320)** | Ultimate cross-server message relay โ€” DM relay, starboard, karma, auto-mod, 50+ commands | -| **[NewHelpMenu](#-new-help-menu-v100)** | Fully customisable interactive help system โ€” categories, buttons, themes, search, favourites | - --- -# ๐Ÿ“– New Help Menu v1.0.0 +# Wormhole v3.3.0 -**The ultimate customisable help system for Red-DiscordBot.** +**The ultimate cross-server message relay for Red-DiscordBot.** -Completely replaces Red's default help formatter with a modern, interactive experience powered by Discord buttons, select menus, modals, and rich embeds. Every aspect is configurable โ€” from categories and colours to button styles and role gating. +Connect Discord channels across unlimited servers into named networks. Messages, edits, deletes, reactions, replies, stickers, pins, typing indicators, and files are all relayed in real-time. -## โœจ Features +## Feature Highlights -### ๐ŸŽจ Themes & Branding -- **4 built-in themes** โ€” `default`, `minimal`, `compact`, `dark` -- **Full custom mode** โ€” control every visual aspect independently -- **Custom accent colours** โ€” per-server or per-category -- **Thumbnails & images** โ€” custom icons on home page and per-category -- **Title, description, tagline, footer** โ€” fully templated with `{bot_name}` and `{prefix}` placeholders -- **Footer icons** โ€” custom footer branding +| Category | Features | +|----------|----------| +| **Relay** | Webhook / embed / compact modes, edit & delete sync, reply threading, sticker forwarding, pin sync, typing indicators, file relay | +| **DM Relay** | Bidirectional DM โ†” network messaging, quiet hours, personal ignore lists | +| **Moderation** | Ban/mute users & servers, word + regex filters, attachment filters, global blocklist, purge | +| **Auto-Mod** | Anti-spam, anti-raid, anti-caps, anti-invite, anti-link, anti-zalgo, anti-spoiler, anti-emote-spam, anti-newlines | +| **Staff** | Staff system, ownership transfer, audit log, announcements | +| **Invites** | Invite codes, vanity URLs, expiry, max uses, allowlists | +| **Social** | Karma/reputation, starboard, user profiles, keyword highlights | +| **Scheduling** | Scheduled messages, blackout windows, relay delay, slowmode | +| **Phase 4** | Anonymous mode, mirror channels, polls, AFK, auto-responses, ephemeral messages, media-only, analytics, health monitor, bookmarks, user colours, quiet hours, network bridging | -### ๐Ÿ“‚ Custom Categories -- **Create unlimited categories** โ€” group cogs however you want -- **Per-category customisation** โ€” emoji, colour, thumbnail, image, description -- **Ordering** โ€” set display order for each category -- **Role gating** โ€” restrict category visibility to specific roles -- **Hide/unhide** โ€” toggle category visibility -- **Auto-categories** โ€” uncategorised cogs get their own section automatically -- **Rename** โ€” change category labels on the fly +## Command Reference -### ๐Ÿ”˜ Interactive Navigation -- **Select menu dropdown** โ€” jump between categories instantly -- **Button navigation** โ€” category buttons when select menus are disabled -- **Pagination** โ€” โ—€๏ธ โ–ถ๏ธ buttons with page counter -- **Command detail view** โ€” click into any command for full docs, subcommands, aliases -- **Back navigation** โ€” return to previous views seamlessly -- **Close button** โ€” dismiss the menu - -### ๐Ÿ” Search -- **Modal search** โ€” pop-up search dialog searches command names, descriptions, aliases, and help text -- **Results view** โ€” shows matching commands with their category -- **Fuzzy matching** โ€” finds commands across all categories - -### โญ Favourites -- **Per-user favourites** โ€” save frequently-used commands -- **Star button** โ€” add/remove favourites from the detail view -- **Favourites page** โ€” quick access from the main menu -- **Command-based** โ€” `[p]fav ` to toggle - -### ๐Ÿ›ก๏ธ Visibility Control -- **Hide cogs** โ€” remove entire cogs from help -- **Hide commands** โ€” blacklist specific commands -- **Show hidden** โ€” toggle visibility of hidden commands for admins -- **Permission-based filtering** โ€” only shows commands the user can actually run -- **Role-gated categories** โ€” restrict categories to certain roles - -### โš™๏ธ Display Options -- **Aliases** โ€” show/hide command aliases -- **Cooldowns** โ€” show/hide cooldown info -- **Permissions** โ€” show/hide required permission levels -- **Signatures** โ€” show/hide command usage signatures -- **Timestamps** โ€” toggle embed timestamps -- **Subcommand counts** โ€” groups show number of subcommands - -### ๐Ÿ”— Quick Links -- **URL buttons** โ€” add up to 5 link buttons (support server, docs, website, etc.) -- **Custom emoji** โ€” set emoji per link button - -### ๐Ÿ“ง Delivery Options -- **DM help** โ€” send help to DMs instead of the channel -- **Ephemeral mode** โ€” only visible to the user (slash command contexts) -- **Auto-delete** โ€” delete help messages after configurable seconds -- **Timeout** โ€” interactive view timeout (default 3 minutes) - -### ๐Ÿ  Home Page Extras -- **Custom fields** โ€” add informational fields to the home embed -- **Home image** โ€” large image on the home page -- **Category overview** โ€” shows all categories with command counts - -## ๐Ÿ“‹ Quick Start - -``` -[p]cog install EveCogs newhelpmenu -[p]load newhelpmenu -``` - -That's it! The default help command is now interactive. Customise further: - -``` -[p]helpmenu theme dark -[p]helpmenu colour #FF6B6B -[p]helpmenu title "๐Ÿค– {bot_name} Commands" -[p]helpmenu desc "Use the menu below to browse all commands!" -[p]helpmenu tagline "Powered by EveCogs" - -[p]helpmenu cat create Moderation ๐Ÿ›ก๏ธ All moderation commands -[p]helpmenu cat addcog Moderation Mod -[p]helpmenu cat addcog Moderation AutoMod -[p]helpmenu cat colour Moderation #E74C3C - -[p]helpmenu cat create Fun ๐ŸŽฎ Games and entertainment -[p]helpmenu cat addcog Fun Trivia -[p]helpmenu cat addcog Fun CustomCommands - -[p]helpmenu quicklink add "Support" https://discord.gg/your-server ๐Ÿ”— -[p]helpmenu quicklink add "Docs" https://your-docs-site.com ๐Ÿ“„ - -[p]helpmenu set selectmenu on -[p]helpmenu set buttons on -[p]helpmenu set aliases on -[p]helpmenu set dmhelp off -[p]helpmenu set maxperpage 10 - -[p]helpmenu preview -``` - -## ๐Ÿ“– Command Reference - -### Main Settings (`[p]helpmenu` / `[p]hm`) +### Core | Command | Description | |---------|-------------| -| `helpmenu toggle` | Enable/disable the custom help menu | -| `helpmenu theme ` | Set theme: default, minimal, compact, dark, custom | -| `helpmenu colour ` | Set accent colour | -| `helpmenu resetcolour` | Reset to bot default colour | -| `helpmenu thumbnail [url]` | Set/reset home thumbnail | -| `helpmenu title ` | Set title (supports `{bot_name}`, `{prefix}`) | -| `helpmenu description ` | Set home description | -| `helpmenu footer ` | Set footer text | -| `helpmenu footericon [url]` | Set footer icon | -| `helpmenu tagline [text]` | Set/clear tagline | -| `helpmenu homeimage [url]` | Set/reset home page image | -| `helpmenu buttonstyle