- Go 99.7%
- Dockerfile 0.3%
| Filename | Latest commit message | Latest commit date |
|---|---|---|
| .forgejo/workflows | ||
| bot | ||
| commands | ||
| interfaces | ||
| models | ||
| services | ||
| .gitignore | ||
| config.yaml | ||
| CONTRIBUTING.md | ||
| Dockerfile | ||
| go.mod | ||
| go.sum | ||
| LICENSE | ||
| main.go | ||
| README.md | ||
MumbleDJ
A Mumble bot that plays audio fetched from youtube and local storage.
Non-dead fork of matthieugrieger's mumbledj
Features
- Plays audio/downloads from YouTube and play audio locally (disabled by default).
- Supports playlists and individual videos/tracks.
- Displays metadata in the text chat whenever a new track starts playing.
- A large array of commands that perform a wide variety of functions.
- Supports local storage playback with custom tags, based on youtube downloads.
- Built-in vote-skipping.
- Built-in caching system (disabled by default).
- Built-in play/pause/volume control.
Requirements
uMurmur servers are not supported due to bandwith limits.
YouTube API Key
A YouTube API key must be present in your configuration file in order to use the YouTube service within the bot. Below is a guide for retrieving an API key:
1) Navigate to the Google Developers Console and sign in with your Google account, or create one if you haven't already.
2) Click the "Create Project" button and give your project a name. It doesn't matter what you set your project name to. Once you have a name click the "Create" button. You should be redirected to your new project once it's ready.
3) Click on "APIs & auth" on the sidebar, and then click APIs. Under the "YouTube APIs" header, click "YouTube Data API". Click on the "Enable API" button.
4) Click on the "Credentials" option underneath "APIs & auth" on the sidebar. Underneath "Public API access" click on "Create New Key". Choose the "Server key" option.
5) Add the IP address of the machine MumbleDJ will run on in the box that appears (this is optional, but improves security). Click "Create".
6) You should now see that an API key has been generated. Copy/paste this API key into the configuration file located at $HOME/.config/mumbledj/mumbledj.yaml.
Installation- containers
The only supported way to run this bot is via Kubernetes or Docker/Podman.
You can find working K8S config inside This repo
Buidling your own image
First you need to clone the MumbleDJ repository to your machine:
git clone https://git.roshless.me/roshless/mumbledj
Then build the image:
docker build -t mumbledj .
Using prebuild images
See link