1
0
mirror of https://github.com/stryan/mumble-discord-bridge.git synced 2024-07-14 07:45:11 -04:00
Go to file
2022-03-02 17:06:35 -05:00
.github/workflows chore: seperate binary and docker actions 2021-12-15 01:11:31 -05:00
cmd/mumble-discord-bridge flag to disable discord bot status 2021-12-13 00:10:48 -05:00
docs idlejitter test 2021-04-18 17:17:16 -04:00
example correct buffer discord buffer axis 2021-08-23 00:35:01 -04:00
internal/bridge don't clear channel ID on auto toggle 2022-03-02 17:06:35 -05:00
pkg/sleepct fix sleepct pausing 2021-09-13 00:50:23 -04:00
test fix sleepct pausing 2021-09-13 00:50:23 -04:00
.dockerignore update docker build 2021-02-01 16:11:12 -05:00
.gitignore chore: abandon goreleaser docker build 2021-12-15 00:55:21 -05:00
.goreleaser.yml chore: abandon goreleaser docker build 2021-12-15 00:55:21 -05:00
Dockerfile build and deploy improvements 2021-12-12 23:54:32 -05:00
go.mod add prometheus metrics 2021-08-23 00:00:39 -04:00
go.sum build and deploy improvements 2021-12-12 23:54:32 -05:00
LICENSE first working commit 2020-10-29 02:21:07 -04:00
Makefile chore: abandon goreleaser docker build 2021-12-15 00:55:21 -05:00
README.md table of options for the readme 2022-02-01 01:44:57 -05:00

Mumble Discord Bridge

Mumble Discord Bridge is an open source Go application to bridge the audio between Mumble and Discord.

It was built with the hope that people can continue to use the voice application of their choice.

PatchCord.io

Mumble Discord Bridge can be hosted on any server or computer and ships in a Docker container for convenience.

If hosting this application yourself seem like an difficult task please consider PatchCord.io. The site even offers a free tier for those who want to try out Mumble Discord Bridge.

Usage

Several configuration variables must be set for the binary to function correctly. All variables can be set using flags or in the environment. The binary will also attempt to load .env file located in the working directory. See the help documentation for all the options

mumble-discord-bridge --help

The bridge can be run with the follow modes:

   auto
       The bridge starts up but does not connect immediately. It can be either manually linked (see below) or will join the voice channels when there's at least one person on each side.
       The bridge will leave both voice channels once there is no one on either end
   manual
       The bridge starts up but does not connect immediately. It will join the voice channels when issued the link command and will leave with the unlink command
   constant (default)
       The bridge starts up and immediately connects to both Discord and Mumble voice channels. It can not be controlled in this mode and quits when the program is stopped

In "auto" or "manual" modes, the bridge can be controlled in Discord with the following commands:

!DISCORD_COMMAND link
 Commands the bridge to join the Discord channel the user is in and the Mumble server

!DISCORD_COMMAND unlink
 Commands the bridge to leave the Discord channel the user is in and the Mumble server

!DISCORD_COMMAND refresh
 Commands the bridge to unlink, then link again.

!DISCORD_COMMAND auto
 Toggle between manual and auto mode

Setup

Creating a Discord Bot

A Discord bot is required to authenticate this application with Discord. The guide below provides information on how to setup a Discord bot.

Create a Discord Bot

Individual Discord servers need to invite the bot before it can connect.
The bot requires the following permissions:

  • View Channels
  • See Messages
  • Read Message History
  • Voice Channel Connect
  • Voice Channel Speak
  • Voice Channel Use Voice Activity

Permission integer 36768768.

Finding Discord CID and GID

Discord GID is a unique ID linked to one Discord Server, also called Guild. CID is similarly a unique ID for a Discord Channel. To find these you need to set Discord into developer Mode.

Instructions to enable Discord Developer Mode

Then you can get the GID by right-clicking your server and selecting Copy-ID. Similarly the CID can be found right clicking the voice channel and selecting Copy ID.

Generating Mumble Client (Optional)

Optionally you can specify a client certificate for mumble Mumble Certificates If you don't have a client certificate, you can generate one with this command:

openssl req -x509 -nodes -days 3650 -newkey rsa:2048 -keyout cert.pem -out cert.pem -subj "/CN=mumble-discord-bridge"

Binary

Prebuilt binaries are available. The binaries require the opus code runtime library to be installed.

# Ubuntu
sudo apt install libopus0
curl -s https://api.github.com/repos/stieneee/mumble-discord-bridge/releases/latest | grep "mumble-discord-bridge" | grep "browser_download_url" | cut -d '"' -f 4 | wget -qi -

Docker

This project is built and distributed in a docker container. A sample docker command can be copied from below. This service command will always attempt to restart the service due to the --restart=always flag even when the server is restarted. For testing purposes it may be best to remove the restart flag.

