https://github.com/kartikesingh/discord-rock-paper-scissor

An module to create Rock Paper Scissors game for Discord bots
https://github.com/kartikesingh/discord-rock-paper-scissor

Last synced: 24 days ago
JSON representation

An module to create Rock Paper Scissors game for Discord bots

• Host: GitHub
• URL: https://github.com/kartikesingh/discord-rock-paper-scissor
• Owner: KartikeSingh
• Created: 2021-08-27T09:06:10.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2023-02-08T08:05:05.000Z (almost 2 years ago)
• Last Synced: 2024-04-25T12:43:50.200Z (9 months ago)
• Language: JavaScript
• Size: 30.3 KB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
# Installations

```

npm i discord-rock-paper-scissor

```

# What?

This package is created for making Rock Paper Scissor game for discord bots with rich features like Message Components.

# Why?

This package is very easy to use and you can request new updates and stuff simple by messaging me on my [discord server](https://discord.gg/XYnMTQNTFh)

We supports both Slash command and normal command.

# How?

## Basic

```js

const RPS = require('discord-rock-paper-scissor');

const rps = new RPS();

/**

 * This method will start a Solo game between The message author and bot, everything is automatic <3

 * @param {Discord.Message} message The message object where command was used

 * @param {Discord.Client} bot Your client object

 */

rps.solo(message,bot);

/**

 * This method will start a Duo game between The message author and Player 2, everything is automatic <3

 * @param {Discord.Message} message The message object where command was used

 * @param {Discord.User} player2 The mentioned User / second player. Note it should be a discord user Object not guild member object

 */

rps.duo(message,player2);

```

## Advanced

```js

const RPS = require('../../../../packages/discord-rock-paper-scissor/src');

const rps = new RPS({

    choiceReply: "You chose {move}",

    endTitle: "Game ended very very victoriously for {winner}",

    readyMessage: "Choose the dang moves kiddos",

    drawEndTitle: "Bruh nerds ended up getting a draw",

    choiceTitle: "Choose the move boiiiiiiiiiiiiiiiii",

    choiceDescription: "I  hope that you can read than click on buttons to choose the move",

    drawEndDescription: "{player1} chose : {player1move}\n\n{player2} chose : {player2move}\nStupid nerds arent they",

    endDescription: "[Winner 👑] {winner}'s move : {winnermove}\n\n[Looser 🤮] {looser}'s move : {loosermove}",

    chooseIn: "channel",

    colors: {

        drawEmbed: "#0505e7",

        endEmbed: "#1ae705",

        errorEmbed: "#e70580",

        readyEmbed: "#05b0e7"

    }

});

/**

 * This method will start a Solo game between The message author and bot, everything is automatic <3

 * @param {Discord.Message} message The message object where command was used

 * @param {Discord.Client} bot Your client object

 */

rps.solo(message,bot);

/**

 * This method will start a Duo game between The message author and Player 2, everything is automatic <3

 * @param {Discord.Message} message The message object where command was used

 * @param {Discord.User} player2 The mentioned User / second player. Note it should be a discord user Object not guild member object

 */

rps.duo(message,player2);

```

## Game Response

```js

const result = await rps.solo(); // or await rps.duo();

/** Result body example

 * {

 * failed: boolean, // false => game ended successfully, true => game failed

 * winner: number, // -1 => no one won, 0 => user 1 won or bot incase of solo, 1 => user 2 won or player incase of solo, null => game failed

 * reason: "", // reason of game end

 * error?: Error, // the error object, sometimes it is attached

 */

```

# Note

- For discord JS 13, use version `1.2.1`

- For discord JS 14, use version `>=1.2.2`

# Support

If you need any help or something you can get support on my [discord server](https://discord.gg/XYnMTQNTFh)