Pax-Virtuoso

This is an open-source (MIT licensed) Discord bot that plays music. It's a sister to Pax-Academia and is primarily developed for the Homework Help Discord server, but it will work great in your server too!

Contributing

Anyone and everyone is more than welcome to contribute! Read CONTRIBUTING.md to get started.

Installation

1. Install dependencies with pip

   pip install -r requirements.txt

   or with pip-tools in a virtual environment

   python -m venv .venv\
   .\venv\Scripts\activate
   pip install pip-tools
   pip-sync

2. Create and fill out .env (see ENVIRONMENT.md for more details)

3. Add the bot to your server. Note that this bot requires the following permissions:

   • Read Messages/View Channels
   • Embed Links
   • Use Slash Commands
   • Connect
   • Speak
   • Use Voice Activity
   • Use External Sounds

   You can use this link to invite the bot (replace {CLIENT_ID} with its id):
   https://discord.com/api/oauth2/authorize?client_id={CLIENT_ID}&permissions=35186556290048&scope=bot

4. Run the bot

   python main.py

5. Listen to some tunes 🎶 (see Usage)

Usage

TODO: list out all the commands and how to use them