Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/diabolusgx/guess-the-number

Simple and fun number game where you have to guess number b/w given min and max for some reward that game organizer can set.
https://github.com/diabolusgx/guess-the-number

discord discord-bot discord-js discordjs guess-the-number numbergame

Last synced: about 2 months ago
JSON representation

Simple and fun number game where you have to guess number b/w given min and max for some reward that game organizer can set.

Host: GitHub
URL: https://github.com/diabolusgx/guess-the-number
Owner: DiabolusGX
License: gpl-3.0
Created: 2021-03-08T11:12:49.000Z (almost 4 years ago)
Default Branch: main
Last Pushed: 2024-06-12T08:31:02.000Z (7 months ago)
Last Synced: 2024-06-12T13:37:09.474Z (7 months ago)
Topics: discord, discord-bot, discord-js, discordjs, guess-the-number, numbergame
Language: JavaScript
Homepage:
Size: 131 KB
Stars: 6
Watchers: 1
Forks: 4
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Guess The Number

Hello there!
Guess The Number will be a simple and fune number game where you have to guess number b/w given minimum and maximum for some reward that game organizer can set.
Bot can also provide hints (only if asked by game organizer) but that'll lead to less game win points.
Good Luck and Have Fun!

### My Other Bots : [Booster Bot](https://boosterbot.xyz/)

# Getting Started

Setup is quite simple. You can start with **bb help setup** and mainly only 1 command to setup.

## Setup

You can start with `gg help setup` to see what configurations you can edit & you want to set.
- _You can remove any config anytime by setting it's value to `disable`_
_ex : `bb setup manager disable` will remove bot manager role._

Setup command will let you add/edit/remove bot settings like :

| Command | Example | Usage |
|----------|:-------------|:-------|
| prefix | `gg setup prefix !` | It'll change prefix to `!` |
| manager| `gg setup manager @mods` | Mods role will be able to manage bot settings |
| DM | `gg setup dm enable` | Bot will DM to the winner of the game |
| win-role| `gg setup win-role @winners` | Bot will add winners role to the winner |
| req-role| `gg setup req-role @level50` | Users only with this role will be eligible to guess the number |
| lock-role| `gg setup lock-role @level50` | Bot will lock channel for this role after game is over |

## Game Commands

To **start game** admin or bot-manager need to enter just 1 command :
`gg start ` - Bot will start game in mentioned channel with a random number between `min` & `max` value provided.
- Bot will DM the answer to the game organizer (who runs the command).
- Bot will pin the game start and game end message, lock the channel after game ends for given role and add "🔒" emoji to channel name.
- Bot will un-pin all messages sent by bot except for game-end/winning message and remove "🔒" emoji (Sometimes it can hit rate limits).

To **give hint** if you feel game is too difficult you can use :
`gg hint [channel]`
- `first` - shows 1st digit of answer.
- `last` - shows last digit of answer.
- `number` - Tells if answer is smaller or greater then given number.

To **end game** admin or bot-manager need to enter just 1 command :
`gg end ` - Ends the currently ongoing game in mentioned channel.
- No points will be added to anyone.
- Bot will not lock the channel (Like it does after someone guesses the number)
- Bot will un-pin all messages sent by bot except for game-end/winning message.

## Wins

When someone wins bot will add points to thet users and add a role (If enabled by admins).

**How many points bot will add?**
- 1/10 th of the difference between `max` and `min` number in game.

**What are points gonna do?**
- For now, points will help you climb leaderboard (`gg lb`) and It'll show your points and number of games won in your `gg info` command. Other things like purchasable roles using points are planned.

## User Commands

There are lots of commands (like shop for points or roles for points) planned for users.
Till then, here are the commands you can use :

| Command | Example | Usage |
|----------|:-------------|:-------|
| help | `gg help [command]` | List of commands OR Info on 1 command |
| info | `gg info @user` | User's games won & points info |
| leaderboard | `gg lb` | Server's Leader Board based on points |
| invite | `gg invite` | For invite link and other omportant links for bot |

- Your name in Leaderboard and UserInfo will only show up after you win alteast 1 game.