Scripting Documentation

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)

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); ... 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.

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

LSL/OSSL Status Overview

LSL OSSL
 * LSL-Functions Status
 * LSL-Constants Status
 * LSL-Events Status
 * LSL-Types Status
 * OSSL Functions with examples
 * OSSL Constants

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:

 * OSSL Functions with examples - A good place to start reading about OSSL scripting.
 * OSSL Script Library A library of scripts which utilize OSSL functions.

Suggested Links for LSL wikis:

 * wiki.secondlife.com

Note the Tutorials, Examples & Script Libraries

Off-World Local LSL Editing Tools & Syntax Highlighters
Note: most do not support osFunctions

All EDITORS (no osFunctions)
 * 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)
 * LSLeditor SourceForge
 * Original Author's website with his latest LSLeditor version
 * 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.

LSL Plus (no osFunctions)
 * LSLplus
 * 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)
 * Notepad Plus Plus
 * LSL and OS functions UDF
 * 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.

KATE (no osFunctions)
 * Kate Homepage
 * 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)
 * Sublime Text 2.
 * LSL/OSSL Bundle for Sublime Text 2 (from Makopoppo's github repository)
 * 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)
 * 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

Syntax Highlighting

 * GeSHi project home page
 * Most current version of GeSHI for download
 * GeSHi LSL support file includes osFunctions & updated
 * Extra Reference at MediaWiki: GeSHi Syntax Highlighter for WIKI and Forums

Miscellaneous:

 * A simple web based Scratch like environment for creating LSL code and teaching kids to make LSL scripts


 * AutoScript, Simple & Quick Code generator for simple things (ONLINE)


 * lslsnippets


 * Free offsite storage for LSL scripts up to 250k


 * Free SL Scripts (library)


 * Scratch for SecondLife (Script Code generator with Nice Interface - UPDATED JUL.09.2009)


 * FS2LSL Flash Scratch to LSL (a feature-rich Scratch-like script code generator)


 * Second Life Animated Texture Creator v0.4 - brought to you by Peregrine Salon


 * Presentation Board - Simple Presentation Board that slides through inventory textures...


 * More then 1000 open source/public domain scripts (library)


 * Block Based Script Building Tool (like Scratch) making LSL Scripting Simple Enough Even for Kids


 * 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.


 * OSSL Functions with examples - A good place to start reading about OSSL scripting.
 * OSSL Script Library A library of scripts which utilize OSSL functions.
 * OSSL Proposals - Suggestions for custom OSSL functions. Got a suggestion too? Add it!
 * Drawing commands - How to use the texture draw functions supported in OSSL.
 * OSSL TextureDrawing - Details of the OSSL texture drawing functions.
 * Language Translation - A script which uses the JSON parsing function to call Google's Translation API
 * OSGrid Forums - LSL/OSSL discussions, examples, tips, etc.

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.


 * OSSL Standards - A whitepaper concerning naming-standards for the OpenSimulator scripting language
 * OpenSim.Region.ScriptEngine.Common - How to create your own script engine
 * DotNet-Engine - Describes some of the esoteric parts of the DotNet-Engine