Skip to content

Papela/discord-vote

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

26 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Discord-vote

npm version license

Un paquete NPM para poder tener un sistema de votaciones para Discord.js 14 de manera sencilla.

Imágenes de ejemplo

Notas: Puede que algunos ejemplos ya no se vean exactamente así debido a nuevas actualizaciones.

Modo normal

   

Modo Avanzado

   

Instalación

Para instalar el paquete, utiliza el siguiente comando:

npm install discord-vote

Ejemplo de uso en el Modo Normal

Notas: En en modo "normal", en caso de que el bot se desconecte, se perdera todo el progreso de las votaciones que no hayan terminado. En el modo "Avanzado" no se perdera ningun progreso.

const DiscordVote = require('discord-vote');
const votacion = new DiscordVote({
    client:client, //El cliente
    mode:0}); //Modo de votacion. (0 = Normal, 1 = Avanzado)
client.on('messageCreate', async (message) => {
      if (message.content.startsWith("!votacion")) {
        if (args.length >= 2) {
          const duration = args[0]; //Tiempo en minutos
          const title = args.slice(1).join(" "); // Titulo de la votacion
  
          votacion.createVote(message, title, duration);
        } else {
          message.channel.send('Uso incorrecto. Ejemplo: `!votacion 5 Titulo`');
        }
      }

client.login("TOKEN DEL BOT");

Ejemplo de uso en el modo Avanzado

const DiscordVote = require('discord-vote');
const votacion = new DiscordVote({
  client:client, //El cliente
  mode:1, //Modo de votacion. (0 = Normal, 1 = Avanzado)
  savePath: './votaciones.json', //Ruta de guardado (Avanzado)
  checkTime: 10000, //tiempo de comprobacion (Avanzado)
  debug: false}); //Muestra mas logs con informacion de las votaciones (no recomendado)
//*Todo lo del modo avanzado es completamente opcional.*/
votacion.checkVotaciones(); //Utilizado para llamar a la funcion que comprueba las votaciones usando checkTime (por defeto 1 Minuto). *Necesario al usar el modo avanzado

client.on('messageCreate', async (message) => {
      if (message.content.startsWith("!votacion")) {
        if (args.length >= 2) {
          const duration = args[0]; //Tiempo en minutos
          const title = args.slice(1).join(" "); // Titulo de la votacion
  
          votacion.createVote(message, title, duration);
        } else {
          message.channel.send('Uso incorrecto. Ejemplo: `!votacion 5 Titulo`');
        }
      }

client.login("TOKEN DEL BOT");

Funciones

+ createVote(message, duration, title, savePath, debug);
+ checkVotaciones();
+ checkVotacionManual();

createVote

Inicia una votación con la duración, título y canal especificados.

  • message: Mensaje del la accion que tiene el cliente. (client.on('messageCreate',async(message) => {})En algunos casos puede ser: "msg"
  • title: Título de la votación.
  • duration: Duración de la votación en minutos.
  • savePath: Ruta de guardado personalizado. (opcional y solo para el modo Avanzado).
  • debug: true o false (opcional).

checkVotaciones

Comprueba las votaciones cada X tiempo. Definido anteriormente. (checkTime)

checkVotacionManual

Comprueba las votaciones al momento de llamar al metodo.

Licencia

Este proyecto está licenciado bajo la Licencia GPL-3.0. Ver el archivo LICENSE para más detalles.

Autor

Contribuir

Si quieres contribuir a este proyecto, puedes seguir los siguientes pasos:

  1. Haz un fork del repositorio.
  2. Crea una rama con tu nueva funcionalidad: git checkout -b nueva-funcionalidad.
  3. Realiza tus cambios y haz commit: git commit -m "Agrega nueva funcionalidad".
  4. Haz push a la rama: git push origin nueva-funcionalidad.
  5. Abre un pull request en GitHub.