NBC-Boterator

Custom Bot for the Northbridge Café Discord Server

Report a Bug · Request a Feature · Open a Pull Request

Table of Contents 📑

• About the Project
  • Fair Use
  • Built With
• Getting Started
  • Prerequisites
  • Installation
  • Running
• Usage
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

About The Project 👋

This is a simple but tailored discord bot created for the purpose of enhancing user experience within a tech server that I own (and also because programming is a hobby of mine).

Fair Use ‼️

I don't mind if you run this bot locally and use it in a private discord server with the intention of testing code contributions or learning/experimenting with the discord.py library. In fact, I encourage this (which is why I provide setup instructions below).

What I do not appreciate is anyone who runs a one-to-one copy of this bot with the intention of using it publically, advertising this copy on sites like top.gg and/or claiming it as their own work.

Built With 🛠️

• Discord.py

Getting Started ⚙️

Here's what you need to do to get a local instance of NBC Boterator up and running:

Prerequisites 🧰

• Python 3.6+
• Git
  • Windows
  • OS X
  • Linux
• Discord Application Token

Installation 💻

1. Open a terminal
2. Switch to the directory that you want the source code to be located in

cd PATH/TO/YOUR/DIRECTORY

3. Clone this repository

git clone https://github.com/lukadd16/NBC-Boterator.git

4. Create a Python virtual environment (in the current directory)

• Windows

py -m venv env

• Mac OS/Linux

python3 -m venv env

5. Activate the virtual environment

• Windows

.\env\Scripts\activate

• Mac OS/Linux

source env/bin/activate

6. Install Dependencies

pip install -r requirements.txt

Running 🏃

1. Set up the configuration file

• Rename config.example.py located in the root directory to config.py

• Populate the BOT_TOKEN field with your discord application token.

⚠️Note: Support for fields such as BOT_EMOJI or CHANNEL_ID will not be provided

# Discord Application Token
BOT_TOKEN = "your-token-here"

# Bot Prefix
BOT_PREFIX = "jj "

# ...

2. Activate the previously created virtual environment
3. Launch the bot

• Windows

py main.py

• Mac OS/Linux

python3 main.py

4. Success!

🎉 At this point you should see some output to the terminal telling you that the bot has established a connection to discord.

Usage 🔍

Run the help command jj help for information on how to use each of the bot's commands (minus owner-only commands).

I may add GIFs/screenshots in the future to demonstrate how to use certain commands, who knows ¯\_(ツ)_/¯.

Roadmap 🚧

See the open issues for a list of proposed features (and known issues).

Contributing 🤝

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork this repository
2. Clone your Fork (git clone https://github.com/your-username/NBC-Boterator.git)
3. Create your Feature Branch (git checkout -b feature/AmazingFeature)
4. Commit your Changes (git commit -am 'Add some AmazingFeature')
5. Push to the Branch (git push origin feature/AmazingFeature)
6. Open a Pull Request

License 📄

Distributed under the BSD 3-Clause License. See LICENSE for more information.

Contact 🎯

Discord - Lukadd.16#8870

Northbridge Café Discord Server (where this bot is solely used) - Click to join 😎

Repository Link: https://github.com/lukadd16/NBC-Boterator

Acknowledgements 📢

• Best-README-Template
• Discord.py's amazing documentation
• Stack Overflow, a programmer's best friend 🙏
• emoji-cheat-sheet