| Commands for Relay | ||
|---|---|---|
| Command | Args | Detailed Help |
| join | [<channel>] | Starts relaying between the channel <channel> on all networks. If on a network the bot isn't in <channel>, he'll join. This commands is required even if the bot is in the channel on both networks; he won't relay between those channels unless he's told to join both channels. If <channel> is not given, starts relaying on the channel the message was sent in. |
| nicks | [<channel>] | Returns the nicks of the people in the channel on the various networks the bot is connected to. <channel> is only necessary if the message isn't sent on the channel itself. |
| part | <channel> | Ceases relaying between the channel <channel> on all networks. The bot will part from the channel on all networks in which it is on the channel. |
| relay | <command> [<args> ...] | Command dispatcher for the Relay plugin. Use 'list Relay' to see the commands provided by this plugin. Use 'config list plugins.Relay' to see the configuration values for this plugin. In most cases this dispatcher command is unnecessary; in cases where more than one plugin defines a given command, use this command to tell the bot which plugin's command to use. |
Configuration Variables for the Relay plugin
- supybot.plugins.Relay.public
- Default: True
- Channel Specific: False
- Help: Determines whether this plugin is publicly visible.
- supybot.plugins.Relay.color
- Default: False
- Channel Specific: True
- Help: Determines whether the bot will color relayed PRIVMSGs so as to make the messages easier to read.
- supybot.plugins.Relay.topicSync
- Default: True
- Channel Specific: True
- Help: Determines whether the bot will synchronize topics between networks in the channels it relays.
- supybot.plugins.Relay.hostmasks
- Default: False
- Channel Specific: True
- Help: Determines whether the bot will relay the hostmask of the person joining or parting the channel when he or she joins or parts.
- supybot.plugins.Relay.includeNetwork
- Default: True
- Channel Specific: True
- Help: Determines whether the bot will include the network in relayed PRIVMSGs; if you're only relaying between two networks, it's somewhat redundant, and you may wish to save the space.
- supybot.plugins.Relay.punishOtherRelayBots
- Default: False
- Channel Specific: True
- Help: Determines whether the bot will detect other bots relaying and respond by kickbanning them.
- supybot.plugins.Relay.channels
- Default:
- Channel Specific: False
- Help: Determines which channels the bot will relay in.
- .joinOnAllNetworks
- Default: True
- Channel Specific: True
- Help: Determines whether the bot will always join the channel(s) it relays for on all networks the bot is connected to.
- supybot.plugins.Relay.noticeNonPrivmsgs
- Default: False
- Channel Specific: True
- Help: Determines whether the bot will used NOTICEs rather than PRIVMSGs for non-PRIVMSG relay messages (i.e., joins, parts, nicks, quits, modes, etc.)
