IRCBridgeModule
From OpenSimulator
(Difference between revisions)
DrScofield (Talk | contribs) (adding modes section) |
DrScofield (Talk | contribs) (adding config for traditional mode) |
||
| Line 8: | Line 8: | ||
* ... | * ... | ||
| − | <code>IRCBridge</code> can be used in | + | <code>IRCBridge</code> 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 ''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 ''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 == | == Traditional IRCBridge mode == | ||
| + | |||
| + | in the traditional <code>IRCBridge</code> mode ("traditional" because that was the original <code>IRCBridge</code> ''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 <code>IRCBridge</code> for traditional mode operation use the following configuration section in your <code>OpenSim.ini</code> file (modifying as necessary, of course): | ||
| + | |||
| + | <pre> | ||
| + | [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 | ||
| + | |||
| + | commands_enabled = false | ||
| + | command_channel = 4711 | ||
| + | report_clients = true | ||
| + | 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}" | ||
| + | |||
| + | </pre> | ||
Revision as of 22:40, 3 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
commands_enabled = false
command_channel = 4711
report_clients = true
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}"
