Scripting Documentation

From OpenSimulator

(Difference between revisions)
Jump to: navigation, search
(Undo revision 46128 by Manni (talk))
(How to use scripts in OpenSimulator)
 
(3 intermediate revisions by 2 users not shown)
Line 2: Line 2:
  
 
== About OpenSimulator scripting ==
 
== About OpenSimulator scripting ==
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 worlds simulation is scripting.
 +
OpenSimulator script language closely follows Linden Labs Second Life script language (LSL) with extra OSSL and various other functions.
  
OpenSimulator today supports LSL (with extra OSSL and various other functions) and C# scripts. But with limitations:
+
[http://wiki.secondlife.com/wiki/LSL_Portal LSL (Linden Scripting Language)]
* 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 Sandbox|Script Execution Sandbox]].
+
  
 
== Configuring scripting ==
 
== Configuring scripting ==
Line 29: Line 27:
 
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.
+
* List memory optimization hacks like this ... myList = llListReplaceList((myList = []) + myList, ["myString"], 2, 2); ... may 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 [http://opensimulator.org/mantis/view.php?id=5007 the bug tracker] for details.
 
* 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.
  
Line 56: Line 54:
  
 
* [http://wiki.secondlife.com/wiki/LSL_Portal wiki.secondlife.com]
 
* [http://wiki.secondlife.com/wiki/LSL_Portal wiki.secondlife.com]
 
* [http://www.lslwiki.net/lslwiki/wakka.php?wakka=HomePage lslwiki.net] ''(Historical reference wiki)''
 
  
 
Note the Tutorials, Examples & Script Libraries
 
Note the Tutorials, Examples & Script Libraries
Line 110: Line 106:
 
* Extra Reference at MediaWiki: [http://www.mediawiki.org/wiki/Extension:SyntaxHighlight_GeSHi GeSHi Syntax Highlighter for WIKI and Forums]
 
* Extra Reference at MediaWiki: [http://www.mediawiki.org/wiki/Extension:SyntaxHighlight_GeSHi GeSHi Syntax Highlighter for WIKI and Forums]
  
=== Sonstiges: ===
+
=== Miscellaneous: ===
  
 
* [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 ]

Latest revision as of 22:51, 15 November 2018

Contents

[edit] About OpenSimulator scripting

An important ingredient in worlds simulation is scripting. OpenSimulator script language closely follows Linden Labs Second Life script language (LSL) with extra OSSL and various other functions.

LSL (Linden Scripting Language)

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

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

[edit] Scripting System Status

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

LSL/OSSL Status Overview
LSL

OSSL

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

[edit] OpenSimulator Specific Materials:

[edit] Suggested Links for LSL wikis:

Note the Tutorials, Examples & Script Libraries

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


[edit] Syntax Highlighting

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

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

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


[edit] See Also

Personal tools
General
About This Wiki