Skip to content

VishalRamesh50/Husky-Bot

Repository files navigation

HuksyBot Banner A multi-function Discord Bot made specifically for the NU (Northeastern) Server

Features

Admin/Mod Only Commands

Public Commands

Getting Started

  1. Clone this repo, e.g
    git clone [email protected]:VishalRamesh50/Husky-Bot.git
  2. Install all dependencies:
    pip install -r requirements.txt
  3. Copy the .env.example file and rename to .env
    cp .env.example .env
  4. Go to https://discordapp.com/developers to create an application and generate a TOKEN for a Bot account.
    • Click the New Application Button.
    • Give a name.
    • Go the the Bot section.
    • Select the "Add bot" button.
    • Find your TOKEN from the Bot section.
    • Open the .env file and replace the TOKEN with your unique TOKEN. Do not expose this anywhere!
    • Your application will not run without this.
  5. Create a mongoDB cluster
    • When in the Clusters section of mongoDB Atlas, click the "Connect" button.
    • Choose "Connect Your Application".
    • Select Python as the driver and Version 3.6 or later.
    • Copy the connection string, replace your username and password in it, and replace the DB_CONNECTION_URL with this in the .env file.
  6. Register a Twitch application at https://dev.twitch.tv/console.
    • This is required for the twitch module.
    • Click the "Register Your Application" button.
    • Get the Client-ID from your appilication and replace the TWITCH_CLIENT_ID with it in the .env file.
    • Get the Client Secret from your application and replace the TWITCH_CLIENT_SECRET with it in the .env file.
  7. Run the application using
    python src/main.py

Note: This bot was intended to be specifically for the NU Discord Server. There may be features that will not work in any other server.

Documentation

Check out the documentation here