nxrmqlly/Orbyt

A QoL, multifunctional Discord Bot for devs and Discord enthusiasts.

Orbyt ✨

Orbyt is a versatile, quality-of-life Discord Bot for Discord enthusiasts. [ ⚠️ In Development ] (See: Contributing)

Invite Orbyt HERE

Table of contents

1. Features
2. License
3. Getting Started
   • Clone the Repository
   • Install Dependencies
   • Set Up Configuration
   • Bot Authorization
   • Configure Debugging (Optional)
   • Invite the Bot
   • Start the Bot
4. Extended Configuration
5. Support
6. Contributing

Features

• Tags A Robust system for quick responders, saving text etc.
• Information Based commands like /info user, /info server etc.
• Festive Limited time commands for a season.

Getting Started

To get started with Orbyt on your local machine:

1. Clone the Repository:

   • Clone this repository to your local machine.

2. Install Dependencies:

   • Run python[3] -m pip install -r requirements.txt to install all necessary dependencies.
   • Run python[3] -m pip install -r requirements.dev.txt if you consider Contributing.

3. Set Up Configuration:

   • Rename config.example.py to config.py.
   • Fill out the config.py file. (See Configuration)

4. Bot Authorization:

   • Create a new Discord Application + Bot on the Discord Developer Portal.
   • Set your main bot token into config.py.
   • If you are testing/debugging, set the DEBUG_BOT_TOKEN.

5. Configure Debugging (Optional):

   • If testing/debugging, set DEBUG to True in the config.py.
   • ⚠️ Set the DEBUG_TOKEN for the bot to function in debug mode.

6. Invite the Bot:

   • Generate an invite link from the Discord Developer Portal and invite the bot.

7. Start the Bot:

   • Run the bot using python[3] main.py.

Configuration

Ensure to configure the config.py file with the following parameters:

# config.py

## ----- PRODUCTION RELATED ----- ##
PROD_TOKEN = ""  # Main Discord Bot Token


## ----- DEBUG RELATED ----- ##
DEBUG = False  # Debug Mode? (Optional) - If True then DEBUG_BOT_TOKEN must be set
DEBUG_BOT_TOKEN = ""  # Debug Bot Token (Optional)

Support

For any assistance, feedback, or bug reports, join the Support Server.

---

Contributing

I appreciate your contributions! Create a pull request for any improvements or corrections after forking the repository.

License

Copyright (c) 2023-present Ritam Das

This project is licensed under the GNU Affero General Public License v3.0 (AGPL-3.0). See the LICENSE file for details.