From 76c0efe1c422a96496a1557eee05b7c1cfbced76 Mon Sep 17 00:00:00 2001 From: kl3z <136390977+kl3z@users.noreply.github.com> Date: Fri, 1 Aug 2025 21:34:59 +0100 Subject: [PATCH] Update README.md --- README.md | 91 +++++++++++++++++++++++++++---------------------------- 1 file changed, 45 insertions(+), 46 deletions(-) diff --git a/README.md b/README.md index c091be6..d82a619 100644 --- a/README.md +++ b/README.md @@ -1,97 +1,96 @@ -World of Warcraft Dungeon Group Bot (WoW LFG Bot) +# World of Warcraft Dungeon Group Bot (WoW LFG Bot) + This is a Python bot developed with discord.py, designed to automate and organize the creation of Mythic+ dungeon groups in Discord, simplifying the scheduling, sign-up, and player management process based on their roles and classes in World of Warcraft. -Main Features -🎯 Group creation with interactive embed displaying: +## Main Features +###🎯 Group creation with interactive embed displaying: -Selected dungeon +- *Selected dungeon* -Keystone level (+X) +- *Keystone level (+X)* -Scheduled date and time +- *Scheduled date and time* -Dynamic player list by role and class +- *Dynamic player list by role and class* -🧩 Role signup (Tank, Healer, DPS) with automatic limits: +### 🧩 Role signup (Tank, Healer, DPS) with automatic limits: -1 Tank +- *1 Tank* -1 Healer +- *1 Healer* -3 DPS +- *3 DPS* 🧙 Class selection is only available after choosing a role, with specific icons and names for each specialization. -⛔ Player lock system: +### ⛔ Player lock system: -Only one player can sign up at a time. +- *Only one player can sign up at a time.* -The role selection process is blocked until the class is chosen. +- *The role selection process is blocked until the class is chosen.* -🏰 Dungeon and Difficulty selection via dropdown menus (SelectDropdown): +### 🏰 Dungeon and Difficulty selection via dropdown menus (SelectDropdown): -Configurable only once +- *Configurable only once* -The thread title is updated with the selected dungeon and difficulty +- *The thread title is updated with the selected dungeon and difficulty* -📆 Date and Time setup via Modal: +### 📆 Date and Time setup via Modal: -Ensures the groups are scheduled for future times +- *Ensures the groups are scheduled for future times* -📬 Forum channel post creation: +## 📬 Forum channel post creation: -Allows threads to be created with custom names and deletes dropdowns after use +- *Allows threads to be created with custom names and deletes dropdowns after use* Command: -yaml -Copy -Edit + !bot -💡 Libraries Used -discord.py (Discord bot API) -python-dotenv (Management of tokens and environment variables) +## 💡 Libraries Used -asyncio (Scheduled tasks like deleting threads) +- *discord.py (Discord bot API)* -datetime (Date and time management) +- *python-dotenv (Management of tokens and environment variables)* -🚀 How to Use +- *asyncio (Scheduled tasks like deleting threads)* -Create a server with a forum channel named lfg +- *datetime (Date and time management)* -Use the command /criargrupo or !criargrupo to start a new group: +## 🚀 How to Use -bash -Copy -Edit +- *Create a server with a forum channel named lfg* + +- *Use the command /criargrupo or !criargrupo to start a new group:* + +```bash !criargrupo -Players must choose their role → class → and they are signed up +``` +- *Players must choose their role → class → and they are signed up* -Dungeon, difficulty, and date are selected through intuitive menus +- *Dungeon, difficulty, and date are selected through intuitive menus* -📌 Visual Example +## 📌 Visual Example image Additionally, the bot can be added to a channel, and using the command /bot or !bot, it creates a post in the lfg forum: -bash -Copy -Edit +```bash !bot +``` This option also allows the user to select the type of stack they may want: image -🔐 Security +## 🔐 Security -The bot respects the limits for each role +- *The bot respects the limits for each role* -Prevents more than one player from selecting a role at the same time +- *Prevents more than one player from selecting a role at the same time* -Removes interaction elements after use to avoid spam +- *Removes interaction elements after use to avoid spam* -👨‍💻 Developed by +## 👨‍💻 Developed by Kl3z – This project is open-source and can be adapted for any WoW community.