Scripting Documentation

From OpenSimulator

(Difference between revisions)
Jump to: navigation, search
(Off-World Local LSL Editing Tools & Syntax Highlighters)
(Sonstiges:)
(18 intermediate revisions by 6 users not shown)
Line 4: Line 4:
 
An important ingredient in Second Life is scripting. It is the engine that drives it all. In SL [http://wiki.secondlife.com/wiki/LSL_Portal LSL (Linden Scripting Language)] is the language you have to use. This language has its limitations, and is executed very slowly. But nevertheless it works and it gets the job done. <br />
 
An important ingredient in Second Life is scripting. It is the engine that drives it all. In SL [http://wiki.secondlife.com/wiki/LSL_Portal LSL (Linden Scripting Language)] is the language you have to use. This language has its limitations, and is executed very slowly. But nevertheless it works and it gets the job done. <br />
  
OpenSimulator today supports LSL,OSL and C# scripts. But with limitations:
+
OpenSimulator today supports LSL (with extra OSSL and various other functions) and C# scripts. But with limitations:
* Not all commands and events have been implemented. See '''Scripting System Status''' below for details on what commands work and which don't.
+
* Not all commands and events have been implemented. See '''Scripting System Status''' below for details on what commands work and which don't.  Patches to implement missing functionality are very welcome.
 
* The OpenSimulator script engine compiles the LSL code down to .Net code that is JIT'ed to CPU native code (in layman's terms, when a script is run on OpenSim, it gets translated to something that the CPU directly can understand.). In effect this means that a LSL script in OpenSimulator should run faster than in Second Life.  
 
* The OpenSimulator script engine compiles the LSL code down to .Net code that is JIT'ed to CPU native code (in layman's terms, when a script is run on OpenSim, it gets translated to something that the CPU directly can understand.). In effect this means that a LSL script in OpenSimulator should run faster than in Second Life.  
 
* Stability and security: see [[Script Sandbox|Script Execution Sandbox]].
 
* Stability and security: see [[Script Sandbox|Script Execution Sandbox]].
Line 64: Line 64:
 
Note: most do not support osFunctions
 
Note: most do not support osFunctions
  
 +
'''All EDITORS''' ''(no osFunctions)'' [[Image:Windows_logo.png|24px|frameless|Windows version available]][[Image:Macosx_logo.png|24px|MacOSX version available]][[Image:Tux.png|24px|frameless|Linux version available]]
 +
:* [https://github.com/buildersbrewery/linden-scripting-language LSLeditor´s Github]
 +
: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)'' [[Image:Windows_logo.png|24px|frameless|Windows version available]]
 
'''LSL EDITOR''' ''(no osFunctions)'' [[Image:Windows_logo.png|24px|frameless|Windows version available]]
 
