/bonkbot

Discord bot built using discord.py for bonk.io

Primary LanguagePythonGNU General Public License v3.0GPL-3.0

BonkBot

This is a Discord bot built using discord.py with slash commands. It can query Bonk.io API. It still is in WIP and only contains the !status command at the moment.

Features

  • Retrieves player data based on the type specified.
  • Supports the following player types: classic, arrows, grapple, custom, simple, and total.
  • Responds to the !status slash command.

Requirements

  • Python 3.7 or higher

Installation

One-liner with line breaks

Bash

git clone https://github.com/ItsQuadrus/BonkBot.git
cd BonkBot
python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt
echo TOKEN=your-token-here > .env
python3 src

Windows (cmd)

git clone https://github.com/ItsQuadrus/BonkBot.git
cd BonkBot
python -m venv venv
venv\Scripts\activate.bat
pip install -r requirements.txt
echo TOKEN=your-token-here > .env
py src

Manual installation

  1. Clone the repository:
git clone https://github.com/ItsQuadrus/BonkBot.git
  1. Create a virtual environment:

    • Navigate to the project's directory.
    • Run the following command to create a new virtual environment:
      python -m venv venv
  2. Activate the virtual environment:

    • On Windows:
      venv\Scripts\activate.bat
    • On macOS/Linux:
      source venv/bin/activate
  3. Install project dependencies:

    • Run the following command to install the required packages:
      pip install -r requirements.txt
  4. Create a file named .env in the root directory of the project and add the following:

DISCORD_TOKEN=your-token-here
  1. Run the bot:
py src
  1. Invite the bot to your server and type !status.

License

This project is licensed under the Creative Commons Attribution 3.0 Unported License.

You are free to use this code for any purpose, commercial or non-commercial. Attribution is required: you must give credit to the original author.

You also need to indicate if changes were made. e.g. "Translation of BonkBot by ItsQuadrus"