From a5771638bb204801005eeaeb84921c7da2ca0f60 Mon Sep 17 00:00:00 2001 From: Unstable Kitsune Date: Wed, 24 Sep 2025 00:36:00 -0400 Subject: [PATCH] Add mors --- mors.md | 68 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 68 insertions(+) create mode 100644 mors.md diff --git a/mors.md b/mors.md new file mode 100644 index 0000000..461dc74 --- /dev/null +++ b/mors.md @@ -0,0 +1,68 @@ +# MORS Cog (Mass Outreach & Review System) + +The MORS cog is a powerful, multi-step workflow application designed to manage a server's mass outreach and review process. It provides a structured path for users to submit advertisements for review and for administrators to manage the queue. + +--- + +## 1. Features + +- **Complete Workflow:** Manages the entire outreach process from a user's initial submission to an administrator's final approval. +- **User-Run Submissions:** Allows regular, permissioned users to initiate the process with the `/game` command. +- **Form-Based & Interactive:** Uses Discord Modals for ad submissions and Select Menus for time selection, creating a clean user experience. +- **Admin-Controlled Queue:** Administrators have full control over when ads are posted to the public channel. +- **Dual-Channel Messaging:** Sends notifications to both the user's private ticket and public staff-facing channels. +- **Hybrid Commands:** All commands are fully hybridized, working with both slash commands (`/`) and your bot's prefix (`[p]`). + +--- + +## 2. The MORS Workflow + +1. A user with the required role runs the `/game` command. This opens a pop-up form for them to submit their server ad and link. +2. The bot creates a private ticket channel for the user and posts their submitted ad **privately** inside it for admin review. +3. An administrator reviews the ad. If it is approved, they run the `/posted @user` command. +4. The bot then posts the ad to the public ad channel, pins it, and notifies the user in their ticket that they can proceed. +5. The user runs the `/over` command in their ticket, which presents a dropdown menu to select the ad's duration. This renames the ticket. +6. After the time is up, an administrator runs the `/done @user` command to finalize the process. +7. The bot notifies the user in their ticket that the process is complete and instructs them to run `/pudding-head` to leave a final review. +8. The user runs `/pudding-head`, which opens a review form. Their review is sent to a public review channel, and their ticket is automatically archived. + +--- + +## 3. User Commands + +These commands are intended for regular users who have the required "access role." + +- `/game` + - Starts the MORS submission process and opens the ad submission form. +- `/over` + - Can only be run inside an active MORS ticket. Opens the time selection menu. +- `/pudding-head` + - Can only be run inside an active MORS ticket after the `/done` command has been run by an admin. Opens the final review form. + +--- + +## 4. Admin Commands + +These commands require `Manage Server` permissions. + +- `/posted ` + - Approves a pending ad from a user and posts it to the public ad channel. +- `/done ` + - Finalizes a MORS ticket, notifies the user, and prepares the ticket for review and closure. + +### `/morsset` + +The main command group for configuring the MORS system. + +**Prefix Version:** `[p]morsset` + +- `/morsset adchannel <#channel>` + - Sets the public channel where approved ads are posted. +- `/morsset ticketcategory <#category>` + - Sets the category where new MORS tickets are created. +- `/morsset accessrole <@role>` + - Sets the role required for users to run the `/game` command. +- `/morsset bypassrole <@role>` + - Sets the special role that can use restricted options, like the "4h" option in the `/over` command. +- `/morsset reviewchannel <#channel>` + - Sets the channel where final reviews from `/pudding-head` are sent. \ No newline at end of file