leoverto/mumbledj repository overview

⁠MumbleDJ

A Mumble bot that plays audio fetched from various media websites.

⁠Table of Contents

• Features⁠
• Installation⁠
  • Requirements⁠
    • YouTube API Key⁠
    • SoundCloud API Key⁠
  • Via go get⁠
  • Pre-compiled Binaries⁠
  • From Source⁠
  • Docker⁠
• Sample player⁠
• Usage⁠
• Commands⁠
• Contributing⁠
• Author⁠
• License⁠
• Thanks⁠

⁠Features

• Plays audio from many media websites, including YouTube, SoundCloud, and Mixcloud.
• Supports playlists and individual videos/tracks.
• Displays metadata in the text chat whenever a new track starts playing.
• Plays audio samples embedded in binary and from filesystem More Info⁠
• Incredibly customizable. Nearly everything is able to be tweaked via configuration files (by default located at $HOME/.config/mumbledj/config.yaml).
• A large array of commands⁠ that perform a wide variety of functions.
• Built-in vote-skipping.
• Built-in caching system (disabled by default).
• Built-in play/pause/volume control.

⁠Installation

IMPORTANT NOTE: MumbleDJ is only tested and developed for Linux systems. If something doesn't work in Windows and the others OS, create an issue please.

⁠Requirements

All MumbleDJ installations must also have the following installed:

• youtube-dl⁠
• ffmpeg⁠ OR avconv⁠
• aria2⁠ if you plan on using services that throttle download speeds (like Mixcloud)
• openssl⁠ if you plan using p12 certificates for authentication

If installing via go install or from source, the following must be installed:

• Go 1.11+⁠
  • If the repositories for your distro contain a version of Go older than 1.11, try using gvm⁠ to install Go 1.11 or newer.

⁠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/config.yaml.

⁠SoundCloud API Key

A SoundCloud client ID must be present in your configuration file in order to use the SoundCloud service within the bot. Below is a guide for retrieving a client ID:

1) Login/sign up for a SoundCloud account on https://soundcloud.com⁠.

2) Create a new app: https://soundcloud.com/you/apps/new⁠.

3) You should now see that a client ID has been generated. Copy/paste this ID (NOT the client secret) into the configuration file located at $HOME/.config/mumbledj/config.yaml.

⁠From Source (recommended)

First, clone the MumbleDJ repository to your machine:

git clone https://github.com/reikion/mumbledj

Install the required software as described in the requirements section⁠, and execute the following:

make

This will place a compiled mumbledj binary in the cloned directory if successful. If you would like to make the binary more accessible by adding it to /usr/local/bin, simply execute the following:

sudo make install

⁠Pre-compiled Binaries (easiest)

Pre-compiled binaries are provided for convenience. Overall, I do not recommend using these unless you cannot get go install to work properly. Binaries compiled on your own machine are likely more efficient as these binaries are cross-compiled from a 64-bit Linux system.

After verifying that the requirements⁠ are installed, simply visit the releases page⁠ and download the appropriate binary for your platform.

⁠Docker

You can also use Docker⁠ to run MumbleDJ.

First you need to clone the MumbleDJ repository to your machine:

git clone https://github.com/reikion/mumbledj

Assuming you have Docker installed⁠, you will have to build the image:

docker build -t mumbledj .

And then you can run it, passing the configuration through the command line:

docker run --rm --name=mumbledj mumbledj --server=SERVER --api_keys.youtube=YOUR_YOUTUBE_API_KEY --api_keys.soundcloud=YOUR_SOUNDCLOUD_API_KEY

In order to run the process as a daemon and restart it automatically on reboot you can use:

docker run -d --restart=unless-stopped --name=mumbledj mumbledj --server=SERVER --api_keys.youtube=YOUR_YOUTUBE_API_KEY --api_keys.soundcloud=YOUR_SOUNDCLOUD_API_KEY

⁠Default config

You can embed your config.yaml into binary if you plan to compile Mumbledj from source. Please note that everybody, who can open Mumbledj binary in text editor can also read your API secrets! To embed default config copy assets/config.yaml.example to assets/assets/config.yaml and customize as needed.

⁠Sample player

MumbleDJ allows to play random flac samples from given category embedded in binary and from filesystem. To embed samples:

• create assets directory in source code assets directory
• create category folder for samples, i.e. wololo
• put sample in that folder named in format 1.flac, 2.flac etc.

To play samples from filesystem you need the same layout of files, but you need drop your assets directory in current working directory of MumbleDJ.

