Scripting Documentation
From OpenSimulator
(→About OpenSimulator scripting) |
(→About OpenSimulator scripting) |
||
| Line 7: | Line 7: | ||
Script engines are the parts than do scripts compilation and control their execution.<br> | Script engines are the parts than do scripts compilation and control their execution.<br> | ||
<div style="background-color:#FFA0A0; padding:10px; padding-bottom:5px; border: 1px #FF544F solid"> | <div style="background-color:#FFA0A0; padding:10px; padding-bottom:5px; border: 1px #FF544F solid"> | ||
| − | A script is not a like a full program, | + | A script is not a like a full program, it is a set of blocks of code called when some event happens, like the touch on the door.<br> |
| − | + | Many of those events happen in 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. | ||
</div><br> | </div><br> | ||
Revision as of 11:07, 20 September 2020
About OpenSimulator scripting
An important ingredient in worlds simulation is scripting.
Scripts allow to add actions to entities' in world, like making a door to react to a touch and open.
Since version 0.9.1.1, You can chose between old XEngine or new YEngine script engines.
Script engines are the parts than do scripts compilation and control their execution.
A script is not a like a full program, it is a set of blocks of code called when some event happens, like the touch on the door.
Many of those events happen in 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 Xengine, scripts state ( like changed values on global variables) is lost. Should be ok on the inverse direction
Scripting System Status
Status Tables / Charts related to LSL and OSSL functions, constants and related material.
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:
- 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:
Note the Tutorials, Examples & Script Libraries
Off-World Local LSL Editing Tools & Syntax Highlighters
Note: most do not support osFunctions
All EDITORS (no osFunctions) 
- 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)
- 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)
- 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)
- 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)
- 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:
- 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.
- 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
Example LSL Scripts
- An Opensim version for llHTTPResponse
- Changed_Event_Example
- DONTSITONME
- llParticleSystemExample
- ModSendCommand
- Rotating Prim
- Particles
- Public_Trampoline_Script
- Sit and position
- Sound loop
- Smooth rotate texture
See Also
- Scripting Engine - Xengine Script Engine Transition (By Melanie_T), YEngine
- Scripting Languages - Supported Scripting Languages
- LSL/OSSL Status - Status and news about LSL and OSSL
- OSSL Enabling Functions - How to enable OSSL functions.
- Threat level - Information about OSSL threat levels.
