SimulatorFeaturesModule

Overview

The SimulatorFeaturesModule provides the mechanism used to inform the viewer about some features or properties of a region, for example BOM support, version of LSL/OSSL syntaxe, etc.
Viewer should ask for this information every time they see a new region. Unfortunately some of this may require that the viewer already created a avatar on that region. This information is send via HTTP with llsd xml encoding. some information specific to opensimulator is sent on a section (llsd map) OpenSimExtras

Configuration

Some parameters are constant and defined in code. Others are defined by specific, some optional, modules in fact, because reasons, this module is also optional.

OpenSim

OpenSimExtras are configured in several places through the code and the best way to track them is to search for modules that watch the OnSimulatorFeaturesRequest event.

For certain features, we support the override of the grid defaults in the SimulatorFeaturesModule, but the defaults should be set at the grid level to ensure that the services required to operate the viewer components will be correct when users login or enter regions via Hypergrid.

[SimulatorFeatures]
 
   ; Override search service url
   SearchServerURI = "url to search service for this Simulator and its region(s)"
 
   ; Override destination guide url
   DestinationGuideURI = "url to destination guide for this Simulator and its region(s)"
 
   ; Override map service url
   ;(this may be set in one of several other locations, but we can use this to be consistent)
   MapTileURL = "url to map service for this Simulator and its region(s)"
 
[Chat]
 
   ; Distance in meters that ordinary chat should travel.  Default is 20m
   say_distance = 20
   ; Controls whether the chat module is enabled.  Default is true.
   enabled = true;
   ; Distance in meters that whispers should travel.  Default is 10m
   whisper_distance = 10
   ; Distance in meters that shouts should travel.  Default is 100m
   shout_distance = 100

Extra information sent to the viewer over the SimulatorFeatures capability

The OpenSimulator specific proportion of this is as follows (TODO: Need to document the surrounding SimulatorFeatures structure as well!).

 OpenSimExtras (OSDMap)
   map-server-url (string)
   search-server-url (string)
   destination-guide-url (string)
   ExportSupported (Boolean)
   GridName (string) - name of this simulator's grid (can change if travelling via Hypergrid).  OpenSimulator 0.8.1 onwards.
   GridURL (string) - login URL of this simulator's grid (can change if travelling via Hypergrid).  OpenSimulator 0.8.1 onwards.
   say-range (integer)
   whisper-range (integer)
   shout-range (integer)

Any of these is optional -- it may or may not be sent by the simulators. The entire map OpenSimExtras may or may not be present.

Portions of this are available in OpenSimulator 0.7.6 onward. Grid support is only available from r/25093 (4-Aug-2014 as dev-master hash/commit time 10a8d28_1407360312) onward.