Example of structure of files in MumbleDJ source code:

assets
├── assets
│   ├── config.yaml
│   ├── nani
│   │   ├── 1.flac
│   └── wololo
│       ├── 1.flac
│       └── 2.flac
├── assets.go
└── config.yaml.example

Example of structure of files in filesystem. MumbleDJ has been started from /home/mumbledj

/home/mumbledj/assets
               ├── nani
               │   ├── 1.flac
               └── wololo
                  ├── 1.flac
                  └── 2.flac

To play sample you need to use ohohoho command⁠. Please note that MumbleDJ needs to be restarted to discover new category created in filesystem.

⁠Usage

MumbleDJ is a compiled program that is executed via a terminal.

Here is an example helptext that gives you a feel for the various commandline arguments you can give MumbleDJ:

NAME:
   MumbleDJ - A Mumble bot that plays audio from various media sites.

USAGE:
   mumbledj [global options] command [command options] [arguments...]

VERSION:
   v3.4.1

COMMANDS:
GLOBAL OPTIONS:
   --config value, -c value		location of MumbleDJ configuration file (default: "$HOME/.config/mumbledj/config.yaml")
   --server value, -s value		address of Mumble server to connect to (default: "127.0.0.1")
   --port value, -o value		port of Mumble server to connect to (default: "64738")
   --username value, -u value		username for the bot (default: "MumbleDJ")
   --password value, -p value		password for the Mumble server
   --channel value, -n value		channel the bot enters after connecting to the Mumble server
   --p12 value				path to user p12 file for authenticating as a registered user
   --cert value, -e value		path to PEM certificate
   --key value, -k value		path to PEM key
   --accesstokens value, -a value	list of access tokens separated by spaces
   --insecure, -i			if present, the bot will not check Mumble certs for consistency
   --debug, -d				if present, all debug messages will be shown
   --help, -h				show help
   --version, -v			print the version

NOTE: You can also override all settings found within config.yaml directly from the commandline. Here's an example:

mumbledj --admins.names="SuperUser,Matt" --volume.default="0.5" --volume.lowest="0.2" --queue.automatic_shuffle_on="true"

Keep in mind that values that contain commas (such as "SuperUser,Matt") will be interpreted as string slices, or arrays if you are not familiar with Go. If you want your value to be interpreted as a normal string, it is best to avoid commas for now.

⁠Commands

⁠add

• Description: Adds a track or playlist from a media site to the queue.
• Default Aliases: add, a
• Arguments: (Required) URL(s) to a track or playlist from a supported media site.
• Admin-only by default: No
• Example: !add https://www.youtube.com/watch?v=KQY9zrjPBjo

⁠addnext

• Description: Adds a track or playlist from a media site as the next item in the queue.
• Default Aliases: addnext, an
• Arguments: (Required) URL(s) to a track or playlist from a supported media site.
• Admin-only by default: Yes
• Example: !addnext https://www.youtube.com/watch?v=KQY9zrjPBjo

⁠cachesize

• Description: Outputs the file size of the cache in MiB if caching is enabled.
• Default Aliases: cachesize, cs
• Arguments: None
• Admin-only by default: Yes
• Example: !cachesize

⁠currenttrack

• Description: Outputs information about the current track in the queue if one exists.
• Default Aliases: currenttrack, currentsong, current
• Arguments: None
• Admin-only by default: No
• Example: !currenttrack

⁠forceskip

• Description: Immediately skips the current track.
• Default Aliases: forceskip, fs
• Arguments: None
• Admin-only by default: Yes
• Example: !forceskip

⁠forceskipplaylist

• Description: Immediately skips the current playlist.
• Default Aliases: forceskipplaylist, fsp
• Arguments: None
• Admin-only by default: Yes
• Example: !forceskipplaylist

⁠help

• Description: Outputs a list of available commands and their descriptions.
• Default Aliases: help, h
• Arguments: None
• Admin-only by default: No
• Example: !help

⁠joinme

• Description: Moves MumbleDJ into your current channel if not playing audio to someone else.
• Default Aliases: joinme, join
• Arguments: None
• Admin-only by default: Yes
• Example: !joinme

⁠kill

• Description: Stops the bot and cleans its cache directory.
• Default Aliases: kill, k
• Arguments: None
• Admin-only by default: Yes
• Example: !kill

⁠listtracks

• Description: Outputs a list of the tracks currently in the queue.
• Default Aliases: listtracks, listsongs, list, l
• Arguments: (Optional) Number of tracks to list
• Admin-only by default: No
• Example: !listtracks 10

