Scripting Documentation
From OpenSimulator
(Difference between revisions)
m (Robot: Cosmetic changes) |
m (Robot: Replacing 'OpenSim' to 'OpenSimulator', which is the precise name) |
||
| Line 1: | Line 1: | ||
{{Quicklinks}} | {{Quicklinks}} | ||
| − | == About | + | == 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 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: | |
* 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. | ||
| − | * The | + | * 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]]. | ||
| − | == How to use scripts in | + | == How to use scripts in OpenSimulator == |
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. --> | <!-- 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 | + | <!--The current procedure to get a script working in OpenSimulator is: |
* Create a new script in inventory. (Inventory -> Create -> New Script) | * 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 | + | * 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. | * 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. | * 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. | ||
| Line 26: | Line 26: | ||
* 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); ... 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 | + | * 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. |
== Scripting System Status == | == Scripting System Status == | ||
| Line 123: | Line 123: | ||
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. | 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 | + | * [[OSSL Standards]] - A whitepaper concerning naming-standards for the OpenSimulator scripting language |
* [[OpenSim.Region.ScriptEngine.Common]] - How to create your own script engine | * [[OpenSim.Region.ScriptEngine.Common]] - How to create your own script engine | ||
* [[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 | ||
| Line 134: | Line 134: | ||
* [[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 | + | * [[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 22:58, 3 March 2012
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,OSL 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.
- 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.
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:
- Line numbers in error messages may be off by 1 or 2 lines.
- 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.
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:
- lslwiki.net (Historical reference wiki)
Note the Tutorials, Examples & Script Libraries
Off-World Local LSL Editing Tools & Syntax Highlighters
Note: most do not support osFunctions
LSL EDITOR (no osFunctions) 
- 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)
- 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.
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
Miscelaneous:
- Presentation Board - Simple Presentation Board that slides through inventory textures...
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
See Also
- Scripting Engine - Xengine Script Engine Transition (By Melanie_T)
- 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.
- Non-LSL scripting - Information on C# and scripting in OpenSimulator with other languages
