Scripting Documentation

From OpenSimulator

(Difference between revisions)
Jump to: navigation, search
(Suggested Links for LSL wikis:)
m (Add Easy Free Database)
(46 intermediate revisions by 5 users not shown)
Line 2: Line 2:
  
 
== About OpenSimulator scripting ==
 
== About OpenSimulator scripting ==
An important ingredient in worlds simulation is scripting.
+
An important ingredient in virtual worlds simulation is scripting.<br>
OpenSimulator script language closely follows Linden Labs Second Life script language (LSL) with extra OSSL and various other functions.
+
Scripts allow the addition of actions to 'entities' in world, like making a door react to a touch and open.<br>
 +
Since version 0.9.1.0, you can chose between old [[XEngine]] or new [[YEngine]] script engines.<br>
 +
Script engines do script compilation and control script execution.<br>
 +
<div style="background-color:#FFA500; padding:10px; padding-bottom:5px; border: 1px #FF544F solid">
 +
A script is not a like a full program, it is a set of blocks of code called when some event happens, like a touch on the door.<br>
 +
Many of those events happen at time critical moments, so those blocks should be small and fast to reduce impact on the rest of simulation.<br>
 +
YEngine may allow long processing to happen with less impact on the simulation, but that will happen at lower priority.
 +
</div><br>
  
