LightShare

From OpenSimulator

(Difference between revisions)
Jump to: navigation, search
 
(55 intermediate revisions by 11 users not shown)
Line 1: Line 1:
−
Information and links relating to Windlight and LightShare use in OpenSimulator.
+
{{Quicklinks}}
 +
= LightShare =
 +
The LightShare module allows region owners to get and set Windlight fixed sky 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. Lightshare is the OPENSIM term for SL's Windlight.
  
−
The LightShare module to use Windlight settings on specific regions and to make them available to capable viewers was initially created by Meta7...
+
== LightShare in OpenSimulator 0.9.2.0 ==
 +
LightShare and Windlight where removed in version 0.9.2, so most information on this page is no longer valid.
 +
However, LightShare scripting functions can still be used, they will be translated to and from the new environment for the region.
  
−
* https://www.meta7.com/wiki.php?page=LightShare
+
To use those functions you need to have
  
−
The features can be used through three LightShare (ls) functions:
+
AllowLightShareFunctions = true
  
−
* lsGetWindlightScene
+
in section [OSSL] of file osslEnable.ini
−
* lsSetWindlightScene
+
−
* lsSetWindlightSceneTargeted
+
  
−
Default settings are shown being set in this sample script:
+
Then three LightShare (ls) functions are available:  
  
−
* https://www.meta7.com/wiki.php?page=Default%20LightShare%20Script
+
* [[lsGetWindlightScene]]
 +
* [[lsSetWindlightScene]]
 +
* [[lsClearWindlightScene]]
  
−
Note that although the core functionality is available within OpenSim 0.7 onwards.  A database table "regionwindlight" is used to store the settings.
+
see also
  
−
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).
+
* [[LightShare Parameters]]
  
 +
Note that this parameters will now be translated to ot from the new environment settings, So results may vary..
 +
 +
Following information only applies to older versions of OpenSimulator and viewers
 +
 +
== Enabling LightShare in OpenSimulator older versions ==
 +
LightShare core functionality is available within OpenSimulator 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]
 
   [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.
−
  ; It has no ill effect on viewers which do not support server-side windlight settings.
+
 ; It has no ill effect on viewers which do not support server-side windlight settings.
−
  ; 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]
−
  ; Enable the use of these functions, e.g. for a nominated avatar
+
 ; Allow the user of LightShare functions
−
  Allow_lsGetWindlightScene = UUID
+
AllowLightShareFunctions = true
−
  Allow_lsSetWindlightScene = UUID
+
−
  Allow_lsSetWindlightSceneTargeted = UUID
+
  
−
== LighShare Enabled Viewers ==
+
Note: You can use Lightshare/Windlight scripts in your Regions but permanently saving those Lightshare/Windlight
 +
settings is not supported while using Sqlite Databases. When you restart the Region the settings are gone.
  
−
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:
+
== 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.
 +
 +
=== Firestorm Viewer ===
 +
Lightshare is supported and enabled by default in Firestorm.
 +
 +
To disabled it, open Preferences, select the Opensim tab, then the miscellaneous tab, and you will see the checkbox "Enable region Lightshare settings."
 +
 +
Firestorm supports the full range of both Lightshare and Region Windlight features as of version 4.4.0.
 +
 +
