ticoombs
/
mumble-music
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
157 Commits 2 Branches 4 Tags 151 KiB
JavaScript 98.4%
Dockerfile 1.6%
Go to file
Tim d122d15dc3 feat: choose worst audio to speed up download 2021-10-19 15:07:40 +11:00
src feat: choose worst audio to speed up download 2021-10-19 15:07:40 +11:00
.gitignore ignore statistics.json 2019-11-17 14:48:47 -05:00
.npmignore ignore statistics.json 2019-11-17 14:48:47 -05:00
Dockerfile Suppress yt-dl error 2020-11-17 21:48:10 +01:00
LICENSE Create LICENSE 2019-09-23 11:36:13 +00:00
README.md Added configuration information 2019-09-26 09:55:52 -04:00
config.example.json Added external downloader support 2019-10-07 11:26:54 -04:00
docker-compose.yml feat: choose worst audio to speed up download 2021-10-19 15:07:40 +11:00
package-lock.json Initial commit 2019-07-19 16:45:33 -04:00
package.json bump version 2019-12-18 15:47:56 -05:00
server.js added plays view to !top command 2020-04-15 23:20:09 -04:00

README.md

mumble-music

This is a simple music bot for Mumble written because all the others required too much setup work.

Setup

  1. Make sure you have youtube-dl and ffmpeg installed to a location accessible by your PATH variable.
  2. Copy config.example.json to config.json, open with a text editor, and edit the settings to your liking
  3. Run npm install and npm start
  4. Enjoy!

Configuration

  • server: URL of the server to connect to
  • password: Server password
  • bitrate: Bitrate of audio to transmit measured in bits per second. Note that if this goes over the server limit, the audio will abruptly cut out frequently. There's also quite a bit of overhead, so try to go at least 42,000 below the server maximum. If this value is set to null, the bitrate will automatically be set based on this overhead estimation.
  • maxlength: The maximum length of a song in seconds
  • name: Username to use when connecting
  • channel: Channel to join after connecting
  • cache: Length of time to store cached songs for. Set to null to store indefinitely.
  • privkey: SSL private key to use. Set to null to avoid using a certificate.
  • cert: SSL cert for the private key in the previous line. Should be null if the private key is also null.

Generating SSL Certificates

Here's the command to generate a self-signed SSL certificate and private key for use with this bot:

openssl req -newkey rsa:4096 -nodes -days 32768 -x509 -keyout privkey.pem -out cert.pem

In this case, the value for "privkey" in the configuration would be "privkey.pem" and the value for "cert" in the configuration would be "cert.pem."