Replace the environment variables with variable for the desired mumble server, discord bot and discord server/channel.

# Sample for testing
docker docker run -e MUMBLE_ADDRESS=example.com -e MUMBLE_PASSWORD=optional -e DISCORD_TOKEN=TOKEN -e DISCORD_GID=GID -e DISCORD_CID=CID stieneee/mumble-discord-bridge

# Run as a service
docker docker run -e MUMBLE_ADDRESS=example.com -e MUMBLE_PASSWORD=optional -e DISCORD_TOKEN=TOKEN -e DISCORD_GID=GID -e DISCORD_CID=CID --restart=always --name=mumble-discord-bridge -d stieneee/mumble-discord-bridge

# Stop the service
docker stop mumble-discord-bridge && docker rm mumble-discord-bridge

MDB Bridge Options

The following options can be set using environment variables or with command line options.

Environment Option Flag Type Default Description
DEBUG_LEVEL -debug-level int 1 discord debug level
DISCORD_CID -discord-cid string "" discord cid, required
DISCORD_COMMAND -discord-command string "mumble-discord" discord command string, env alt DISCORD_COMMAND, optional
DISCORD_DISABLE_BOT_STATUS -discord-disable-bot-status boolean false disable updating bot status
DISCORD_DISABLE_TEXT -discord-disable-text boolean false disable sending direct messages to discord
DISCORD_GID -discord-gid string "" discord gid, required
DISCORD_TOKEN -discord-token string "" discord bot token, required
MODE -mode string "constant" [constant, manual, auto] determine which mode the bridge starts in
MUMBLE_ADDRESS -mumble-address string "" mumble server address, example example.com, required
MUMBLE_CERTIFICATE -mumble-certificate string "" client certificate to use when connecting to the Mumble server
MUMBLE_CHANNEL -mumble-channel string "" mumble channel to start in, using '/' to separate nested channels, optional
MUMBLE_DISABLE_TEXT -mumble-disable-text boolean false disable sending text to mumble
MUMBLE_INSECURE -mumble-insecure boolean false mumble insecure, ignore ssl certificates issues
MUMBLE_PASSWORD -mumble-password string "" mumble password
MUMBLE_PORT -mumble-port int 64738 mumble port
MUMBLE_USERNAME -mumble-username string "Discord" mumble username
PROMETHEUS_ENABLE -prometheus-enable boolean false enable prometheus metrics
PROMETHEUS_PORT -prometheus-port int 9559 prometheus metrics port
TO_DISCORD_BUFFER -to-discord-buffer int 50 jitter buffer from Mumble to Discord to absorb timing issues related to network, OS and hardware quality. (Increments of 10ms)
TO_MUMBLE_BUFFER -to-mumble-buffer int 50 jitter buffer from Discord to Mumble to absorb timing issues related to network, OS and hardware quality. (Increments of 10ms)

Mumbler Server Setting

To ensure compatibility please edit your murmur configuration file with the following

opusthreshold=0

This ensures all packets are opus encoded and should not cause any compatibility issues if your users are using up to date clients.

Building From Source

This project requires Golang to build from source. A simple go build command is all that is needed. Ensure the opus library is installed.

go install github.com/goreleaser/goreleaser@latest
goreleaser build --skip-validate --rm-dist --single-target --auto-snapshot

OpenBSD Users

OpenBSD users should consider compiling a custom kernel to use 1000 ticks for the best possible performance. See issue 20 for the latest discussion about this topic.

Jitter Buffer

The bridge implements simple jitter buffers that attempt to compensate for network, OS and hardware related jitter. These jitter buffers are configurable in both directions. A jitter buffer will slightly the delay the transmission of audio in order to have audio packets buffered for the next time step. The Mumble client itself includes a jitter buffer for similar reasons. A default jitter of 50ms should be adequate for most scenarios. A warning will be logged if short burst or audio are seen. A single warning can be ignored multiple warnings in short time spans would suggest the need for a larger jitter buffer.

Monitoring the Bridge (Optional)

The bridge can be started with a Prometheus metrics endpoint enabled. The example folder contains the a docker-compose file that will spawn the bridge, Prometheus and Grafana configured to serve a single a pre-configured dashboard.

Mumble Discord Bridge Grafana Dashboard

Known Issues

Currently there is an issue opening the discord voice channel. It is a known issue with a dependency of this project.

Audio leveling from Discord needs to be improved.

Delays in connecting to Mumble (such as from external authentication plugins) may result in extra error messages on initial connection.

There is an issue seen with Mumble-Server (murmur) 1.3.0 in which the bridge will loose the ability to send messages client after prolonged periods of connectivity. This issue has been appears to be resolved by murmur 1.3.4.

License

Distributed under the MIT License. See LICENSE for more information.

Contributing

Issues and PRs are welcome and encouraged. Please consider opening an issue to discuss features and ideas.

Acknowledgement

The project would not have been possible without: