LightShare

From OpenSimulator

(Difference between revisions)
Jump to: navigation, search
(Added a few more links to help people figure out how LightShare works; Meta7's page is outdated for 0.7)
(Fixed a bit of typo and linked the ls* calls, reformatted and wordsmithed entire page and outline)
Line 1: Line 1:
−
Information and links relating to Windlight and LightShare use in OpenSimulator.  
+
= LightShare =
 +
The LightShare module allows region owners to get and set [[Windlight]] settings for their specific regions using in-world scripts, and for those regions to send those settings down to all, or specific, LightShare-aware viewers who visit the LightShare configured regions.
  
−
The LightShare module to use Windlight settings on specific regions and to make them available to capable viewers was initially created by Meta7...  
+
== Enabling LightShare in OpenSimulator ==
 +
LightShare core functionality is available within OpenSim 0.7 onwards.
  
−
*https://www.meta7.com/wiki.php?page=LightShare
+
=== The regionwindlight Database Table ===
 +
A database table "[[Regionwindlight|regionwindlight]]" is used to store the settings.
  
−
The features can be used through three LightShare (ls) functions:
+
=== OpenSim.ini Settings ===
−
 
+
LightShare is enabled by changing [[OpenSim.ini]] for the [[OpenSim.exe]] serving the regions you wish to use LightShare in:
−
*lsGetWindlightScene
+
* setting '''enable_windlight = true ''' in the [LightShare] section of OpenSim.ini
−
*lsSetWindlightScene
+
* setting '''AllowLightShareFunctions = true''' in the [XEngine] section of OpenSim.ini
−
*lsSetWindlightSceneTargeted
+
These changes affect all regions served by the specific OpenSim.exe which load this ini file.
−
 
+
−
Default settings are shown being set in this sample script:
+
−
 
+
−
*https://www.meta7.com/wiki.php?page=Default%20LightShare%20Script (requires manual changing from '''cmSetWindlightScene''' to '''lsSetWindlightScene'''; see also [[DefaultLightShareScript|an alternative page on this wiki]] to get a correctly working script)
+
−
 
+
−
Note that although the core functionality is available within OpenSim 0.7 onwards. A database table "[[Regionwindlight|regionwindlight]]" is used to store the settings.
+
−
 
+
−
LightShare is enabled by setting the [LightShare] section of OpenSim.ini for the OpenSim.exe serving the regions you wish to enable using using '''enable_windlight = true''' (rather than the default of false), and indicating in the [XEngine] section that you wish to allow the use of LightShare functions with '''AllowLightShareFunctions = true'''. This affects all regions served by the specific OpenSim.exe for which this is done.  
+
  
 +
Exmaple '''OpenSim.ini''' changes:
 
   [LightShare]
 
   [LightShare]
 
   ; This enables the transmission of Windlight scenes to supporting clients, such as the Meta7 viewer.
 
   ; This enables the transmission of Windlight scenes to supporting clients, such as the Meta7 viewer.
Line 24: Line 20:
 
   ; Currently we only have support for MySQL databases.
 
   ; Currently we only have support for MySQL databases.
 
  enable_windlight = true
 
  enable_windlight = true
−
...
+
and
 
  [XEngine]
 
  [XEngine]
 
   ; Allow the user of LightShare functions
 
   ; Allow the user of LightShare functions
 
  AllowLightShareFunctions = true
 
  AllowLightShareFunctions = true
  
−
== LighShare Enabled Viewers  ==
+
== LightShare-Enabled Viewers  ==
  
−
A special viewer is needed to receive Windlight settings broadcast by a region through the LightShare mechanism. E.g, Imprudence. LightShare support is disabled by default in Imprudence. To enable it, open the "Preferences > Advanced" tab, and change the "Allow region Windlight settings (LightShare)" option. More details of the options are at:
+
Updated virtual world viewers are needed to receive Windlight settings sent by a region through LightShare.
  
 +
You must also have an updated viewer in order for LightShare scripting functions (see below) to be properly compiled, and show correctly in the script editor.
 +
 +
=== Imprudence Viewer ===
 +
LightShare support is disabled by default in [[Imprudence]].
 +
 +
To enable it, choose the "Edit" menu item, "Preferences" menu option, "Advanced" preferences tab.
 +
 +
Then, change the "Allow region Windlight settings (LightShare)" option.
 +
 +
Imprudence Viewer is available from:
 +
* http://imprudenceviewer.org/
 +
 +
More details of the options are at:
 
*http://imprudenceviewer.org/wiki/LightShare
 
*http://imprudenceviewer.org/wiki/LightShare
 +
 +
=== Meta7 Viewer ===
 +
The Meta7 Viewer is compatible with LightShare regions.
 +
 +
!!! It is unknown if Meta7 can work with the OpenSimulator ls* script functions detailed below. !!!
 +
 +
*http://www.meta7.com/download.php
 +
 +
== LightShare Scripting ==
 +
The features can be used through three LightShare (ls) functions:
 +
 +
*[[lsGetWindlightScene]]
 +
*[[lsSetWindlightScene]]
 +
*[[lsSetWindlightSceneTargeted]]
 +
 +
See [[DefaultLightShareScript]] to get a correctly working starter script.
 +
 +
== Credits ==
 +
LightShare was initially created by [[Meta7]].
 +
 +
The Meta7 LightShare feature documentation can be found here:
 +
*https://www.meta7.com/wiki.php?page=LightShare
 +
 +
Default settings are shown being set in this Meta7 sample script:
 +
*https://www.meta7.com/wiki.php?page=Default%20LightShare%20Script
 +
 +
Using this script on OpenSimulator requires manual changing the '''cmSetWindlightScene''' function name to '''lsSetWindlightScene'''

Revision as of 22:31, 5 November 2010

Contents

LightShare

The LightShare module allows region owners to get and set Windlight settings for their specific regions using in-world scripts, and for those regions to send those settings down to all, or specific, LightShare-aware viewers who visit the LightShare configured regions.

Enabling LightShare in OpenSimulator

LightShare core functionality is available within OpenSim 0.7 onwards.

The regionwindlight Database Table

A database table "regionwindlight" is used to store the settings.

OpenSim.ini Settings

LightShare is enabled by changing OpenSim.ini for the OpenSim.exe serving the regions you wish to use LightShare in:

  • setting enable_windlight = true in the [LightShare] section of OpenSim.ini
  • setting AllowLightShareFunctions = true in the [XEngine] section of OpenSim.ini

These changes affect all regions served by the specific OpenSim.exe which load this ini file.

Exmaple OpenSim.ini changes: 

 [LightShare]
 ; This enables the transmission of Windlight scenes to supporting clients, such as the Meta7 viewer.
 ; It has no ill effect on viewers which do not support server-side windlight settings.
 ; Currently we only have support for MySQL databases.
enable_windlight = true

and 

[XEngine]
 ; Allow the user of LightShare functions
AllowLightShareFunctions = true

LightShare-Enabled Viewers

Updated virtual world viewers are needed to receive Windlight settings sent by a region through LightShare.

You must also have an updated viewer in order for LightShare scripting functions (see below) to be properly compiled, and show correctly in the script editor.

Imprudence Viewer

LightShare support is disabled by default in Imprudence.

To enable it, choose the "Edit" menu item, "Preferences" menu option, "Advanced" preferences tab.

Then, change the "Allow region Windlight settings (LightShare)" option.

Imprudence Viewer is available from:

More details of the options are at:

Meta7 Viewer

The Meta7 Viewer is compatible with LightShare regions.

!!! It is unknown if Meta7 can work with the OpenSimulator ls* script functions detailed below. !!!

LightShare Scripting

The features can be used through three LightShare (ls) functions:

See DefaultLightShareScript to get a correctly working starter script.

Credits

LightShare was initially created by Meta7.

The Meta7 LightShare feature documentation can be found here:

Default settings are shown being set in this Meta7 sample script:

Using this script on OpenSimulator requires manual changing the cmSetWindlightScene function name to lsSetWindlightScene

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