From ddf60fa38eb8a24737031fd4dfcd254aebb75edb Mon Sep 17 00:00:00 2001 From: Qais Patankar Date: Sun, 3 Jan 2021 19:02:12 +0000 Subject: [PATCH] Sync from matterbridge.sample.toml --- Section-Discord-(basic).md | 44 ++++++++++++++++++++++++-------------- 1 file changed, 28 insertions(+), 16 deletions(-) diff --git a/Section-Discord-(basic).md b/Section-Discord-(basic).md index a72ef0f..4dcd929 100644 --- a/Section-Discord-(basic).md +++ b/Section-Discord-(basic).md @@ -20,47 +20,59 @@ RemoteNickFormat="[{PROTOCOL}] <{NICK}> " ```toml [discord] +# You can configure multiple servers "[discord.name]" or "[discord.name2]" +# In this example we use [discord.game] +#REQUIRED [discord.game] # Token (REQUIRED) is the token to connect with Discord API -# You can get your token by following the instructions on +# You can get your token by following the instructions on # https://github.com/reactiflux/discord-irc/wiki/Creating-a-discord-bot-&-getting-a-token # If you want roles/groups mentions to be shown with names instead of ID, you'll need to give your bot the "Manage Roles" permission. Token="Yourtokenhere" -# Server is the ID or name of the guild to connect to, selected from the guilds the bot has been invited to +# Server (REQUIRED) is the ID or name of the guild to connect to, selected from the guilds the bot has been invited to Server="yourservername" ## RELOADABLE SETTINGS -## Settings below can be reloaded by editing the file +## All settings below can be reloaded by editing the file. +## They are also all optional. # ShowEmbeds shows the title, description and URL of embedded messages (sent by other bots) ShowEmbeds=false +# UseLocalAvatar specifies source bridges for which an avatar should be 'guessed' when an incoming message has no avatar. +# This works by comparing the username of the message to an existing Discord user, and using the avatar of the Discord user. +# +# This only works if WebhookURL is set (AND the message has no avatar). +# Example: ["irc"] +UseLocalAvatar=[] + # UseUserName shows the username instead of the server nickname UseUserName=false # UseDiscriminator appends the `#xxxx` discriminator when used with UseUserName UseDiscriminator=false -# WebhookURL, if specified, will send messages in the style of puppets. -# This only works if you have one discord channel, if you have multiple discord channels you'll have to specify it in the gateway config -# Example: "https://discordapp.com/api/webhooks/1234/abcd_xyzw" -WebhookURL="" +# AutoWebhooks automatically configures message sending in the style of puppets. +# This is an easier alternative to manually configuring "WebhookURL" for each gateway, +# as turning this on will automatically load or create webhooks for each channel. +# This feature requires the "Manage Webhooks" permission (either globally or as per-channel). +AutoWebhooks=false -# EditDisable allows you to disable sending of edits to other bridges +# EditDisable disables sending of edits to other bridges EditDisable=false # EditSuffix specifies the message to be appended to every edited message # Example: " (edited)" EditSuffix="" -# IgnoreNicks allows you to mute outgoing messages from certain users. +# IgnoreNicks mutes outgoing messages from certain users. # Messages from these users will not be transmitted to other bridges. # Regular expressions are also supported. # Example: "ircspammer1 ircspammer2" IgnoreNicks="" -# IgnoreMessages allows you to mute outgoing messages of a certain format. +# IgnoreMessages mutes outgoing messages of a certain format. # Messages matching this regular expression will not be transmitted sent to other bridges # See https://regex-golang.appspot.com/assets/html/index.html for more regex info # @@ -107,26 +119,26 @@ ReplaceNicks=[] # ExtractNicks=[] -# Label can be used as an extra identifier for use in the RemoteNickFormat setting. +# Label is as an extra identifier for use in the RemoteNickFormat setting. Label="" -# RemoteNickFormat specifies how remote users appear on this bridge. +# RemoteNickFormat formats how remote users appear on this bridge. # See the [general] config section for default options RemoteNickFormat="[{PROTOCOL}] <{NICK}> " -# ShowJoinPart will emit messages that show joins/parts from other bridges +# ShowJoinPart emits messages that show joins/parts from other bridges # Supported from the following bridges: irc, mattermost, slack, discord ShowJoinPart=false -# StripNick will strip non-alphanumeric characters from nicknames. +# StripNick strips non-alphanumeric characters from nicknames. # Recommended reading: https://github.com/42wim/matterbridge/issues/285 StripNick=false -# ShowTopicChange will emit messages that show topic/purpose updates from other bridges +# ShowTopicChange emits messages that show topic/purpose updates from other bridges # Supported from the following bridges: slack ShowTopicChange=false -# SyncTopic will sync topic/purpose updates from other bridges +# SyncTopic synchronises topic/purpose updates from other bridges # Supported from the following bridges: slack SyncTopic=false ```