[http://wiki.secondlife.com/wiki/LSL_Portal LSL (Linden Scripting Language)]
+
OpenSimulator script language supports a subset of the Linden Labs Second Life script language (LSL) plus its own extensions (OSSL).
 +
 
 +
[http://wiki.secondlife.com/wiki/LSL_Portal LSL (Linden Scripting Language)]<br>
 +
[[OSSL Implemented|OSSL]]<br>
  
 
== Configuring scripting ==
 
== Configuring scripting ==
Line 15: Line 25:
 
If you have never written a script in LSL before, then please have a look at the [http://wiki.secondlife.com/wiki/LSL_Tutorial LSL wiki] to learn the scripting basics.
 
If you have never written a script in LSL before, then please have a look at the [http://wiki.secondlife.com/wiki/LSL_Tutorial LSL wiki] to learn the scripting basics.
 
If you do have (some) experience with writing or editing LSL scripts, then the procedure is identical to the procedure on SL.
 
If you do have (some) experience with writing or editing LSL scripts, then the procedure is identical to the procedure on SL.
<!-- We've shown the reader where and how to learn how to create/edit scripts. We therefore do not need to give them our own tutorial. -->
 
<!--The current procedure to get a script working in OpenSimulator is:
 
* Create a new script in inventory. (Inventory -> Create -> New Script)
 
* Write whatever script you want there, or copy the script contents of another script in the pre-existing OpenSimulator library. Check [[LSL Status]] for what commands that are supported.
 
* Drag the script over to the contents of an object.
 
* If there is an error in the script when saving or when dropped into an object, an error alert is displayed for a short time. Click on the alert to display the Debug Window and the script error.
 
* To deactivate a script, edit the script and uncheck 'Running'. This also stops error alerts when saving scripts.
 
* Deleting a script from the object will not always stop its effects. Examples of this are hovertexts, or particles. The reason why they stay even after the script is deleted, is because hovertext and particles are prim properties, which can only be edited through a script. To get rid of the effects, you must first deactivate them in your script, before deleting the script. If you deleted your script before you've cleared the effects, you will have to make a script that will deactivate or clear them, and use them in that prim.
 
-->
 
 
 
Known problems:
 
Known problems:
 
* Error messages about scripting errors are often cryptic, and tend to be long.
 
* Error messages about scripting errors are often cryptic, and tend to be long.
* List memory optimization hacks like this ... myList = llListReplaceList((myList = []) + myList, ["myString"], 2, 2); ... will fail.
+
* Script syntax and execution may depend on the engine used, old [[XEngine]] or [[YEngine]]
* Linux/Mac users will need to upgrade the default mono to "mono-complete" in order to have a fully functional scripting engine in OpenSimulator. See [http://opensimulator.org/mantis/view.php?id=5007 the bug tracker] for details.
+
* On teleports or crossings from a region using YEngine to a region using XEngine, script state (like changed values on global variables) is lost. Should be okay on the inverse direction.
  
 
== Scripting System Status ==
 
== Scripting System Status ==
Line 97: Line 97:
  
 
More editors are listed at http://wiki.secondlife.com/wiki/LSL_Alternate_Editors
 
More editors are listed at http://wiki.secondlife.com/wiki/LSL_Alternate_Editors
 
  
 
=== Syntax Highlighting ===
 
=== Syntax Highlighting ===
Line 109: Line 108:
  
 
* [http://scriptastic.greenbush.us A simple web based Scratch like environment for creating LSL code and teaching kids to make LSL scripts ]
 
* [http://scriptastic.greenbush.us A simple web based Scratch like environment for creating LSL code and teaching kids to make LSL scripts ]
 
 
* [http://www.hilarymason.com/blog/secondlife/autoscript-creates-lsl-scripts-without-code/ AutoScript, Simple & Quick Code generator for simple things (ONLINE)]
 
* [http://www.hilarymason.com/blog/secondlife/autoscript-creates-lsl-scripts-without-code/ AutoScript, Simple & Quick Code generator for simple things (ONLINE)]
 
 
* [http://code.google.com/p/lslsnippets/ lslsnippets ]
 
* [http://code.google.com/p/lslsnippets/ lslsnippets ]
 
 
* [http://www.vtoreality.com/2006/free-offsite-storage-for-lsl-scripts-up-to-250k/186/ Free offsite storage for LSL scripts up to 250k ]
 
* [http://www.vtoreality.com/2006/free-offsite-storage-for-lsl-scripts-up-to-250k/186/ Free offsite storage for LSL scripts up to 250k ]
 
 
* [http://www.freeslscripts.gendersquare.org/index.php Free SL Scripts (library)]
 
* [http://www.freeslscripts.gendersquare.org/index.php Free SL Scripts (library)]
 
 
* [http://s4sl.blogspot.com/ Scratch for SecondLife (Script Code generator with Nice Interface - UPDATED JUL.09.2009)]
 
* [http://s4sl.blogspot.com/ Scratch for SecondLife (Script Code generator with Nice Interface - UPDATED JUL.09.2009)]
 
 
* [http://inworks.ucdenver.edu/jkb/fs2lsl/ FS2LSL Flash Scratch to LSL (a feature-rich Scratch-like script code generator)]
 
* [http://inworks.ucdenver.edu/jkb/fs2lsl/ FS2LSL Flash Scratch to LSL (a feature-rich Scratch-like script code generator)]
 
 
* [http://www.peregrinesalon.com/2009/01/05/major-upgrade-to-animated-gif-to-animated-sl-texture-conversion-tool-v04/ Second Life Animated Texture Creator v0.4 - brought to you by Peregrine Salon]
 
* [http://www.peregrinesalon.com/2009/01/05/major-upgrade-to-animated-gif-to-animated-sl-texture-conversion-tool-v04/ Second Life Animated Texture Creator v0.4 - brought to you by Peregrine Salon]
 
+
* [https://outworldz.com/cgi/freescripts.plx Freescripts] - More then 1000 open source/public domain scripts (library)
* [[Presentation Board]] - Simple Presentation Board that slides through inventory textures...
+
* [http://greenbushlabs.com/scriptastic Scriptastic] - Block Based Script Building Tool (like Scratch) making LSL Scripting Simple Enough Even for Kids.
 
+
* [https://github.com/wp2opensim/FS2SL/ GitHub FS2LSL] - FS2LSL Online-Offline LSL/OSSL script editor for WEB or Windows (Programming for beginners).
* [http://www.free-lsl-scripts.com/cgi/freescripts.plx More then 1000 open source/public domain scripts (library)]
+
* [https://www.conwylie.co.uk/ScriptGenerator/ Con Wylie's Script Generator] - Script Generator.
 
+
* [http://particles-lsl-generator.bashora.com/ Particles LSL Generator] - LSL Particles System script generator.
* [http://greenbushlabs.com/scriptastic Block Based Script Building Tool (like Scratch) making LSL Scripting Simple Enough Even for Kids]
+
* [http://www.miceonabeam.com/ MiceOnABeam] - Scripting tools & componants for your virtual wolrd.
 
+
* [http://www.3greeneggs.com/autoscript/ Autoscript] - Script Generator.
* [https://github.com/wp2opensim/FS2SL GitHub FS2LSL] - FS2LSL Online-Offline LSL/OSSL script editor for WEB or Windows (Programming for beginners)
+
* [https://gridurl.appspot.com/ Grid URL Persister] - Designed to make work with http-in easier.
 +
* [http://outworldz.appspot.com/ Easy Free Database] - Designed to easier to save persistent variables in Second Life and OpenSim scripts..
  
 
== Additional Resources for Scripting (OSSL) ==
 
== Additional Resources for Scripting (OSSL) ==
Line 150: Line 143:
 
* [[OpenSim.Region.ScriptEngine.DotNetEngine|DotNet-Engine]] - Describes some of the esoteric parts of the DotNet-Engine  
 
* [[OpenSim.Region.ScriptEngine.DotNetEngine|DotNet-Engine]] - Describes some of the esoteric parts of the DotNet-Engine  
  
 +
== Example LSL Scripts ==
 +
* [[An Opensim version for llHTTPResponse]]
 +
* [[Changed_Event_Example]]
 +
* [[OpenSim:_LSL2CS|SetScope]] - Example of using SetScope()
 +
* [[DONTSITONME]]
 +
* [[LlParticleSystemExample|llParticleSystemExample]]
 +
* [[ModSendCommand]]
 +
* [[Rotating Prim]]
 +
* [[Particles]]
 +
* [[Public_Trampoline_Script]]
 +
* [[Sit and position]]
 +
* [[Sound loop]]
 +
* [[Smooth rotate texture]]
 +
* [[Presentation Board]] - Simple Presentation Board that slides through inventory textures.
  
 
== See Also ==
 
== See Also ==
* [[ScriptEngines|Scripting Engine]] - [[Xengine]] Script Engine Transition (By Melanie_T)  
+
* [[ScriptEngines|Scripting Engine]] - [[Xengine]] Script Engine Transition (By Melanie_T), [[YEngine]]
 
* [[Scripting Languages]] - Supported Scripting Languages  
 
* [[Scripting Languages]] - Supported Scripting Languages  
 
* [[LSL Status|LSL/OSSL Status]] - Status and news about LSL and OSSL
 
* [[LSL Status|LSL/OSSL Status]] - Status and news about LSL and OSSL

Revision as of 02:38, 17 October 2020

Contents

About OpenSimulator scripting

An important ingredient in virtual worlds simulation is scripting.
Scripts allow the addition of actions to 'entities' in world, like making a door react to a touch and open.
Since version 0.9.1.0, you can chose between old XEngine or new YEngine script engines.
Script engines do script compilation and control script execution.

A script is not a like a full program, it is a set of blocks of code called when some event happens, like a touch on the door.
Many of those events happen at time critical moments, so those blocks should be small and fast to reduce impact on the rest of simulation.
YEngine may allow long processing to happen with less impact on the simulation, but that will happen at lower priority.


OpenSimulator script language supports a subset of the Linden Labs Second Life script language (LSL) plus its own extensions (OSSL).

LSL (Linden Scripting Language)
OSSL

Configuring scripting

There are a number of parameters that can be tweaked for scripting, such as those which enable OSSL commands or increase the limits on certain script facilities (e.g. listeners).

For standalone and small grid use, the default scripting settings should be fine. See Configuring Scripting for information on configuring these parameters.

How to use scripts in OpenSimulator

If you have never written a script in LSL before, then please have a look at the LSL wiki to learn the scripting basics. If you do have (some) experience with writing or editing LSL scripts, then the procedure is identical to the procedure on SL. Known problems:

  • Error messages about scripting errors are often cryptic, and tend to be long.
  • Script syntax and execution may depend on the engine used, old XEngine or YEngine
  • On teleports or crossings from a region using YEngine to a region using XEngine, script state (like changed values on global variables) is lost. Should be okay on the inverse direction.

Scripting System Status

Status Tables / Charts related to LSL and OSSL functions, constants and related material.

LSL/OSSL Status Overview
LSL

OSSL

Additional Resources for Scripting (LSL)

There have been many questions regarding scripts and tools for scripting lately. Presented here are a variety of Links to Resources which will help most people with Scripting LSL.

OpenSimulator Specific Materials:

Suggested Links for LSL wikis:

Note the Tutorials, Examples & Script Libraries

Off-World Local LSL Editing Tools & Syntax Highlighters

Note: most do not support osFunctions

All EDITORS (no osFunctions) Windows version availableMacOSX version availableLinux version available

In this repository you can find the syntax grammar, syntax highlighting and snippet files for the Linden Scripting Language (LSL) of Second Life for different kinds of software.

LSL EDITOR (no osFunctions) Windows version available

Now an Open Source project. New release is February 2012 (Ver.2.44.2). A valuable tool and easy install.

LSL Plus (no osFunctions) Windows version availableMacOSX version availableLinux version available

Open source Eclipse plugin. Regular updates. Not quite as quick to get installed as LSLEditor, but very good tool.

Notepad++ (osFunctions supported with add-on UDF) Windows version available

Windows only Editor with enhanced capabilities & supports most languages. Very powerful & feature rich.

KATE (no osFunctions) Windows version availableMacOSX version availableLinux version available

Free and open source text editor, supporting lots of scriptinmg and programming languages out of the box. This includes LSL.

Sublime Text 2 (os*/wl*/mod* functions supported with the bundle below) Windows version availableMacOSX version availableLinux version available

Completions & syntax coloring of LSL/OSSL functions/events/constants & in-world editor look-and-feel theme.
To use OSSL feature, use ".ossl" for your script file extension.
It is currently compatible with LL v3.4.1 and OpenSimulator v0.7.4+ (master r/21068).

FS2LSL Graphical editor (LSL OSSL) Windows version availableMacOSX version availableLinux version available

Free and open source text editor, Online-Offline LSL/OSSL Graphical script editor for WEB Browser or Windows (Programming for beginners)

More editors are listed at http://wiki.secondlife.com/wiki/LSL_Alternate_Editors

Syntax Highlighting

Miscellaneous:

Additional Resources for Scripting (OSSL)

There have been many questions regarding scripts and tools for scripting lately. Presented here are a a few links to Resources which will help most people with OSSL scripting.

How to contribute

The ScriptEngine is being developed by many developers. New developers are always welcome. If you want to contribute, even just a tiny little bit, have a look at the OpenSim.Region.ScriptEngine page. There is a lot of developer activity on IRC (Support), feel free to drop in.

Example LSL Scripts

See Also

Personal tools
General
About This Wiki