From e18f490ac8c809c49739ab3acf5fd604d01d734c Mon Sep 17 00:00:00 2001
From: Unstable Kitsune <unstablekitsune@noreply.git.kitsunic.org>
Date: Wed, 24 Sep 2025 00:33:50 -0400
Subject: [PATCH] Add kofishop

---
 kofishop.md | 62 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 62 insertions(+)
 create mode 100644 kofishop.md

diff --git a/kofishop.md b/kofishop.md
new file mode 100644
index 0000000..189b66c
--- /dev/null
+++ b/kofishop.md
@@ -0,0 +1,62 @@
+# KofiShop Cog
+
+The KofiShop cog provides an interactive, Discord-based front-end for a Ko-fi store or similar commission-based service. It allows users to place orders, submit reviews, and be added to a public waitlist, all through simple commands.
+
+---
+
+## 1. Features
+
+-   **Form-Based Submissions:** Uses Discord Modals (pop-up forms) for both `/order` and `/rev` commands to collect detailed, structured information from users.
+-   **Custom Waitlist:** A `/waitlist` command replaces external auto-responders, posting a clean, formatted embed to a public channel.
+-   **DataManager Integration:** Logs timestamps for waitlist entries, making it compatible with the `DataManager` cog for automatic data purging.
+-   **Hybrid Commands:** All commands are fully hybridized, working with both slash commands (`/`) and your bot's prefix (`[p]`).
+
+---
+
+## 2. User Commands
+
+### `/order`
+
+Opens a pop-up form for a user to place a new commission order. The form includes fields for commission type, payment status, a detailed description, and any questions the user might have. The completed order is sent to a private channel for staff review.
+
+**Prefix Version:** `[p]order`
+
+### `/rev`
+
+Opens a pop-up form for a user to leave a review on a completed item or commission. The form includes fields for the item's name, a rating out of 10, and the review text. The completed review is sent to a public review channel.
+
+**Prefix Version:** `[p]rev`
+
+### `/waitlist <item>`
+
+Allows a user to add themselves to the public waitlist for a specific item.
+
+-   **`item`**: The name of the item or commission the user is waiting for.
+
+**Prefix Version:** `[p]waitlist <item>`
+
+---
+
+## 3. Admin Commands
+
+### `/waitlist <user> <item>`
+
+The admin version of the waitlist command allows a staff member to add another user to the waitlist.
+
+-   **`user`**: The server member to add to the waitlist.
+-   **`item`**: The name of the item or commission.
+
+**Prefix Version:** `[p]waitlist <user> <item>`
+
+### `/kofiset`
+
+The main command group for configuring the KofiShop system. Requires `Manage Server` permissions.
+
+**Prefix Version:** `[p]kofiset` or `[p]kset`
+
+-   `/kofiset orderchannel <#channel>`
+    -   Sets the channel where new order submissions will be sent.
+-   `/kofiset reviewchannel <#channel>`
+    -   Sets the channel where new reviews will be posted.
+-   `/kofiset waitlistchannel <#channel>`
+    -   Sets the public channel where the waitlist will be displayed.
\ No newline at end of file