IRCBridgeModule

Revision as of 00:47, 4 November 2008

Configuring IRCBridgeModule

IRCBridgeModule allows you to relay chat from your OpenSim region to an IRC channel and vice versa. You can use this module to

• make in-world chat available via a text-only interface such as IRC
• control objects from IRC channels
• use in-world objects to control bots attached via IRC
• ...

IRCBridge can be used in three modes:

• in traditional mode where we relay all in-world chat from all regions to a single IRC channel on a single server, or
• in multi-channel mode where we can relay in-world chat from a specific region to a specific channel (or even to a specific server)
• in object chat relay mode where we only relay chat to and from private in-world channels

Traditional IRCBridge mode

in the traditional IRCBridge mode ("traditional" because that was the original IRCBridge modus operandi) all in-world avatar chat from all regions is relayed to a specific IRC chat channel on a specific server. chat from an avatar is reported by an OpenSim powered IRC bot in the IRC channel. chat originating on the IRC channel is reported via "voice of god" in all regions (voice of god meaning that the in-world avatars will "hear" the chat but won't be able to see the originator anywhere in the region).

to configure IRCBridge for traditional mode operation use the following configuration section in your OpenSim.ini file (modifying as necessary, of course):

[IRC]
enabled = true ; you need to set this otherwise it won't connect
server  = some.irc.server.net
nick    = OpenSinBot
channel = #opensin
port = 6667
relay_chat = true
report_clients = true

commands_enabled = false
command_channel = 4711
relay_private_channels = false
relay_private_channel_out = 4712
relay_private_channel_in = 4713

access_password = WuffWuff

;fallback_region = name of "default" region
;MSGformat fields : 0=botnick, 1=user, 2=region, 3=message
; must start with "PRIVMSG {0} : " or irc server will get upset
;for <bot>:<user in region> :<message>
msgformat = "PRIVMSG {0} :<{1} in {2}>: {3}"
;for <bot>:<message> - <user of region> :
;msgformat = "PRIVMSG {0} : {1} [{2}]: {3}"
;for <bot>:<message> - from <user> :
;msgformat = "PRIVMSG {0} : {3} - from {1}"

let’s go through the list of configuration options:

enabled

you need to set this to “true” otherwise IRCBridgeModule will not be enabled

server

the hostname of the IRC server that you intend to use

nick

the nickname which IRCBridge will use to connect to the IRC server

channel

the IRC channel to connect to

port

the port on the IRC server to conect to; this is usually port 6667

relay_chat

for traditional mode you need to set this to “true” to relay normal in-world chat

report_clients

if you set this to “true” then IRCBridge will notify the IRC channel whenever an avatar logs on, enters a region, leaves a region, and logs off

msgformat

select whichever message format you want IRCBridge to use for relaying in-world messages to the IRC channel.

commands_enabled

command_channel

relay_private_channels

relay_private_channel_in

relay_private_channel_out

access_password

leave as shown in the example for traditional mode