:* [http://sourceforge.net/projects/lsleditor/ LSLeditor SourceForge]
 
:* [http://sourceforge.net/projects/lsleditor/ LSLeditor SourceForge]
 
:* [http://www.lsleditor.org/ Original Author's website with his latest LSLeditor version]
 
:* [http://www.lsleditor.org/ Original Author's website with his latest LSLeditor version]
 +
:* [https://github.com/wp2opensim/LSLEditor LSL Editor] for Windows10 (from version WhiteCoreDev 2.56 Oct 2017)
 
:Now an Open Source project. New release is February 2012 (Ver.2.44.2). A valuable tool and easy install.
 
:Now an Open Source project. New release is February 2012 (Ver.2.44.2). A valuable tool and easy install.
 
----
 
----
Line 76: Line 81:
 
:* [http://notepad-plus-plus.org/ Notepad Plus Plus]
 
:* [http://notepad-plus-plus.org/ Notepad Plus Plus]
 
:* [https://github.com/WhiteStar-Magic/NotePad---userdef/archives/master LSL and OS functions UDF]
 
:* [https://github.com/WhiteStar-Magic/NotePad---userdef/archives/master LSL and OS functions UDF]
 +
:* [https://github.com/wp2opensim/Notepad-plus-plus-OSSL-LSL-syntax-highlighting Notepad++ OSSL-LSL Syntax] with autocomplete and Phoenix LSL Präprozessor Syntax and oslogfile syntax highlight.
 
:Windows only Editor with enhanced capabilities & supports most languages. Very powerful & feature rich.
 
:Windows only Editor with enhanced capabilities & supports most languages. Very powerful & feature rich.
 
----
 
----
Line 82: Line 88:
 
:Free and open source text editor, supporting lots of scriptinmg and programming languages out of the box. This includes LSL.
 
:Free and open source text editor, supporting lots of scriptinmg and programming languages out of the box. This includes LSL.
 
----
 
----
'''Sublime Text 2''' ''(no osFunctions support yet)'' [[Image:Windows_logo.png|24px|frameless|Windows version available]][[Image:Macosx_logo.png|24px|MacOSX version available]][[Image:Tux.png|24px|frameless|Linux version available]]
+
'''Sublime Text 2''' ''(os*/wl*/mod* functions supported with the bundle below)'' [[Image:Windows_logo.png|24px|frameless|Windows version available]][[Image:Macosx_logo.png|24px|MacOSX version available]][[Image:Tux.png|24px|frameless|Linux version available]]
:* [http://github.com/Makopo/sublime-text-lsl LSL Syntax File for Sublime Text 2 (from Makopoppo's github repository)]
+
:* [http://www.sublimetext.com Sublime Text 2].
:* The language files for [http://www.sublimetext.com Sublime Text 2].
+
:* [http://github.com/Makopo/sublime-text-lsl LSL/OSSL Bundle for Sublime Text 2 (from Makopoppo's github repository)]
:* Completions & syntax coloring of LSL functions/events/constants. It is currently compatible with LL v3.4.1.
+
: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)'' [[Image:Windows_logo.png|24px|frameless|Windows version available]][[Image:Macosx_logo.png|24px|MacOSX version available]][[Image:Tux.png|24px|frameless|Linux version available]]
 +
:* [https://github.com/wp2opensim/FS2SL GitHub FS2LSL Graphical editor]
 +
: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
 
More editors are listed at http://wiki.secondlife.com/wiki/LSL_Alternate_Editors
  
Line 98: Line 111:
  
 
=== Miscellaneous: ===
 
=== Miscellaneous: ===
 +
 +
* [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)]
Line 109: Line 124:
 
* [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://redwood.colorado.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]
Line 118: Line 133:
  
 
* [http://greenbushlabs.com/scriptastic Block Based Script Building Tool (like Scratch) making LSL Scripting Simple Enough Even for Kids]
 
* [http://greenbushlabs.com/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)
  
 
== Additional Resources for Scripting (OSSL) ==
 
== Additional Resources for Scripting (OSSL) ==
Line 129: Line 146:
 
* [[OsParseJSON example1|Language Translation]] - A script which uses the JSON parsing function to call Google's Translation API
 
* [[OsParseJSON example1|Language Translation]] - A script which uses the JSON parsing function to call Google's Translation API
 
* [http://www.osgrid.org/forums/ OSGrid Forums] - LSL/OSSL discussions, examples, tips, etc.
 
* [http://www.osgrid.org/forums/ OSGrid Forums] - LSL/OSSL discussions, examples, tips, etc.
 
  
 
== How to contribute ==
 
== How to contribute ==
Line 145: Line 161:
 
* [[OSSL Enabling Functions]] - How to enable OSSL functions.
 
* [[OSSL Enabling Functions]] - How to enable OSSL functions.
 
* [[Threat level]] - Information about OSSL threat levels.
 
* [[Threat level]] - Information about OSSL threat levels.
* [[Non-LSL scripting]] - Information on C# and scripting in OpenSimulator with other languages
 
  
 
[[Category:Development]]
 
[[Category:Development]]
 
[[Category:Users]]
 
[[Category:Users]]
 
[[Category:Scripting]]
 
[[Category:Scripting]]

Revision as of 16:10, 13 April 2018

Contents

About OpenSimulator scripting

An important ingredient in Second Life is scripting. It is the engine that drives it all. In SL LSL (Linden Scripting Language) is the language you have to use. This language has its limitations, and is executed very slowly. But nevertheless it works and it gets the job done.

OpenSimulator today supports LSL (with extra OSSL and various other functions) and C# scripts. But with limitations:

  • Not all commands and events have been implemented. See Scripting System Status below for details on what commands work and which don't. Patches to implement missing functionality are very welcome.
  • The OpenSimulator script engine compiles the LSL code down to .Net code that is JIT'ed to CPU native code (in layman's terms, when a script is run on OpenSim, it gets translated to something that the CPU directly can understand.). In effect this means that a LSL script in OpenSimulator should run faster than in Second Life.
  • Stability and security: see Script Execution Sandbox.

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.
  • List memory optimization hacks like this ... myList = llListReplaceList((myList = []) + myList, ["myString"], 2, 2); ... will fail.
  • 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 the bug tracker for details.

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:

  • Presentation Board - Simple Presentation Board that slides through inventory textures...
  • GitHub FS2LSL - FS2LSL Online-Offline LSL/OSSL script editor for WEB or Windows (Programming for beginners)

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.


See Also

Personal tools
General
About This Wiki