https://github.com/shap-po/instruity

Music bot for discord
https://github.com/shap-po/instruity

Last synced: 10 days ago
JSON representation

Music bot for discord

• Host: GitHub
• URL: https://github.com/shap-po/instruity
• Owner: shap-po
• Created: 2021-10-25T09:58:09.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2024-08-28T09:19:24.000Z (3 months ago)
• Last Synced: 2024-08-28T10:39:53.738Z (3 months ago)
• Language: Python
• Size: 163 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Instruity

Custom made discord music bot made for me and my friends.

This bot is meant to be hosted on a Heroku server.

## Features

- Play music from YouTube (`/play `)

- Use slash commands to control the bot

- Has a nice button interface to control the bot (`/actions`)

- You can run multiple instances of the bot on the same server

- Assign a "special" song to a bot via `SPECIALITIES` environment variable to play it via `/perform` command

## Setup

### Create a bot

1. Go to the (Discord Developer Portal)[https://discord.com/developers/applications]

1. Create a new application

1. Go to the "Bot" tab and click "Add Bot"

1. Copy the token and save it for later

1. Go to the "OAuth2" tab and select "bot" and "applications.commands" in the scopes section

1. Select the permissions the bot will need ("Send Messages", "Connect", "Speak" and "Read Messages/View Channels")

1. Copy the link, it will be used to invite the bot to a server

### Deploy the bot

#### Heroku

1. Create a new app on (Heroku)[https://dashboard.heroku.com/new-app]

1. Make sure to use `heroku-20` stack, as later versions have issues with ffmpeg at the time of writing

1. Add the following buildpacks (Settings -> Buildpacks -> Add buildpack):

   - `heroku/nodejs`

   - `heroku/python`

   - `https://github.com/jonathanong/heroku-buildpack-ffmpeg-latest.git`

   - `https://github.com/xrisk/heroku-opus.git`

1. Setup the environment variables (Settings -> Config Vars). See [Configuration](#configuration) for more information

1. Connect the app to the repository (Deploy -> Deployment method -> GitHub)

1. Start the worker (Resources -> worker -> edit -> toggle the switch)

#### Local

1. Clone the repository

1. Install (ffmpeg)[https://www.ffmpeg.org/download.html]

1. Install (Python 3.10+)[https://www.python.org/downloads/]

1. Run the following commands:

    Windows:

    ```cmd

    python -m venv .venv

    .venv\Scripts\activate

    pip install -r requirements.txt

    ```

    Linux:

    ```bash

    python -m venv .venv

    source .venv/bin/activate

    pip install -r requirements.txt

    ```

1. Setup the environment variables. See [Configuration](#configuration) for more information

1. Run the bot with the following command:

    Windows:

        ```cmd

        .venv\Scripts\python bot.py

        ```

    Linux:

        ```bash

        .venv/bin/python bot.py

        ```

#### Docker

1. Clone the repository

1. Build the image with the following command:

    ```bash

    docker build -t instruity .

    ```

1. Run the container with the following command:

    ```bash

    docker run -e TOKENS="token1 token2 ..." -e SPECIALITIES="url1 url2 ..." -e HIDDEN=1 instruity

    ```

## Configuration

Create a `.env` file with the following content:

```env

TOKENS=token1 token2 ...

SPECIALITIES=url1 url2 ... [optional]

HIDDEN=1 [optional]

```

- `TOKENS` - whitespace-separated list of bot tokens (any whitespace is allowed: space, tab, newline, etc.)

- `SPECIALITIES` - whitespace-separated list of URLs to special songs

- `HIDDEN` - if set to `1`, the bots will be shown as offline in the server