Bridge

BridgePlugin

About

The BridgePlugin connects two text channels together, either on the same server or across servers. The bridges can be managed in the bridges.json file in your <home>/ComBot/plugins/BridgesPlugin/ folder.

Configuration

The BridgePlugin comes with a few configuration settings:

{
    mentionSender:"false",
    useNickname:"false",
    relayMessage:"Guild: <guild> | <user>:\n\t<message>"
}

mentionSender This can be set to true or false. Setting it to true will add the message sender as a mention in the relayed message (using the @user notation). If set to false the bot will look at useNickname useNickname This can be set to true or false. This option is only looked at when mentionSender is set to false. When set to true, the bot will use the senders nickname (or regular name) on the server they sent the message from as the message sender in the relayed message. Setting it to false will send the message as their discord username and identifier. Ex: xJohhdaniel#4453 relayMessage This should be a string. The format of the String is how the relay message will appear on destination channels. You can use three different options inside this format: <user> The user who sent the message <guild> The guild the message is from <message> The message itself You can include all or none of these in for format.

Bridges

The bridges.json file looks as follows:

{
  bridges:[
    {
      textChannelA:"channelIdA",
      textChannelB:"channelIdB"
    }
  ]
}

This links "channelIdA" and "channelIdB" together. Bridges are two way, but you can set up a system of numerous bridges by adding to the array. If you had four channels you wanted to connect, it would look like this:

{
  bridges:[
    {
      textChannelA:"channelIdA",
      textChannelB:"channelIdB"
    },
    {
      textChannelA:"channelIdA",
      textChannelB:"channelIdC"
    },
    {
      textChannelA:"channelIdA",
      textChannelB:"channelIdD"
    },
    {
      textChannelA:"channelIdB",
      textChannelB:"channelIdC"
    },
    {
      textChannelA:"channelIdB",
      textChannelB:"channelIdD"
    },
    {
      textChannelA:"channelIdC",
      textChannelB:"channelIdD"
    }
  ]
}

This connects A to B, A to C, A to D, B to C, B to D, and C to D. These bridges will share messages between each of the channels.

Notes

• Bot messages are not included in message sharing
• Commands are not included (Bot commands for this bot) in message sharing