Mustang-Bot

Source code of Mustang Bot in the Cal Poly Class of 2026 Discord Server

Built With

• Python 3:
  • Discord.py
  • async
  • os
  • psutil
  • virtualenv
• Visual Studio Code

How to Use Mustang-Bot

Method 1: Invite Link

In the case you are interested in just using the bot, you can invite the bot to your server by following this link.

Method 2: Running it Locally

To get a local copy up and running follow these instructions.

Prerequisites

• Working Python 3 >= 3.10.0 installation

  • pip is working

• Visual Studio Code

  • Python Extension

Installation

1. Create a Virtual Python Environment
   • Creating a Virtual Enviorment (Linux):

     virtualenv .venv
     source .venv/bin/activate

   • Creating a Virtual Enviorment (Windows):

     pip install virtualenv
     virtualenv .venv
     .venv/Scripts/activate

2. Clone the repo

   git clone https://github.com/Kaweees/Mustang-Bot.git

3. Install/update project requirments (administrator permissions may be required)

   pip install upgrade
   pip install -r requirements.txt

Before Running

1. Configure the following environment variables in a .env file for the bot

• TOKEN: bot token

Running locally

1. Move to the root directory

   cd Mustang-Bot

2. Run the bot

   python boy.py

Method 2: Hosting via Heroku

In the case you are interested in running the bot via Heroku, you can follow these instructions.

Via Heroku CLI

1. Log onto Heroku.

   heroku login

2. Create a new application or open an existing application. Note the name of the application.
3. Go to Settings > Add Build path > Python
4. Install the Heroku CLI by following this link.
5. Move to the root directory

   cd Mustang-Bot

6. Create a .env file locally and configure it as in Before Running
7. Push the files to a New or Exsisting Heroku App.

• For a New App

  heroku create -a example-app

• For an Existing App

  heroku git:remote -a "poly-mustang-bot"

8. Deploy the local main branch to Heroku remotely

• For the local main branch

  git push heroku main

• From a branch besides main

  git push heroku branch-name:main

11. The bot should be active after a few minutes. Enjoy!
12. To stop the bot

    heroku ps:stop "poly-mustang-bot"  

Via Heroku Website

1. Log onto Heroku.
2. Create a new application or open an existing application.
3. Go to Deploy > Deployment method > Connect with GitHub and add this repository. You must have access to this repository on a Github account for this to work, or access to a fork of this repository.
4. Go to Deploy > Deploy Branch > Main Branch to depoly the recent version of the Main branch.
5. Repeat steps 2-4 whenever the Main Branch is updated to have access the latest features of the bot.
6. Go to Resources. Press Edit, and hit the sliding button so that it is on and hit Confirm.
7. The bot should be active after a few minutes. Enjoy!

Contributing

Contributions are always welcome! Please create a Pull Request and include a description of how your Pull Request will improve the overall robot code and what it does.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

This project is licensed under the MIT License. See LICENSE.txt for more information.

Support Us!

Give this repo a ⭐️ if you found this project helpful!

Acknowledgments

• othneildrew's Best README Template
• discord.py Documentation