Aurora-Sim/OptionalModules
De DigiWiki.
Optional Modules
These are optional modules that you can add into Aurora and use them in your distribution. To use these modules, do the following:
1.) Copy the folder in its entirety that you wish to use into the Aurora/addon-modules/ folder.
2.) Run prebuild on your system in the Aurora/ folder.
3.) Compile, and the module will be ready to be used!
Aurora-WebUI
As this has two configuration files Aurora-WebUI/Quickmap this is on a seperate page Aurora-WebUI
Whisper Voice Module
*** THIS ARTICLE IS ABOUT THIRD PARTY SOFTWARE *** Although Aurora Team encourages the development of third party software for Aurora-Sim, no support can be provided on this. For help with this software, contact the developer of this software directly. Please do not contact the Aurora Team with questions about this software.
Introduction
Whisper is a Mumble based implementation of a voice system for virtual worlds based on OpenSim/Aurora-Sim. The server consists of an OpenSim/Aurora-Sim region module and Murmur, the Mumble voice server. The region module is named Whisper Server and communicates with Murmur in order to open channels and to register users.
The viewer communicates with SLVoice exchanging voice related information like login data and speaker indication status. The whisper client is the proper voice client and replaces SLVoice.
Both Whisper Server and Murmur Client are a fork of vComm Solutions of Switzerland release for Whisper [1]
Getting and Installing Mumble and Murmur
Windows
Just head to SourceForge downloads page[2], get the Windows executable and run it. Follow the installer instructions and you are done. The installer includes both the client and the server.
Linux
Ubuntu carries whatever Mumble version was current at the time of the release in the universe repository. There's also a maintain of PPA that has the latest version for recent Ubuntu versions :
sudo add-apt-repository ppa:slicer sudo apt-get update sudo apt-get install mumble
or
sudo apt-get install mumble-server sudo dpkg-reconfigure mumble-server
Whisper Murmur Configuration
The Murmur Voice module is currently tested with
• murmur 1.2.1
• Aurora-Sim 0.3.1 weekly release
1. Edit murmur.ini:
database=<sqlight-file> dbus=session ice="tcp -h 127.0.0.1 -p 6502" logfile=<log-file> pidfile=<murmur-pid-file> port=64737 <sqlight-file> The location can be freely defined. It will be created automatically
2. Start murmur:
# ./murmur.x86 -ini ./murmur.ini
Murmur will automatically start as daemon. 3. In order to shutdown glacier, it is necessary to use the kill command. The best is to use it in
combination with a pid file. For example:
kill `cat <murmur-pid-file>`
4. ZeroC-Ice
1. Install the package ice33-services (Ubuntu).
2. If the files Ice.dll and Glacier2.dll are not in the path, they must be copied to Aurora-Sim/bin.
5. Glacier2
THE CURRENT VERSION 0.1.0 OF THE MURMUR VOICE MODULE DOES NOT YET SUPPORT GLACIER2.
Glacier2 is a Ice routing and firewall utility, and allows you to securely run the server on one
machine and murmur on another. Note that if both server and client are on a secure LAN, you can
just use iptables to protect the Ice port, which is a lot easier than setting up Glacier2.
Aurora-Sim Configuration
- copy the contents of the 'addon-modules' and 'bin' folders into the 'addon-modules' and 'bin' folders respectively in the Aurora source.
- Run prebuild and compile, and it will be built.
If you would like to set up voice for the entire grid, select the includes and uncomment this line in bin/AuroraServer.ini :
Include-Murmur = AuroraServerConfiguration/Murmur.ini
then edit the bin/AuroraServerConfiguration/Murmur.ini and set the configs up appropriately.
- In the Configuration/Modules/Voice.ini, select Murmur voice and set the configs up appropriately, as follows :
Module = MurmurVoice;
[GenericVoice]
;; This needs to be disabled if another voice module is being used!
Enabled = false
Set also the IPs appropriately to your Murmur server and your region.
If the grid you are on doesn't provide a grid-wide voice service, edit the bin/Configuration/Modules/Voice.ini and set the configs up appropriately for your region.
Imprudence Viewer Configuration
The Whisper solution from vComm was the idea of Volker Gaessler, founder of vComm, and works by replacing the SLVoice executable with a Mumble client that looks exactly the same to the viewer process. This new SLVoice executable then communicates with the instance of Murmur associated with the Aurora-Sim region.
If you need to use the same viewer with Second Life or with an Aurora-Sim region that requires the original SLVoice, a script is provided to switch the old executable back. Management of the voice server is via the Aurora-Sim region module that handles registering voice parcels and users, communicating with Murmur via the ICE remote procedure call mechanism. The installer copies the binaries to the application directory of the viewer and replaces SLVoice.exe with mumble.exe. However the original exe is saved. It is possible to switch between Vivox and Mumble excuting the scripts use_sl_voice.bat and use_whisper_voice.bat. Download the binaries for Windows here [3]
NOTE : if you are a Windows Vista user, be sure to run the SLVoice.exe with admin rights.
Aurora.Protection
This module allows for you to ban users from your grid easily and have auto detection of other accounts that the user is trying to log on with as well.
--- Set up ---
Add the Aurora.Protection.dll file into the bin directory. Add the Aurora.Protection.ini into
-- if you are running standalone Configuration/Modules/ -- if you are running in grid mode AuroraServerConfiguration/ and add the following line to AuroraServer.ini include-auroraprotection = AuroraServerConfiguration/Aurora.Protection.ini
Configure the settings as you want them to be, and restart. It will then be working and ready to go.
-- Use ---
There are two console commands with this module,
UserInfo <UUID> OR UserInfo <First> <Last>
This command shows info about the given user, such as the flags they have.
SetUserInfo <UUID> <Flags> OR SetUserInfo <First> <Last> <Flags>
This commands sets the given flags for a user. If you wish to ban a user, set their Flags to Known and it will ban their account and any other alternates after the next similarity check. If you wish to unban a user, set their Flags to Clean. The flags that are able to be set are "Clean", "Suspected", and "Known".
Concierge
The ConciergeModule is an optional region module that tries to provide "concierge services" for online meetings and events.
Current functionality
it currently:
- keeps an attendee list of avatars in a concierged region
- announces to every avatar in a concierged region when a new avatar enters the region or someone leaves the region
- can post the attendee list to an outside broker whenever the attendee list changes
- can send a welcome message to each avatar entering the region
The ConciergeModule can in addition replace Aurora-Sim's normal Chat module and "amplify" speech in a concierged region so that it is "audible" region-wide (whispering will still be range limited).
To use these module, do the following:
1.) Copy the folder in its entirety into the Aurora/addon-modules/ folder.
2.) Run prebuild on your system in the Aurora/ folder.
3.) Add the Congierge.ini into the bin/Configuration/modules folder and edit it appropriately.
3.) Compile, and the module will be ready to be used!
Datasnapshots
The DataSnapshot module is a Region Module that takes data from various parts of the Aurora-Sim Scene and spits out a custom-format XML file. From this you can have web services mashup with the output data. Consider it analogous to a "Search API", although it's not limited to simple Search.
NOTE : you don't need to install this module if you are using the default Aurora-Sim Search Engine. This module is pretty intended to be used with Robust-based grids and OpenSim Search. See more at OpenSimulator.org [4]
Default Assets
These .iar is a collection of many assets, textures, sounds, and more that are to be used in the Default Inventory. This collection is only for use in Standalone mode or with Aurora.Server (not for users connected to a grid with regions).
To use this collection, drop the .iar files in bin/DefaultInventory/ and then restart Aurora and it will load.
NOTE: If you have another .iar in this folder, it is HIGHLY recommended that you remove it, and then run this console command in Aurora.Server, before putting the new .iar in
clear default inventory
This avoids issues with duplicate Default Inventory and assets.
Default Inventory to IAR converter
This module converts the old style asset and inventory .xml files to IARs so they can be used with the new IAR loaders in Aurora master. To run this tool, do the following.
1.) Compile this module into Aurora by dropping it into the addon-modules directory and running prebuild and then compiling.
2.) Copy over the .ini file included in this directory into the Configuration/Modules/ directory in the bin folder.
3.) Start OpenSim.exe and it will create an IAR of the default assets and inventory.
Default XML Inventory Asset Loader
TODO
Freeswitch Voice Module
*** THIS ARTICLE IS ABOUT THIRD PARTY SOFTWARE *** Although Aurora Team encourages the development of third party software for Aurora-Sim, no support can be provided on this. For help with this software, contact the developer of this software directly. Please do not contact the Aurora Team with questions about this software.
The FreeSWITCH module enables voice in Aurora-Sim with no changes required to the viewer. For Aurora-Sim 0.2 and later 2.x viewers will also work.
FreeSwitch Install
Follow the compilation instructions in the FreeSWITCH wiki. For Aurora-Sim's purposes, we need to enable two specific modules. Make sure to install the hold music if you are not going to disable it in the "configure conference.conf.xml" section below. When you get to the part in the instructions where it says "Edit modules.conf so that it will build the modules you desire." edit the modules.conf file and uncomment to make active the entries for xml_curl and the siren14 codec
codecs/mod_siren and xml_int/mod_xml_curl
FreeSwitch Config
enable mod_xml_curl
Once you've compiled and installed Freeswitch, you will need to activate mod_siren and mod_xml_curl in /usr/local/freeswitch/conf/autoload_configs/modules.conf.xml, since it's disabled by default on a fresh install. uncomment the lines...
<load module="mod_xml_curl"/>
and
<load module="mod_siren"/>
configure mod_xml_curl
mod_xml_curl is a freeswitch module which enables dynamic configuration of freeswitch from a web server. In this case, it is the Aurora-Sim region server. The xml_curl module configuration should point to an Aurora-Sim region that has the Freeswitch voice module enabled (voice also needs to be enabled in the estate setting for all regions you wish to be supported). You can set this up by editing /usr/local/freeswitch/conf/autoload_configs/xml_curl.conf.xml The example below uses the Aurora-Sim region server and port (default 9000) for standalones. It also uses an URL path of "/api" which is correct for both standalones and grids.
<configuration name="xml_curl.conf" description="cURL XML Gateway"> <bindings> <binding name="example"> <param name="gateway-url" value="http://yourauroraregionip:9000/api/freeswitch-config" bindings="directory"/> <param name="gateway-credentials" value="freeswitch:password"/> <param name="disable-100-continue" value="true"/> </binding> <binding name="local"> <param name="gateway-url" value="http://yourauroraregionip:9000/api/freeswitch-config" bindings="dialplan"/> <param name="gateway-credentials" value="freeswitch:password"/> <param name="disable-100-continue" value="true"/> </binding> </bindings> </configuration>
For current Aurora-Sim 0.3.1 master use "/fsapi" and the appropriate server and port - your standalone server IP and default port 9000 for standalones and your Aurora.Server service IP and default port 8004 for grids.
<configuration name="xml_curl.conf" description="cURL XML Gateway"> <bindings> <binding name="example"> <param name="gateway-url" value="http://yourauroraserverip:8004/fsapi/freeswitch-config" bindings="directory"/> <param name="gateway-credentials" value="freeswitch:password"/> <param name="disable-100-continue" value="true"/> </binding> <binding name="local"> <param name="gateway-url" value="http://yourauroraserverip:8004/fsapi/freeswitch-config" bindings="dialplan"/> <param name="gateway-credentials" value="freeswitch:password"/> <param name="disable-100-continue" value="true"/> </binding> </bindings> </configuration>
This configuration instructs freeswitch to obtain the "dialplan" and "directory" configuration from Aurora-Sim (as mentioned by the bindings attributes). For the rest of the configuration, freeswitch will consult its static xml files.
configure vars.xml
The /usr/local/freeswitch/conf/vars.xml requires modification to enable the siren14 codec search within vars.xml for the global_codec_prefs and change the line to read
<X-PRE-PROCESS cmd="set" data="global_codec_prefs=G7221@32000h,G722,PCMU,PCMA,GSM"/>
or
<X-PRE-PROCESS cmd="set" data="global_codec_prefs=G7221@32000h,G7221@16000h,G722,PCMU,PCMA,GSM"/>
G7221@32000h is the siren14 codec configure conference.conf.xml By default, FreeSwitch plays hold music when there is only one avatar in the conference and beeps for everyone when avatars arrive and leave. To disable, edit /usr/local/freeswitch/conf/autoload_configs/conference.conf.xml. Locate the "default" profile and comment out the following lines as shown below:
[...]
<!-- File to play if you are alone in the conference -->
<!-- <param name="alone-sound" value="conference/conf-alone.wav"/> -->
[...]
<!-- File to play when you're alone (music on hold)-->
<!-- <param name="moh-sound" value="$${hold_music}"/> -->
<!-- File to play when you join the conference -->
<!-- <param name="enter-sound" value="tone_stream://%(200,0,500,600,700)"/> [^] -->
<!-- File to play when you leave the conference -->
<!-- <param name="exit-sound" value="tone_stream://%(500,0,300,200,100,50,25)"/> [^] -->
<!-- File to play when you ae ejected from the conference -->
<!-- <param name="kicked-sound" value="conference/conf-kicked.wav"/> -->
[...]
Aurora-Sim Config
Standalone
The configuration is explained in bin/Configuration/Modules/VoiceModules.ini.example. Here's one example [FreeSwitchVoice]
[Voice] Module = FreeSwitchVoice [GenericVoice] ;; This needs to be disabled if another voice module is being used! Enabled = false [FreeswitchService] ;; !!!!!!!!!!!!!!!!!!!!!!!!!!! ;; !!!!!!STANDALONE MODE ONLY!!!!!! ;; !!!!!!!!!!!!!!!!!!!!!!!!!!! ;; IP of your FS server ServerAddress = 192.168.1.2 ;; All other options are - well - optional ; Realm = "127.0.0.1" ; SIPProxy = "127.0.0.1:5060" ; EchoServer = "127.0.0.1" ; EchoPort = 50505 ; AttemptSTUN = "false" ; DefaultTimeout = 5000 ; Context = "default" ; UserName = "freeswitch" ; Password = "password"
In this case, the FreeSWITCH server is running on 192.168.1.2. No other files need to be configured.
Grid Mode
In grid mode, [FreeSwitchVoice] in bin/Configuration/Modules/VoiceModules.ini, [VoiceIncludes] in bin/AuroraServer.ini and [FreeswitchService] in AuroraServerConfiguration/Freeswitch.ini need to be configured. Configurations details are shown in ini files. Here are some example configurations:
- bin/Configuration/Modules/VoiceModules.ini
[FreeSwitchVoice] Enabled = true LocalServiceModule = OpenSim.Services.Connectors.dll:RemoteFreeswitchConnector FreeswitchServiceURL = http://192.168.1.3:8004/fsapi
- Add for bin/AuroraServer.ini
[VoiceIncludes] ;; If you would like to set up voice for the entire grid, select one of these includes depending on which voice module you wish to set up ;Include-Murmur = AuroraServerConfiguration/Murmur.ini Include-FreeSwitch = AuroraServerConfiguration/FreeSwitch.ini
Add for AuroraServerConfiguration/Freeswitch.ini [FreeswitchService]
[FreeswitchService] LocalServiceModule = OpenSim.Services.FreeswitchService.dll:FreeswitchService ServerAddress = http://192.168.1.4
In this case, the grid service is running on 192.168.1.3 and the FreeSWITCH server is running on 192.168.1.4.
Firewall Config
Basically open ports 1720 and 5060, and maybe 50505 must be open for listening.
IAR Modifier GUI
TODO
IRC Chat
IRCBridgeModule allows you to relay chat from your Aurora-Sim 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 In addition, we can send commands to IRCBridge from in-world objects to re-configure IRCBridge 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 Aurora-Sim 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 bin/Configuration/Modules/IRC.ini file (modifying as necessary, of course):
;; Uncomment the following for IRC bridge
;; experimental, so if it breaks... keep both parts... yada yada
;; also, not good error detection when it fails
;[IRC]
;enabled = true ; you need to set this otherwise it won't connect
;server = name.of.irc.server.on.the.net
;; user password - only use this if the server requires one
;password = mypass
;nick = OpenSimBotNameProbablyMakeThisShorter
;channel = #the_irc_channel_you_want_to_connect_to
;user = USER OpenSimBot 8 * :I'm an OpenSim to IRC bot
;port = 6667
;; channel to listen for configuration commands
;commands_enabled = false
;command_channel = 2777
;report_clients = true
;; relay private chat connections
;; relay_private_channels = true: will relay IRC chat from/to private in-world channels
;; relay_private_channel_out -- channel to send messages out to the IRC bridge
;; relay_private_channel_in -- channel to receive message from the IRC bridge
;; relay_chat = false: IRC bridge will not relay normal chat
;; access_password -- simple security device
;;
;; so, to just relay chat from an IRC channel to in-world region and vice versa:
;;
;; relay_private_channels = false
;; relay_chat = true
;;
;; to relay chat only to/from private in-world channels:
;;
;; relay_chat = false
;; relay_private_channels = true
;; relay_private_channel_in = 2226
;; relay_private_channel_out = 2225
;;
;; in this example, all chat coming in from IRC will be send out via
;; in-world channel 2226, and all chat from in-world channel 2225 will
;; be relayed to the IRC channel.
;;
;relay_private_channels = false
;relay_private_channel_in = 2226
;relay_private_channel_out = 2225
;relay_chat = true
;access_password = foobar
;;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} : {3} - {1} of {2}
;;for <bot>:<message> - from <user> :
;;msgformat = PRIVMSG {0} : {3} - from {1}
;; exclude_list allows you to stop the IRC connector from announcing the
;;arrival and departure of certain users. For example: admins, bots.
;exclude_list=User 1,User 2,User 3
Configuration variable explanation
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 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
NOTE : do not relay your IRCBridge to any of the free IRC servers (such as freenode, etc). Your IP address might be banned from those servers with "flooding" reasons.
OpenSim Profile
Making it possible to have a UserProfile that persists. More docs about OSProfile here [5]
NOTE : you dont need to use this module, unless you are connecting your Aurora-Sim to a Robust-based grid like OSGrid. Pure Aurora-Sim based grids, have Profile working out of the box.
OpenSim Search
Create a scalable, open architecture for searching OpenSim based worlds. More docs about OSSearch here[6]
NOTE : you dont need to use this module, unless you are connecting your Aurora-Sim to a Robust-based grid like OSGrid. Pure Aurora-Sim based grids, have Search working out of the box.
RegAPI
This is the Aurora RegApi module. It implements (part) of the Registration Api. More Info: http://wiki.secondlife.com/wiki/Registration_API http://wiki.secondlife.com/wiki/Registration_API_Reference
To Compile: Copy the RegApi folder into the addon-modules directory and run prebuild and compile.
Standalone Loader
This module allows you to double click on an .abackup file (in Windows) and have it start Aurora and load the region.
How to use it :
1.- Have your Aurora up and running in Standalone mode.
2.- switch to the region you wish to save, using the "change region" command
3.- Type this command on the console :
save archive
4.- By answering to some questions on the console, you will create a .abackup file in your bin folder
5.- Repeat steps 2 and 3 for each Region in your instance
6.- Shutdown Aurora
7.- Double click on the .abackup file you just created and enjoy!
Tree Populator
TODO
User Statistics
Region statistics such as region name, avatar name, avatar position<x,y,z>, number of prims, and a lot of other information can be obtained on a web page by: Adding the Stats.ini to your bin/Configuration/Modules folder
[WebStats]
;; View region statistics via a web page
;; See http://opensimulator.org/wiki/FAQ#Region_Statistics_on_a_Web_Page
;; Use a web browser and type in the Login URI + /SStats/
;; For example- http://127.0.0.1:9000/SStats/
enabled=true
Using a web browser and typing in the "Login URI" + "/SStats/" of your standalone server or your region.
For example- http://127.0.0.1:9000/SStats/
The resulting web page is continually updated using AJAX, so there is no need to refresh the page to obtain current information. One possible use for this web page information would be to see who is logged on to the region in real time - without actually logging in. This web page provides region information similar to the kind generated by using various server console commands to obtain region statistics.
WorldView
TODO
YieldProlog
TODO
Funny Money Module
*** THIS ARTICLE IS ABOUT THIRD PARTY SOFTWARE ***
DTL/NSL Money Module for Aurora-Sim
Please see http://www.nsl.tuis.ac.jp/xoops/modules/xpwiki/?OpenSim%2FMoneyServer