Website: [http://www.firestormviewer.org/]
 +
 +
Download: [http://wiki.phoenixviewer.com/downloads#current_release_-_opensim_build]
 +
 +
=== 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
 +
 +
Tested with Imprudence 1.4.0 beta 2 (tested January 2013). As mentioned above you have to enable some settings for full Windlight / Lightshare effects.
 +
 +
You find screenshots and a brief description what those settings do via this link [http://myosgrid.wordpress.com/2013/01/17/windlight-lightshare-on-opensim-worlds/]
 +
 +
=== 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
 +
 +
Additional Note January 2013: The META 7 pages are offline. There is also no Reference or cached pages on the Waybackmachine [http://web.archive.org/liveweb/https://www.meta7.com/wiki.php?page=LightShare%20Parametershttp://meta7.com/]
 +
 +
=== Singularity ===
 +
 +
Singularity is a SL/Metaverse viewer, supporting many OpenSim-specific features, as well as Windlight/LightShare. It has full support for the OPENSIM Windlight script parameters. If you are into Windlight use this Viewer.
 +
 +
Website: http://www.singularityviewer.org/
 +
 +
Download: http://www.singularityviewer.org/downloads
 +
 +
=== TeaPot Viewer ===
 +
 +
Armin Weatherwax Teapot Viewer also supports Windlight. BUT, it DOES NOT pick up the OPENSIM Windlight parameters from scripts.
 +
 +
You can edit Windlight settings in the viewer and save them to a notecard. You can give those Notecards to other user. The Notecards looks like a XML structure. You can also save windlight settings to your Harddisk and share those seetings e.g. by email or via a Website. The path for those windlight files on your Harddisk is YOURDRIVELETTER:\Program Files (x86)\Teapot\app_settings\windlight (on Windows)
 +
 +
 +
Website:  https://bitbucket.org/ArminW
 +
 +
Download: https://bitbucket.org/ArminW/teapot/downloads
 +
 +
=== Other V3 Viewers (Kokua Viewer, Phoenix Viewer) ===
 +
 +
Most V3 Viewers do not, as of May 2013, support Lightshare. BUT they do support WINDLIGHT (e.g Windlight settings in SL) and work like described in the Teapot Viewer section above.
 +
 +
Kokua Viewer (Download page here [https://bitbucket.org/kokua/kokua-beta])
 +
 +
== LightShare Scripting ==
 +
The features can be used through three LightShare (ls) functions:
 +
 +
* [[lsGetWindlightScene]]
 +
* [[lsSetWindlightScene]]
 +
* [[lsSetWindlightSceneTargeted]]
 +
* [[lsClearWindlightScene]]
 +
* [[LightShare Parameters]]
 +
 +
See also the [[DefaultLightShareScript]] to get a starter script.
 +
 +
* [[User:Thomax|txOh]] has created an in-world LightShare controller, which allows you to easily set custom LightShare settings. An [[Inventory Archives|IAR]] with the controller can be downloaded from http://www.gridhop.net/IAR/lightshare.iar
 +
 +
See [[Inventory Archives]] for an explanation of how to add the contents of the IAR file to your inventory.
 +
 +
== LightShare Issues ==
 +
* http://opensimulator.org/mantis/search.php?project_id=1&search=LightShare&hide_status_id=-2
 +
 +
== See Also ==
 +
* RestrainedLove API [http://wiki.secondlife.com/wiki/LSL_Protocol/RestrainedLoveAPI] @setenv and @getenv commands
 +
* Phoenix Viewer ParcelWL [http://wiki.phoenixviewer.com/doku.php?id=parcelwl]
 +
 +
== Credits ==
 +
LightShare was initially created by Meta7.
 +
 +
Since January 2013: The META 7 pages, with the original information, are offline
 +
 +
[[Category:Scripting]]
 +
[[Category:OSSL]]

Latest revision as of 13:20, 4 March 2024

Languages Languages: 

En.png English   De.png Deutsch   Fr.png Français

Contents

[edit] LightShare

The LightShare module allows region owners to get and set Windlight fixed sky 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. Lightshare is the OPENSIM term for SL's Windlight.

[edit] LightShare in OpenSimulator 0.9.2.0

LightShare and Windlight where removed in version 0.9.2, so most information on this page is no longer valid. However, LightShare scripting functions can still be used, they will be translated to and from the new environment for the region.

To use those functions you need to have 

AllowLightShareFunctions = true

in section [OSSL] of file osslEnable.ini

Then three LightShare (ls) functions are available:

see also

Note that this parameters will now be translated to ot from the new environment settings, So results may vary..

Following information only applies to older versions of OpenSimulator and viewers

[edit] Enabling LightShare in OpenSimulator older versions

LightShare core functionality is available within OpenSimulator 0.7 onwards.

[edit] The regionwindlight Database Table

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

[edit] 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

Note: You can use Lightshare/Windlight scripts in your Regions but permanently saving those Lightshare/Windlight settings is not supported while using Sqlite Databases. When you restart the Region the settings are gone.

[edit] 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.

[edit] Firestorm Viewer

Lightshare is supported and enabled by default in Firestorm.

To disabled it, open Preferences, select the Opensim tab, then the miscellaneous tab, and you will see the checkbox "Enable region Lightshare settings."

Firestorm supports the full range of both Lightshare and Region Windlight features as of version 4.4.0.

Website: [1]

Download: [2]

[edit] 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:

Tested with Imprudence 1.4.0 beta 2 (tested January 2013). As mentioned above you have to enable some settings for full Windlight / Lightshare effects.

You find screenshots and a brief description what those settings do via this link [3]

[edit] 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. !!!

Additional Note January 2013: The META 7 pages are offline. There is also no Reference or cached pages on the Waybackmachine [4]

[edit] Singularity

Singularity is a SL/Metaverse viewer, supporting many OpenSim-specific features, as well as Windlight/LightShare. It has full support for the OPENSIM Windlight script parameters. If you are into Windlight use this Viewer.

Website: http://www.singularityviewer.org/

Download: http://www.singularityviewer.org/downloads

[edit] TeaPot Viewer

Armin Weatherwax Teapot Viewer also supports Windlight. BUT, it DOES NOT pick up the OPENSIM Windlight parameters from scripts.

You can edit Windlight settings in the viewer and save them to a notecard. You can give those Notecards to other user. The Notecards looks like a XML structure. You can also save windlight settings to your Harddisk and share those seetings e.g. by email or via a Website. The path for those windlight files on your Harddisk is YOURDRIVELETTER:\Program Files (x86)\Teapot\app_settings\windlight (on Windows)


Website: https://bitbucket.org/ArminW

Download: https://bitbucket.org/ArminW/teapot/downloads

[edit] Other V3 Viewers (Kokua Viewer, Phoenix Viewer)

Most V3 Viewers do not, as of May 2013, support Lightshare. BUT they do support WINDLIGHT (e.g Windlight settings in SL) and work like described in the Teapot Viewer section above.

Kokua Viewer (Download page here [5])

[edit] LightShare Scripting

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

See also the DefaultLightShareScript to get a starter script.

See Inventory Archives for an explanation of how to add the contents of the IAR file to your inventory.

[edit] LightShare Issues

[edit] See Also

  • RestrainedLove API [6] @setenv and @getenv commands
  • Phoenix Viewer ParcelWL [7]

[edit] Credits

LightShare was initially created by Meta7.

Since January 2013: The META 7 pages, with the original information, are offline

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