Skip to content

README.md

Latest commit

 

History

History
81 lines (55 loc) · 3.17 KB

README.md

File metadata and controls

81 lines (55 loc) · 3.17 KB

🤖 Kannamy: Tu Bot de Discord Multifuncional

Descripción del Proyecto

Kannamy es un bot de Discord versátil, diseñado para ofrecer una experiencia de usuario fluida y enriquecedora en tu servidor. Construido con Node.js y la robusta librería discord.js, este bot se enfoca en la eficiencia y la modularidad, haciendo que sea fácil de mantener y expandir. Desde la gestión de comandos hasta el manejo de eventos, Kannamy te brinda todas las herramientas para automatizar y mejorar la interacción en tu comunidad.

🌟 Características Principales

  • Manejo Modular de Comandos y Eventos: Utiliza un sistema de Handlers para gestionar de forma organizada los comandos y eventos, lo que facilita añadir nuevas funcionalidades sin esfuerzo.
  • Configuración Segura: Emplea variables de entorno a través de archivos .env, garantizando que información sensible como el token del bot nunca se suba al repositorio.
  • Estructura Escalable: Su arquitectura está diseñada para crecer, permitiendo la integración de nuevas características como comandos de música, bases de datos o sistemas de moderación.

🚀 Instalación y Uso

Sigue estos pasos para poner a Kannamy en funcionamiento en tu servidor.

  1. Clonar el Repositorio: Abre tu terminal y clona el proyecto con el siguiente comando.

    git clone [https://github.com/choco-latito29/Kannamy.git](https://github.com/choco-latito29/Kannamy.git)
cd Kannamy

  2. Instalar Dependencias: Navega al directorio del proyecto e instala todas las librerías necesarias.

    npm install

  3. Configurar Variables de Entorno: Crea un archivo llamado .env en la raíz del proyecto y añade tu token de bot de Discord. Este token es tu clave secreta; no lo compartas con nadie.

    TOKEN= TU_TOKEN_DEL_BOT
MONGOOSE=TU_URL_DE_MONGODB
TOP_GG = TOKEN_DE_TOPGG
DISCORD_LIST = TOKEN_DE_DISCORDLIST
DISCORD_BOT_LIST = TOKEN_DE_DISCORDBOTLIST
GUILD = ID_DEL_SERVIDOR_DE_SOPORTE
ERROR = ID_DEL_CANAL_DE_ERRORES
SHARDING = ID_DEL_CANAL_DE_SHARDS
LOGS = ID_DEL_CANAL_DE_LOGS
SHARDING_MODE = worket
TOTAL_SHARDS = auto
SHARDS_PER_CLUSTER = 1
DEVELOPERS = ID_DE_LOS_DEVELOPERS
MOVIE = TOKEN DE LA_API_DE_MOVIE

  4. Iniciar el Bot: Finalmente, ejecuta el bot.

    node Src/Functions/shardingManager.js
npm run dev

    Si todo está configurado correctamente, verás un mensaje en la consola confirmando que el bot se ha conectado.

🛠️ Tecnologías Utilizadas

  • NodeJS El entorno de ejecución que potencia el bot.
  • discord.js: Una de las librerías más populares y potentes para interactuar con la API de Discord.
  • ESLint: Para mantener un código limpio y consistente.
  • Prettier: Para formatear automáticamente el código.

🤝 Contribuciones

¡Las contribuciones son bienvenidas! Si encuentras un error o tienes una idea para una nueva característica, no dudes en abrir un issue o enviar un pull request.

📝 Licencia

Este proyecto está bajo la Licencia ISC. Para más detalles, consulta el archivo LICENSE en este repositorio.