update readme
This commit is contained in:
parent
41e864a0f3
commit
04f56bd3e0
20
README.md
20
README.md
@ -18,6 +18,8 @@ Usage of mumble-discord-bridge:
|
|||||||
DISCORD_GID, discord gid
|
DISCORD_GID, discord gid
|
||||||
-discord-token string
|
-discord-token string
|
||||||
DISCORD_TOKEN, discord bot token
|
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 string
|
||||||
MUMBLE_ADDRESS, mumble server address, example example.com
|
MUMBLE_ADDRESS, mumble server address, example example.com
|
||||||
-mumble-password string
|
-mumble-password string
|
||||||
@ -28,8 +30,24 @@ Usage of mumble-discord-bridge:
|
|||||||
MUMBLE_USERNAME, mumble username (default "discord-bridge")
|
MUMBLE_USERNAME, mumble username (default "discord-bridge")
|
||||||
-mumble-insecure bool
|
-mumble-insecure bool
|
||||||
MUMBLE_INSECURE, allow connection to insecure (invalid TLS cert) mumble server
|
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
|
## Setup
|
||||||
|
|
||||||
### Creating a Discord Bot
|
### 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:
|
The project would not have been possible without:
|
||||||
|
|
||||||
- [gumble](https://github.com/layeh/gumble)
|
- [gumble](https://github.com/layeh/gumble)
|
||||||
- [discordgo](https://github.com/bwmarrin/discordgo)
|
- [discordgo](https://github.com/bwmarrin/discordgo)
|
||||||
|
Loading…
Reference in New Issue
Block a user