stryan
/
mumble-discord-bridge
mirror of https://github.com/stryan/mumble-discord-bridge.git
1
0
Fork 0
Code Issues Releases Wiki Activity

update readme

This commit is contained in:
stryan 2021-01-03 21:20:01 -05:00
parent 41e864a0f3
commit 04f56bd3e0
1 changed files with 19 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -18,6 +18,8 @@ Usage of mumble-discord-bridge:
DISCORD_GID, discord gid
-discord-token string
DISCORD_TOKEN, discord bot token
-discord-command string
DISCORD_COMMAND, the string to look for when manually entering commands in Discord (in the form of !DISCORD_COMMAND)
-mumble-address string
MUMBLE_ADDRESS, mumble server address, example example.com
-mumble-password string
@ -28,8 +30,24 @@ Usage of mumble-discord-bridge:
MUMBLE_USERNAME, mumble username (default "discord-bridge")
-mumble-insecure bool
MUMBLE_INSECURE, allow connection to insecure (invalid TLS cert) mumble server
-mumble-channel string
MUMBLE_CHANNEL, pick what channel the bridge joins in Mumble. Must be a direct child of Root.
-auto-mode bool
AUTO_MODE, enables the bridge to automatically start if there's users in both Discord and Mumble
```
The bridge can be manually 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 AUTO_MODE
```
## Setup
### Creating a Discord Bot
@ -110,4 +128,4 @@ Please consider opening an issue to discuss features and ideas.
The project would not have been possible without:
- [gumble](https://github.com/layeh/gumble)
- [discordgo](https://github.com/bwmarrin/discordgo)
- [discordgo](https://github.com/bwmarrin/discordgo)