Discord-Mini-Games.js

An Open-source Discord Mini-Games Package

View the Project on GitHub

Connect4

Play Connect4 Game, where u have to get 4 balls in a sequence i.e vertical, horizontal & cross.

Importing

const {Connect4} = require('discord-mini-games.js');

GameOptions

const gameOptions = {
    isSlash: false, // wether the game is a slash command, default: false.
    time: 30000, // timeup duration in milliseconds, default: 30000.
    onWin: () => {console.log("win")}, // Function to execute if player wins the game.
    onTie: () => {console.log('lose')}, // Function to execute when game ties.
    onTimeUp: () => {console.log('timeup')}, // Function to execute when game times out.
    title: 'Connect4', // Embed Title.
    nextDes: null, // Next Player display
    emoji1: "🔴", // Opponent Box Emoji.
    emoji2: "🟢", // Player Box Emoji.
    emptyEmoji: "⬛", // Empty Box Emoji.
    footer: null, // Embed Footer.
    winDes: null, // Embed Description when player wins the game.
    tieDes: null, // Embed Description when game ties.
    timeUpDes: 'Game Over: Timed Out', // Embed Description when game times out.
    resTime: 30000, // wait time for opponent response, default: 30000.
    opponent: User, // User object of the opponent.
    confirmDes: null, // Embed Description of Confirmation Embed.
    declineDes: 'User Declined the Game', // Embed Description when user declines the game challenge.
    noResDes: 'User didn\'t respond', // Embed Description when user didn't respond.
}

Formatting

The Texts for embed description accepts following formatting:

Function Parameters

onWin function executes with 2 function parameters to allow winner/loser based actions

function onWin(winner,loser) {
    // Both are User Objects
    console.log(winner.username, "won the game against", loser.username);
}

onTimeUp function executes with 2 function parameters

function onTimeUp(timed_player,other) {
  // Both are User Objects
  console.log(timed_user, "didn't respond in time");
}

Starting The Game

let message = message || interaction; // message object or interaction object.
let gameOptions = "refer GameOptions block";
const game = new Connect4(message,gameOptions); // Initialising the Game.
game.run(); // Starting the Game.