2022-11-21 15:29:03 +00:00
|
|
|
# umi
|
|
|
|
|
|
|
|
|
|
a self-hostable single-guild discord bot for playing music and announcing vc channel joins/leaves
|
|
|
|
|
|
|
|
|
|
## Pre-requisites
|
|
|
|
|
|
|
|
|
|
Install dependencies:
|
|
|
|
|
|
|
|
|
|
- FFI: `libffi`
|
|
|
|
|
- NaCl: `libnacl` or `libsodium`
|
2022-12-12 14:58:47 +00:00
|
|
|
- FFmpeg: `ffmpeg`
|
2024-05-10 19:48:20 +00:00
|
|
|
- yt-dlp: `yt-dlp`
|
2024-05-13 05:48:38 +00:00
|
|
|
- opus: `opus`
|
2022-11-21 15:29:03 +00:00
|
|
|
|
|
|
|
|
Copy `.env.example` to `.env`:
|
|
|
|
|
|
|
|
|
|
- `DISCORD_BOT_TOKEN` is obtained from the [Discord Developer Dashboard](https://discord.com/developers/applications)
|
|
|
|
|
- Click or create an application
|
|
|
|
|
- Get your token from the "Bot" section in the sidebar menu
|
|
|
|
|
|
|
|
|
|
- `DISCORD_GUILD_ID` is obtained from within the Discord app
|
|
|
|
|
- Settings > Advanced > Developer Mode: enabled
|
|
|
|
|
- Right click the guild and select "Copy ID"
|
|
|
|
|
|
|
|
|
|
- `DISCORD_BOT_ADMIN_ROLE_ID` for reloading cogs
|
|
|
|
|
- `DISCORD_BOT_ADMIN_USER_ID` for reloading cogs
|
2022-12-12 12:01:52 +00:00
|
|
|
- `DISCORD_VCJOIN_CHANNEL` for the VCJoin cog
|
2022-11-21 15:29:03 +00:00
|
|
|
|
|
|
|
|
## Setup
|
|
|
|
|
|
2022-12-12 14:58:47 +00:00
|
|
|
### ...with PDM
|
2022-11-21 15:29:03 +00:00
|
|
|
|
|
|
|
|
```sh
|
|
|
|
|
pdm install --prod
|
|
|
|
|
pdm run python app.py
|
|
|
|
|
```
|
|
|
|
|
|
2022-12-12 14:58:47 +00:00
|
|
|
### ...with requirements.txt and virtualenv
|
2022-11-21 15:29:03 +00:00
|
|
|
|
|
|
|
|
```sh
|
|
|
|
|
virtualenv .venv
|
|
|
|
|
source .venv/bin/activate
|
|
|
|
|
pip install -r requirements.txt
|
|
|
|
|
python app.py
|
2022-12-12 14:58:47 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### ...with Docker Compose
|
|
|
|
|
|
|
|
|
|
```sh
|
|
|
|
|
docker compose build
|
|
|
|
|
docker compose up -d
|
2022-11-21 15:29:03 +00:00
|
|
|
```
|
