README.md

🤖 Discord Bot for Group Management

This project is a bot for Discord servers that allows users with a specific role to manage their own groups within the server. These groups are created as roles, which the leaders have complete control over without needing additional administrative permissions. Each group has its own category in Discord with text and voice channels that are only accessible to the leader and group members. The leader can use bot commands to manage their category, such as adding channels, inviting other users, and performing specific actions within their group.

🚀 Installation

Requirements

• A Linux server
• Docker installed
• Docker compose

Installation Steps

1. Clone the repository on your server:

   git clone Repo-link
   cd anEmptyFolder

2. Create .env files in the docker and src folders:

   • In the docker folder, create a .env file with the following variables:

     MYSQL_ROOT_PASSWORD=example_root_password
     MYSQL_USER=example_admin
     MYSQL_PASSWORD=example_password
     MYSQL_DATABASE=bot_database

   • In the src folder, create a .env file with the following variables:

     TOKEN='YOUR_DISCORD_BOT_TOKEN'
     MYSQL_ROOT_PASSWORD=example_root_password
     MYSQL_USER=example_admin
     MYSQL_PASSWORD=example_password
     MYSQL_DATABASE=bot_database
     VERIFIED_ROL_ID=YOUR_VERIFIED_ROLE_ID

     📌 Note: Replace YOUR_DISCORD_BOT_TOKEN and YOUR_VERIFIED_ROLE_ID with the actual values for your bot and Discord role.

3. Start the bot using Docker Compose:

   cd docker
   docker-compose up -d

📁 Folder Structure

The main folder structure of the project is as follows:

├── docker
│   ├── .env
│   └── docker-compose.yml
├── mysql
│   ├── initSQL.sql
│   └── data
└── python
    └── src
        ├── .env
        ├── entrypoint.sh
        ├── logs
        └── main.py

Explanation of Relevant Folders and Files

• docker: Contains the docker-compose.yml file needed to launch the bot and MySQL database containers.

• mysql:

  • initSQL.sql: Contains the initial SQL setup script for the database.
  • data/: Folder where persistent MySQL data is stored.

• python/src:

  • .env: Environment file with bot configuration and database credentials.
  • entrypoint.sh: Startup script that runs when the bot container starts.
  • logs/: Folder for storing the bot’s log files.
  • main.py: Main file executing the bot's logic.

✨ Features

• Group Creation: Allows specific users to create their own role and Discord category.
• Channel Management: Group leaders can create and manage channels within their category.
• Member Invitations: Leaders can invite other server members to join their groups.

📋 Additional Notes

• Be sure to check and adjust permissions in Discord to ensure the bot works correctly.
• This bot is designed to delegate certain administrative capabilities within a specific group, without giving general administrative permissions to group leaders.

---

🤖 Bot de Discord para Gestión de Grupos

Este proyecto es un bot para servidores de Discord que permite a usuarios con un rol específico gestionar sus propios grupos dentro del servidor. Estos grupos se crean como roles sobre los que los líderes tienen control completo, sin necesidad de permisos administrativos adicionales. Cada grupo cuenta con una categoría de Discord con canales de texto y de voz accesibles solo para el líder y los miembros del grupo. El líder puede utilizar comandos del bot para gestionar su categoría, añadiendo canales, invitando a otros usuarios, y realizando acciones específicas en su propio grupo.

🚀 Instalación

Requisitos

• Un servidor Linux
• Docker instalado
• Docker compose

Pasos de Instalación

1. Clonar el repositorio en tu servidor:

   git clone Link-del-repo
   cd Tu-carpeta

2. Crear archivos .env en las carpetas docker y src:

   • En la carpeta docker crear un archivo .env con las siguientes variables:

     MYSQL_ROOT_PASSWORD=ejemplo_root_password
     MYSQL_USER=ejemplo_admin
     MYSQL_PASSWORD=ejemplo_password
     MYSQL_DATABASE=bot_database

   • En la carpeta src crear un archivo .env con las siguientes variables:

     TOKEN='YOUR_DISCORD_BOT_TOKEN'
     MYSQL_ROOT_PASSWORD=ejemplo_root_password
     MYSQL_USER=ejemplo_admin
     MYSQL_PASSWORD=ejemplo_password
     MYSQL_DATABASE=bot_database
     VERIFIED_ROL_ID=YOUR_VERIFIED_ROLE_ID

     📌 Nota: Reemplaza YOUR_DISCORD_BOT_TOKEN y YOUR_VERIFIED_ROLE_ID con los valores correspondientes para tu bot y rol de Discord.

3. Iniciar el bot usando Docker Compose:

   cd docker
   docker-compose up -d

📁 Estructura de Carpetas

La estructura principal del proyecto es la siguiente:

├── docker
│   ├── .env
│   └── docker-compose.yml
├── mysql
│   ├── initSQL.sql
│   └── data
└── python
    └── src
        ├── .env
        ├── entrypoint.sh
        ├── logs
        └── main.py

Explicación de Carpetas y Archivos Relevantes

• docker: Contiene el archivo docker-compose.yml necesario para levantar el contenedor del bot y de la base de datos MySQL.

• mysql:

  • initSQL.sql: Contiene el script SQL de configuración inicial para la base de datos.
  • data/: Carpeta donde se almacenan los datos persistentes de MySQL.

• python/src:

  • entrypoint.sh: Script de inicio que se ejecuta cuando el contenedor del bot arranca.
  • logs/: Carpeta destinada a almacenar los archivos de log del bot.
  • main.py: Archivo principal que ejecuta la lógica del bot.

✨ Características

• Creación de Grupos: Permite a ciertos usuarios crear su propio rol y categoría de Discord.
• Gestión de Canales: El líder del grupo puede crear y gestionar canales dentro de su propia categoría.
• Invitación de Miembros: Los líderes pueden invitar a otros usuarios del servidor a unirse a sus grupos.

📋 Notas Adicionales

• Recuerda revisar y ajustar los permisos en Discord para asegurar que el bot funcione correctamente.
• Este bot está diseñado para delegar ciertas capacidades de administración dentro de un grupo específico, sin otorgar permisos administrativos generales a los líderes de grupo.