⁠move

• Description: Moves the bot into the Mumble channel provided via argument.
• Default Aliases: move, m
• Arguments: (Required) Mumble channel to move the bot into
• Admin-only by default: Yes
• Example: !move Music

⁠nexttrack

• Description: Outputs information about the next track in the queue if one exists.
• Default Aliases: nexttrack, nextsong, next
• Arguments: None
• Admin-only by default: No
• Example: !nexttrack

⁠numcached

• Description: Outputs the number of tracks cached on disk if caching is enabled.
• Default Aliases: numcached, nc
• Arguments: None
• Admin-only by default: Yes
• Example: !numcached

⁠numtracks

• Description: Outputs the number of tracks currently in the queue.
• Default Aliases: numtracks, numsongs, nt
• Arguments: None
• Admin-only by default: No
• Example: !numtracks

⁠ohohoho

• Description: "Sample player of ohohoho and the others samples"
• Default Aliases: ohohoho, oh
• Arguments:
  • None to list categories
  • category name
  • (Optional) how many times to play random samples from given category
• Admin-only by default: No
• Example: !oh wololo 10

⁠pause

• Description: Pauses audio playback.
• Default Aliases: pause
• Arguments: None
• Admin-only by default: No
• Example: !pause

⁠register

• Description: Registers the bot on the server.
• Default Aliases: register, reg
• Arguments: None
• Admin-only by default: Yes
• Example: !register

⁠reload

• Description: Reloads the configuration file.
• Default Aliases: reload, r
• Arguments: None
• Admin-only by default: Yes
• Example: !reload

⁠reset

• Description: Resets the queue by removing all queue items.
• Default Aliases: reset, re
• Arguments: None
• Admin-only by default: Yes
• Example: !reset

⁠resume

• Description: Resumes audio playback.
• Default Aliases: resume
• Arguments: None
• Admin-only by default: No
• Example: !pause

⁠search:

• Description: Search for track and add it to the queue.
• Default Aliases: search, se
• Arguments: Search query for search engine
• Admin-only by default: No
• Example: !search techno union

⁠setcomment

• Description: Sets the comment displayed next to MumbleDJ's username in Mumble. If the argument is left empty, the current comment is removed.
• Default Aliases: setcomment, comment, sc
• Arguments: (Optional) New comment
• Admin-only by default: Yes
• Example: !setcomment Hello! I'm a bot. Beep boop.

⁠shuffle

• Description: Randomizes the tracks currently in the queue.
• Default Aliases: shuffle, shuf, sh
• Arguments: None
• Admin-only by default: Yes
• Example: !shuffle

⁠skip

• Description: Places a vote to skip the current track.
• Default Aliases: skip, s
• Arguments: None
• Admin-only by default: No
• Example: !skip

⁠skipplaylist

• Description: Places a vote to skip the current playlist.
• Default Aliases: skipplaylist, sp
• Arguments: None
• Admin-only by default: No
• Example: !skipplaylist

⁠toggleshuffle

• Description: Toggles permanent track shuffling on/off.
• Default Aliases: toggleshuffle, toggleshuf, togshuf, tsh
• Arguments: None
• Admin-only by default: Yes
• Example: !toggleshuffle

⁠version

• Description: Outputs the current version of MumbleDJ.
• Default Aliases: version, v
• Arguments: None
• Admin-only by default: No
• Example: !version

⁠volume

• Description: Changes the volume if an argument is provided, outputs the current volume otherwise.
• Default Aliases: volume, vol
• Arguments: (Optional) New volume
• Admin-only by default: No
• Example: !volume 0.5

⁠Contributing

Contributions to MumbleDJ are always welcome!

⁠Author

Matthieu Grieger⁠

⁠Maintainer

Reikion⁠

⁠License

The MIT License (MIT)

Copyright (c) 2016 Matthieu Grieger

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

⁠Thanks

• All those who contribute to Mumble⁠
• Tim Cooper⁠ for gumble, gumbleffmpeg, and gumbleutil⁠
• Jeremy Saenz⁠ for cli⁠
• Anton Holmquist⁠ for jason⁠
• Stretchr, Inc.⁠ for testify⁠
• ChannelMeter⁠ for iso8601duration⁠
• Steve Francia⁠ for viper⁠
• Simon Eskildsen⁠ for logrus⁠
• Mitchell Hashimoto⁠ for gox⁠
• Jim Teeuwen⁠ for go-bindata⁠