Discord Bot Boilerplate

Repositorio con lo básico para poder crear un bot de discord.

Los siguientes videos fueron tomados como ejemplo para poder hacer este desarrollo;

• Web Dev Simplified -> How To Build And Deploy Your First Discord Bot : Base para la configuración inicial del bot en discord y otros pasos para hacer deployment
• Fazt -> Discord Bot & Node.js, para principiantes : Base para el uso de comandos básicos

📌 Requerimientos

• Git (>= 2.13.0)
• Node.js (>= 10)
• Yarn - Dependency management

📌 Instalación

• Clonar repositorio;

git clone https://github.com/moudev/nodejs-eslint-husky-discordbot-boilerplate.git

• Entrar en carpeta;

cd nodejs-eslint-husky-discordbot-boilerplate/

• Instalar paquetes;

yarn install

📌 Configuración

• Agregar llave privada de Discord;

  En el repositorio se encuentra el archivo .env.sample, este solo es un archivo de ejemplo ya que se tiene que crear un archivo llamado .env que es el que contendrá las variables de entorno para que el proyecto pueda funcionar, en este caso contendrá la llave privada de Discord. Para saber cómo hacer la configuración de la llave revisar el video de Web Dev Simplified listado al inicio.

• Configurar prefijo del bot;

  Se puede usar cualquier prefijo, el único detalle a tener en cuenta es que si en el servidor ya se cuenta con un bot que hace uso del mismo prefijo es probable que ocurran errores. Elegir un prefijo que se tenga cierto nivel de seguridad que no tendrá problemas de compatibilidad con otro bot agregado dentro del servidor.

  El prefijo con el cual será usado el bot se configura desde el archivo bot.js#L3

• Configurar comandos;

  Se pueden tener los comandos que se quieran, son un array de elementos de texto. El texto de los comando no es necesario que vaya con el prefijo del bot, ya está la configuración de usar como mando el texto que se encuentra después del prefijo.

  El archivo donde se configura el listado de comandos disponibles es; bot.js#L4

  Una vez el listado de comandos está configurado, se tienen que asignar acciones a esos comandos, para ello se utiliza JavaScript Switch Statement en el archivo bot.js#L40. En el código actual se encuentran algunos ejemplos, pero si se desea agregar otro tipo de comandos se sugiere revisar la documentación de discord.js

• Ejecutar el bot en modo development

  Este modo es para cuando se están haciendo modificaciones y permite recargar todo de forma automática.

    yarn dev
  

• Ejecutar el bot en modo production

  Luego de realizar el proceso de configuración, el bot puede ser ejecutado en el modo production que es cuando ya no se necesita recargar de forma automática los cambios, también sirve para cuando se hace deployment del bot;

    yarn start
  

Nota: Para hacer el deployment del bot, en los videos listados al inicio se encuentran instrucciones de cómo hacerlo. También cuentan con otros datos de interés que vale la pena ver.

📌 Proceso

🎨 Excalidraw : Sitio donde se creó el diagrama