IRCBridgeModule

From OpenSimulator

(Difference between revisions)
Jump to: navigation, search
(adding explanation for traditional mode)
(changing to table, starting multi-channel mode description)
Line 14: Line 14:
 
* in ''object chat relay mode'' where we only relay chat to and from private in-world channels
 
* 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).
 
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).
Line 52: Line 52:
 
let’s go through the list of configuration options:
 
let’s go through the list of configuration options:
  
−
; enabled  
+
{| class=”wikitable”
−
: you need to set this to “true” otherwise <code>IRCBridgeModule</code> will not be enabled
+
|-
 +
! configuration variable
 +
! explanation
 +
|-
 +
| enabled  
 +
| you need to set this to “true” otherwise <code>IRCBridgeModule</code> will not be enabled
 +
|-
 +
| server
 +
| the hostname of the IRC server that you intend to use
 +
|-
 +
| nick
 +
| the nickname which <code>IRCBridge</code> 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 <code>IRCBridge</code> 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 <code>IRCBridge</code> to use for relaying in-world messages to the IRC channel.
 +
|-
 +
| commands_enabled
 +
| leave as is for traditional mode
 +
|-
 +
| command_channel
 +
| leave as is for traditional mode
 +
|-
 +
| relay_private_channels
 +
| leave as is for traditional mode
 +
|-
 +
| relay_private_channel_in
 +
| leave as is for traditional mode
 +
|-
 +
| relay_private_channel_out
 +
| leave as is for traditional mode
 +
|-
 +
| access_password
 +
| leave as is for traditional mode
 +
|-
 +
|}
  
−
; server
 
−
: the hostname of the IRC server that you intend to use
 
  
−
; nick
+
=== Multi-channel mode ===
−
: the nickname which <code>IRCBridge</code> will use to connect to the IRC server
+
  
−
; channel
+
with multi-channel mode we can configure <code>IRCBridge</code> to
−
: the IRC channel to connect to
+
relay chat  from different regions into '''different IRC channels''' — or
 +
even into '''different IRC channels on different IRC servers'''!
  
−
; port
+
the following <code>OpenSim.ini</code> configuration file extract
−
: the port on the IRC server to conect to; this is usually port 6667
+
configures <code>IRCBridge</code> to relay  chat from region A into
 +
IRC channel <code>#opensin-A-opensim.server.net</code>
  
−
; relay_chat
+
<pre>
−
: for traditional mode you need to set this to “true” to relay normal in-world chat
+
channel = "#opensin-[%region]-[%host]"
−
 
+
</pre>
−
; report_clients
+
−
: if you set this to “true” then <code>IRCBridge</code> 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 <code>IRCBridge</code> to use for relaying in-world messages to the IRC channel.
+
  
−
; commands_enabled
+
let’s take a closer look at what’s going on here:
−
; command_channel
+
<code>IRCBridge</code> allows us to apply run-time variable
−
; relay_private_channels
+
substitution (a quite powerful mechanism).
−
; relay_private_channel_in
+
−
; relay_private_channel_out
+
−
; access_password
+
−
: leave as shown in the example for traditional mode
+

Revision as of 01:28, 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:

configuration variable explanation
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 leave as is for traditional mode
command_channel leave as is for traditional mode
relay_private_channels leave as is for traditional mode
relay_private_channel_in leave as is for traditional mode
relay_private_channel_out leave as is for traditional mode
access_password leave as is for traditional mode


Multi-channel mode

with multi-channel mode we can configure IRCBridge to relay chat from different regions into different IRC channels — or even into different IRC channels on different IRC servers!

the following OpenSim.ini configuration file extract configures IRCBridge to relay chat from region A into IRC channel #opensin-A-opensim.server.net 

channel = "#opensin-[%region]-[%host]"

let’s take a closer look at what’s going on here: IRCBridge allows us to apply run-time variable substitution (a quite powerful mechanism).

Retrieved from "http://opensimulator.org/index.php?title=IRCBridgeModule&oldid=8097"
Personal tools
General
About This Wiki