Add modmail

modmail.md

@@ -0,0 +1,51 @@
+# ModMail Cog
+
+The ModMail cog is a private, two-way communication system that allows server members to contact staff by sending a Direct Message (DM) to the bot. It uses Discord's forum channels to create a clean, organized, and professional ticket management system for staff.
+
+---
+
+## 1. Features
+
+-   **DM to Forum:** Automatically creates a new, private post in a designated forum channel when a user DMs the bot.
+-   **Two-Way Communication:** Staff can reply directly in the forum thread, and their messages will be relayed back to the user's DM.
+-   **Staff Anonymity:** All staff replies are sent from a generic "Staff Response" persona with a custom color, protecting individual staff members' identities.
+-   **Ticket Management:** Staff can close tickets with an optional reason, which automatically archives and locks the forum thread.
+-   **DataManager Integration:** Logs the timestamp of closed tickets, making it compatible with the `DataManager` cog for automatic data purging.
+-   **Hybrid Commands:** All administrative commands work with both slash commands (`/`) and your bot's prefix (`[p]`).
+
+---
+
+## 2. User Workflow
+
+1.  A user sends a Direct Message (DM) to the bot.
+2.  The bot creates a new post in the ModMail forum, using the user's name as the title and their message as the content.
+3.  Staff members can then click on the post to open the thread and discuss the issue.
+4.  Any message a staff member types in the thread is automatically sent to the user's DM in a clean, anonymous embed.
+5.  The user can reply in the DM, and their message will be relayed back to the thread for staff to see.
+
+---
+
+## 3. Staff & Admin Commands
+
+### `/modmail close [reason]`
+
+Closes the current ModMail ticket. This command can only be used inside an active ModMail thread in the forum channel.
+
+-   **`reason`**: An optional reason for closing the ticket. This will be sent to the user in a final notification message.
+
+**Prefix Version:** `[p]modmail close [reason]`
+
+---
+
+### `/modmailset`
+
+The main command group for configuring the ModMail system. Requires `Manage Server` permissions.
+
+**Prefix Version:** `[p]modmailset` or `[p]mmset`
+
+-   `/modmailset forum <#forum-channel>`
+    -   Sets the forum channel where new ModMail tickets will be created. This is a **required** setup step.
+-   `/modmailset toggle`
+    -   Toggles the entire ModMail system on or off for the server.
+-   `/modmailset settings`
+    -   Displays the current ModMail settings (the configured forum channel and whether the system is enabled).