From adf9e0f9d5567c0df2214954ac544f8ab919db26 Mon Sep 17 00:00:00 2001 From: Viktor AI Date: Thu, 7 May 2026 22:33:10 +0000 Subject: [PATCH] =?UTF-8?q?Add=20NewHelpMenu=20v1.0.0=20=E2=80=94=20fully?= =?UTF-8?q?=20customisable=20interactive=20help=20system?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 1,573-line cog with total configurability over every aspect: Layouts: 6 category layouts (fields/description/inline/numbered/table), 3 home layouts (list/grid/minimal), configurable columns (1-3) Themes: 4 built-in (default/minimal/compact/dark) + full custom mode Navigation: 4 nav styles (full/compact/arrows_only/select_only), select menu dropdown, button navigation, pagination Button customisation: every button label, emoji, and style is configurable (home/prev/next/search/favourites/close) Categories: unlimited custom categories with emoji, colour, thumbnail, image, description, ordering, role-gating, hide/unhide Visibility: hide cogs, hide commands, role-gated categories, permission-based filtering Extras: modal search, per-user favourites, quick-link URL buttons, custom home fields, DM help, ephemeral mode, auto-delete, embed author, tagline, export config, command detail views 70+ admin commands across 10+ command groups. --- README.md | 239 +++++- info.json | 2 +- newhelpmenu/__init__.py | 13 + newhelpmenu/info.json | 30 + newhelpmenu/newhelpmenu.py | 1573 ++++++++++++++++++++++++++++++++++++ 5 files changed, 1847 insertions(+), 10 deletions(-) create mode 100644 newhelpmenu/__init__.py create mode 100644 newhelpmenu/info.json create mode 100644 newhelpmenu/newhelpmenu.py diff --git a/README.md b/README.md index 846659d..493e2ea 100644 --- a/README.md +++ b/README.md @@ -6,10 +6,225 @@ 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 wormhole -[p]load wormhole +[p]cog install EveCogs +[p]load ``` +### 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 + +**The ultimate customisable help system 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. + +## โœจ Features + +### ๐ŸŽจ 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 + +### ๐Ÿ“‚ 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 + +### ๐Ÿ”˜ 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`) +| 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