falgames
Version:
Falgames is a helpful package to enhance your discord bot with fun and interactive minigames
246 lines (209 loc) • 10.3 kB
JavaScript
import { EmbedBuilder, ActionRowBuilder } from "discord.js"
import { disableButtons, getNumEmoji, formatMessage, ButtonBuilder } from "../utils/utils.js"
import events from "node:events"
/**
* This class allows you to create and manage a Minesweeper game in Discord, including handling user interactions and game logic.
* It extends the Node.js `events` module to allow for event-driven programming, specifically emitting a `gameOver` event when the game ends.
*
* @class Minesweeper
* @param {MinesweeperOptions} options - The options for the Minesweeper game.
*
* @extends {events}
* @fires Minesweeper#gameOver
* @typedef {Object} MinesweeperOptions
*/
export class Minesweeper extends events {
/**
* Represents a Minesweeper game.
* @constructor
* @param {Object} options - The options for the Minesweeper game.
* @param {boolean} [options.isSlashGame=false] - Whether the game is played using slash commands.
* @param {Object} options.message - The message object associated with the game.
* @param {Object} [options.embed] - The embed options for the game.
* @param {string} [options.embed.title='Minesweeper'] - The title of the embed.
* @param {string} [options.embed.color='#551476'] - The color of the embed.
* @param {string} [options.embed.description='Click on the buttons to reveal the blocks except mines.'] - The description of the embed.
* @param {Object} [options.emojis] - The emojis for the game.
* @param {string} [options.emojis.flag='🚩'] - The flag emoji.
* @param {string} [options.emojis.mine='💣'] - The mine emoji.
* @param {number} [options.mines=5] - The number of mines to plant.
* @param {number} [options.timeoutTime=60000] - The timeout time for the game.
* @param {string} [options.winMessage='You won the Game! You successfully avoided all the mines.'] - The win message.
* @param {string} [options.loseMessage='You lost the Game! Beaware of the mines next time.'] - The lose message.
* @param {string} [options.playerOnlyMessage='Only {player} can use these buttons.'] - The message to show when someone else tries to use the buttons.
*/
constructor(options = {}) {
if (!options.isSlashGame) options.isSlashGame = false
if (!options.message) throw new TypeError("NO_MESSAGE: No message option was provided.")
if (typeof options.message !== "object") throw new TypeError("INVALID_MESSAGE: message option must be an object.")
if (typeof options.isSlashGame !== "boolean")
throw new TypeError("INVALID_COMMAND_TYPE: isSlashGame option must be a boolean.")
if (!options.embed) options.embed = {}
if (!options.embed.title) options.embed.title = "Minesweeper"
if (!options.embed.color) options.embed.color = "#551476"
if (!options.embed.description)
options.embed.description = "Click on the buttons to reveal the blocks except mines."
if (!options.emojis) options.emojis = {}
if (!options.emojis.flag) options.emojis.flag = "🚩"
if (!options.emojis.mine) options.emojis.mine = "💣"
if (!options.mines) options.mines = 5
if (!options.timeoutTime) options.timeoutTime = 60000
if (!options.winMessage) options.winMessage = "You won the Game! You successfully avoided all the mines."
if (!options.loseMessage) options.loseMessage = "You lost the Game! Beaware of the mines next time."
if (typeof options.embed !== "object") throw new TypeError("INVALID_EMBED: embed option must be an object.")
if (typeof options.embed.title !== "string") throw new TypeError("INVALID_EMBED: embed title must be a string.")
if (typeof options.embed.description !== "string")
throw new TypeError("INVALID_EMBED: embed description must be a string.")
if (typeof options.emojis !== "object") throw new TypeError("INVALID_EMOJIS: emojis option must be an object.")
if (typeof options.emojis.flag !== "string") throw new TypeError("INVALID_EMOJIS: flag emoji must be a string.")
if (typeof options.emojis.mine !== "string") throw new TypeError("INVALID_EMOJIS: mine emoji must be a string.")
if (typeof options.mines !== "number") throw new TypeError("INVALID_MINES: mines option must be a number.")
if (typeof options.timeoutTime !== "number")
throw new TypeError("INVALID_TIME: Timeout time option must be a number.")
if (typeof options.winMessage !== "string")
throw new TypeError("INVALID_MESSAGE: Win Message option must be a string.")
if (typeof options.loseMessage !== "string")
throw new TypeError("INVALID_MESSAGE: Lose Message option must be a string.")
if (options.mines < 1 || options.mines > 24)
throw new RangeError("INVALID_MINES: mines option must be between 1 and 24.")
if (options.playerOnlyMessage !== false) {
if (!options.playerOnlyMessage) options.playerOnlyMessage = "Only {player} can use these buttons."
if (typeof options.playerOnlyMessage !== "string")
throw new TypeError("INVALID_MESSAGE: playerOnly Message option must be a string.")
}
super()
this.options = options
this.message = options.message
this.emojis = options.emojis
this.gameBoard = []
this.length = 5
for (let y = 0; y < this.length; y++) {
for (let x = 0; x < this.length; x++) {
this.gameBoard[y * this.length + x] = false
}
}
}
async sendMessage(content) {
if (this.options.isSlashGame) return await this.message.editReply(content)
else return await this.message.channel.send(content)
}
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
}
this.plantMines()
this.showFirstBlock()
const embed = new EmbedBuilder()
.setColor(this.options.embed.color)
.setTitle(this.options.embed.title)
.setDescription(this.options.embed.description)
.setAuthor({ name: this.message.author.tag, iconURL: this.message.author.displayAvatarURL({ dynamic: true }) })
const msg = await this.sendMessage({ embeds: [embed], components: this.getComponents() })
return this.handleButtons(msg)
}
handleButtons(msg) {
const collector = msg.createMessageComponentCollector({ idle: this.options.timeoutTime })
collector.on("collect", async (btn) => {
await btn.deferUpdate().catch((e) => {})
if (btn.user.id !== this.message.author.id) {
if (this.options.playerOnlyMessage)
btn.followUp({ content: formatMessage(this.options, "playerOnlyMessage"), ephemeral: true })
return
}
const x = parseInt(btn.customId.split("_")[1])
const y = parseInt(btn.customId.split("_")[2])
const index = y * this.length + x
if (this.gameBoard[index] === true) return collector.stop()
const mines = this.getMinesAround(x, y)
this.gameBoard[index] = mines
if (this.foundAllMines()) return collector.stop()
return await msg.edit({ components: this.getComponents() })
})
collector.on("end", async (_, reason) => {
if (reason === "user" || reason === "idle") return this.gameOver(msg, this.foundAllMines())
})
}
gameOver(msg, result) {
const MinesweeperGame = {
player: this.message.author,
blocksTurned: this.gameBoard.filter(Number.isInteger).length,
}
this.emit("gameOver", { result: result ? "win" : "lose", ...MinesweeperGame })
for (let y = 0; y < this.length; y++) {
for (let x = 0; x < this.length; x++) {
const index = y * this.length + x
if (this.gameBoard[index] !== true) this.gameBoard[index] = this.getMinesAround(x, y)
}
}
const embed = new EmbedBuilder()
.setColor(this.options.embed.color)
.setTitle(this.options.embed.title)
.setDescription(result ? this.options.winMessage : this.options.loseMessage)
.setAuthor({ name: this.message.author.tag, iconURL: this.message.author.displayAvatarURL({ dynamic: true }) })
return msg.edit({ embeds: [embed], components: disableButtons(this.getComponents(true, result)) })
}
plantMines() {
for (let i = 0; i <= this.options.mines; i++) {
const x = Math.floor(Math.random() * 5)
const y = Math.floor(Math.random() * 5)
const index = y * this.length + x
if (this.gameBoard[index] !== true) this.gameBoard[index] = true
else i = i - 1
}
}
getMinesAround(x, y) {
let minesAround = 0
for (let row = -1; row < 2; row++) {
for (let col = -1; col < 2; col++) {
const block = { x: x + col, y: y + row }
if (block.x < 0 || block.x >= 5 || block.y < 0 || block.y >= 5) continue
if (row === 0 && col === 0) continue
if (this.gameBoard[block.y * this.length + block.x] === true) minesAround += 1
}
}
return minesAround
}
showFirstBlock() {
const Blocks = []
for (let y = 0; y < this.length; y++) {
for (let x = 0; x < this.length; x++) {
if (this.gameBoard[y * this.length + x] === true) Blocks.push({ x, y })
}
}
const emptyBlocks = Blocks.filter((b) => !this.getMinesAround(b.x, b.y))
const blocks = emptyBlocks.length ? emptyBlocks : Blocks
const rBlock = blocks[Math.floor(Math.random() * blocks.length)]
this.gameBoard[rBlock.y * this.length + rBlock.x] = this.getMinesAround(rBlock.x, rBlock.y)
}
foundAllMines() {
let found = true
for (let y = 0; y < this.length; y++) {
for (let x = 0; x < this.length; x++) {
if (this.gameBoard[y * this.length + x] === false) found = false
}
}
return found
}
getComponents(showMines, found) {
const components = []
for (let y = 0; y < this.length; y++) {
const row = new ActionRowBuilder()
for (let x = 0; x < this.length; x++) {
const block = this.gameBoard[y * 5 + x]
const isNumber = getNumEmoji(block || null)
const displayMine = block === true && showMines
const btn = new ButtonBuilder()
.setStyle(displayMine ? (found ? "SUCCESS" : "DANGER") : isNumber || block === 0 ? "SECONDARY" : "PRIMARY")
.setCustomId("minesweeper_" + x + "_" + y)
if (displayMine || isNumber)
btn.setEmoji(displayMine ? (found ? this.emojis.flag : this.emojis.mine) : isNumber)
else btn.setLabel("\u200b")
row.addComponents(btn)
}
components.push(row)
}
return components
}
}