falcao-g / falgames

Falgames is a powerful npm package designed to help others create awesome discord bots

FALGAMES

Falgames is a helpful package to enhance your discord bot with fun and interactive minigames :)

✨ Why Falgames?

• Easy to use & beginner friendly.
• Supports both message and slash commands.
• Customizable to fit your bot's style.
• 18 different minigames to choose from.

⚙️ Installation

Please note that Node v18+ and Discord.js v14+ is required.

npm i falgames

📷 Preview

📚 Usage

Starting a game with Falgames is as easy as the following example:

const { Snake } = require('falgames');

const Game = new Snake({
  message: message,
  isSlashGame: false,
  embed: {
    title: 'Snake Game',
    overTitle: 'Game Over',
    scoreText: '**Score:**',
    color: '#551476'
  },
  emojis: {
    board: '⬛',
    up: '⬆️', 
    down: '⬇️',
    left: '⬅️',
    right: '➡️',
  },
  snake: { head: '🟢', body: '🟩', tail: '🟢', over: '💀' },
  foods: ['🍎', '🍇', '🍊', '🫐', '🥕', '🥝', '🌽'],
  stopButton: 'Stop',
  timeoutTime: 60000,
  playerOnlyMessage: 'Only {player} can use these buttons.'
});

Game.startGame();
Game.on('gameOver', result => {
  console.log(result);  // =>  { result... }
});

Slash commands are also supported, just set the isSlashGame option to true and the message option to interaction:

const { Snake } = require('falgames');

const Game = new Snake({
  message: interaction,
  isSlashGame: true,
  //...
});

Make sure to check out the examples folder for more examples.

📜 Credits

This package is directed inspired by the Gamecord package.

falgames's Issues

Json source for Would you rather

Description

Here a json source for restoring the Would you rather game:
https://github.com/itsbrunodev/party-game-sentences/blob/master/src/json/would-you-rather.json

Possible implementation

/*/* async getWyrQuestion() {
    return await fetch('https://api.aniket091.xyz/wyr').then(res => res.json()).then(res => res?.data).catch(e => { return {} });
  }*/


  async startGame() {
    if (this.options.isSlashGame || !this.message.author) {
      if (!this.message.deferred) await this.message.deferReply().catch(e => {});
      this.message.author = this.message.user;
      this.options.isSlashGame = true;
    }
    const questionDB = JSON.parse(await (fs.readFileSync(path.join(__dirname,"would-you-rather.json"), "utf-8")));
    const question_number = Math.floor(Math.random() * questionDB.length)
    this.data = {option1 :questionDB[question_number][0], option2: questionDB[question_number][1]}
   // this.data = await this.getWyrQuestion();
   // if (!this.data.title) return this.sendMessage({ content: this.options.errMessage });


    const embed = new EmbedBuilder()
    .setColor(this.options.embed.color)
    .setTitle(this.options.embed.title)
    .setDescription(`1. ${this.data.option1} \n2. ${this.data.option2}`)
    .setAuthor({ name: this.message.author.tag, iconURL: this.message.author.displayAvatarURL({ dynamic: true }) })
    //.addFields({ name: 'Details', value: `**Title:** ${this.data.title}\n**Author:** ${this.data.author}` })


   /* const btn1 = new ButtonBuilder().setStyle(this.options.buttonStyle).setLabel(this.options.buttons.option1).setCustomId('wyr_1').setEmoji('1️⃣');
    const btn2 = new ButtonBuilder().setStyle(this.options.buttonStyle).setLabel(this.options.buttons.option2).setCustomId('wyr_2').setEmoji('2️⃣');*/
    const btn1 = new ButtonBuilder().setStyle(this.options.buttonStyle).setCustomId('wyr_1').setEmoji('1️⃣');
    const btn2 = new ButtonBuilder().setStyle(this.options.buttonStyle).setCustomId('wyr_2').setEmoji('2️⃣');

2048 doest work

Description of the bug

The code cant find the images.
It need a small fix:

const imagePath = path.join(__dirname, "..", `images/${imageFilenames[i]}`)

Steps to reproduce

Start the 2048 game

Media, if necessary

No response

Match pairs never timeout

Description of the bug

There is a small error which cause the Matchpairs game to never time. Here the fix:

const collector = msg.createMessageComponentCollector({ idle: this.options.timeoutTime});

Steps to reproduce

Start the Matchpairs game and wait. It wont timeout.

Media, if necessary

No response