fun fact : We are all made of stardust [⭐️]

‎

About

Frenzy Bot is a Discord bot that creates engaging message drop games where users compete to win by sending messages. Features include spam protection, user cooldowns, admin controls, and exciting frenzy modes with multipliers.

‎

Table of Contents

• About
• Table of Contents
• Project Structure
• Commands
• Setup
• Pre-requisites
• Setting Up Environment
• Installing Dependencies
• Configuring the Bot
• Using the Bot
• Hosting the Bot
• Troubleshooting

‎

Project Structure

FrenzyBot/
├── main.py                    # Entry point
├── requirements.txt           # Dependencies
├── core/                      # Core modules
│   ├── __init__.py
│   ├── bot.py                # Bot instance creation
│   ├── config.py             # Global configuration
│   └── game.py               # Game logic and mechanics
├── commands/                  # Command modules
│   ├── __init__.py
│   ├── admin.py              # Administrative commands
│   ├── user_management.py    # User ban/unban commands
│   └── frenzy.py            # Frenzy mode commands
└── utils/                    # Utility modules
    ├── __init__.py
    └── error_handler.py      # Error handling utilities

Commands

Administrative Commands

• /set_log_channel_message_game - Set logging channel
• /start_message_game - Start a new game
• /end_message_game - End an active game
• /active_games - List all active games

User Management Commands

• /ban_user_from_message_game - Ban user from game
• /unban_user_from_message_game - Unban user from game

Frenzy Commands

• /start_frenzy - Start frenzy mode with multipliers

---

Setup

1. Install dependencies: pip install -r requirements.txt
2. Replace YOUR_BOT_TOKEN in main.py with your bot token
3. Run: python main.py

‎

Pre-requisites

Before you begin, ensure you have the following:

• Python 3.13.0: Ensure you have Python installed on your machine. You can download it from python.org.
• Discord Account and a server: You will need an active Discord account and a server to create a bot and test it.

‎

---

Setting Up Environment

Create a Discord Bot Account:

• Go to the Discord Developer Portal.
• Click on "New Application" and enter a name for your bot.
• Navigate to the "Bot" section and click "Add Bot". Confirm the action.

Save Your Bot Token:

• Under the bot settings, find the “Token” section and click "Copy". You’ll need this token later for configuration.

Create a New Server (Optional):

• If you don't already have a server for testing, create a new server on Discord. Use the “+” button in the server list to create a new server.

Invite the Bot to Your Server:

• Under the OAuth2 section, select "URL Generator".
• Under "Scopes", check bot.
• Under "Bot Permissions", check Send Messages, Read Message History, and Read Messages.
• Copy the generated URL and paste it into your browser to invite the bot to your server.

‎

---

Installing Dependencies

1. Clone the Repository: Open your terminal and clone the Frenzy Bot repository:

git clone https://github.com/v3rsion/frenzyBot.git
cd frenzyBot

2. Install the Required Packages: (Ensure you're in the bot's directory.) You can install the required dependencies using pip:

pip install -r requirements.txt

‎

---

Configuring the Bot

Edit the Bot Token:

• Open the bot's main Python file (e.g., bot.py or main.py).

• Replace the placeholder token in the code with the bot token you copied earlier:

  bot.run('YOUR_BOT_TOKEN_HERE')

‎

---

Using the Bot

• 1. Starting the Message Game: In the text channel where the bot is active, use the command to start a message game:

     /start_message_game chance: <number> cooldown: <number> role: <role mention>

  • For example:

    /start_message_game chance: 10 cooldown: 5 role: @Players

• 2. Ending the Game: Administrators can end the current game using:

     /end_message_game

• 3. Managing Users: Administrators can ban or unban users from participating in the game with respective commands. For example:

     /ban_user_from_message_game @user

     /unban_user_from_message_game @user

• 4. Activating Frenzy Mode: To activate frenzy mode:

     /start_frenzy length: <seconds> multiplier: <number>

• 5. Checking Active Games: You can check all active games currently running with:

     /active_games

‎

---

Hosting the Bot

If you want your bot to be online 24/7, consider hosting it on cloud services. Here are some popular options:

a. Hosting on Heroku

1. Create a Heroku Account: Sign up on Heroku.

2. Install the Heroku CLI: Follow the instructions on Heroku CLI Installation.

3. Create a New Heroku App: In the command line:

   heroku create <app-name>

4. Set the Bot Token in Heroku:

   heroku config:set DISCORD_TOKEN='YOUR_BOT_TOKEN'

5. Procfile: Create a file named Procfile in your bot directory with the following content:

   worker: python bot.py

6. Deploy Your Bot: Commit your changes and push to Heroku:

   git add .
   git commit -m "Deploy Frenzy Bot"
   git push heroku master

‎

---

Troubleshooting

Bot Won't Start:

• Ensure that you have correctly copied the bot token and have installed all dependencies.

Bot Not Responding:

• Check the permissions of the bot role in your server.
• Make sure you're using the correct command prefixes and input formats.

Command Errors:

• Ensure that the command parameters are entered correctly, and the role is assigned.

---