Scripting Documentation
From OpenSimulator
(Difference between revisions)
m (→How to use scripts in OpenSim) |
m (Robot: Cosmetic changes) |
||
| Line 1: | Line 1: | ||
{{Quicklinks}} | {{Quicklinks}} | ||
| − | ==About OpenSim scripting== | + | == About OpenSim 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 /> |
OpenSim today supports LSL,OSL and C# scripts. But with limitations: | OpenSim 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 OpenSim 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 OpenSim should run faster than in Second Life. | * The OpenSim 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 OpenSim should run faster than in Second Life. | ||
| − | * Stability and security: see [[ | + | * Stability and security: see [[Script Sandbox|Script Execution Sandbox]]. |
| − | ==How to use scripts in OpenSim== | + | == How to use scripts in OpenSim == |
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. | ||
| Line 31: | Line 31: | ||
Status Tables / Charts related to LSL and OSSL functions, constants and related material.<br /> | Status Tables / Charts related to LSL and OSSL functions, constants and related material.<br /> | ||
| − | [[ | + | [[LSL Status|LSL/OSSL Status Overview]]<br /> |
'''LSL''' | '''LSL''' | ||
| − | * [[ | + | * [[LSL Status/Functions|LSL-Functions Status]] |
| − | * [[ | + | * [[LSL Status/Constants|LSL-Constants Status]] |
| − | * [[ | + | * [[LSL Status/Events|LSL-Events Status]] |
| − | * [[ | + | * [[LSL Status/Types|LSL-Types Status]] |
'''OSSL''' | '''OSSL''' | ||
| − | * [[ | + | * [[OSSL Implemented|OSSL Functions with examples]] |
| − | * [[ | + | * [[OSSL Constants]] |
| − | == Additional Resources for Scripting (LSL)== | + | == 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. | 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:=== | + | === OpenSimulator Specific Materials: === |
* [[:Category:OSSL Functions | OSSL Functions with examples]] - A good place to start reading about OSSL scripting. | * [[:Category:OSSL Functions | 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:=== | + | === Suggested Links for LSL wikis: === |
| − | * [http://wiki.secondlife.com/wiki/LSL_Portal | + | * [http://wiki.secondlife.com/wiki/LSL_Portal wiki.secondlife.com] |
| − | * [http://www.lslwiki.net/lslwiki/wakka.php?wakka=HomePage | + | * [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 | ||
| − | ==Off-World Local LSL Editing Tools & Syntax Highlighters== | + | == Off-World Local LSL Editing Tools & Syntax Highlighters == |
Note: most do not support osFunctions | Note: most do not support osFunctions | ||
| − | '''LSL EDITOR''' ''(no osFunctions)'' [[ | + | '''LSL EDITOR''' ''(no osFunctions)'' [[Image:Windows_logo.png|24px|frameless|Windows version available]] |
| − | :* [http://sourceforge.net/projects/lsleditor/ | + | :* [http://sourceforge.net/projects/lsleditor/ LSLeditor SourceForge] |
| − | :* [http://www.lsleditor.org/ | + | :* [http://www.lsleditor.org/ Original Author's website with his latest LSLeditor version] |
: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. | ||
---- | ---- | ||
| − | '''LSL Plus''' ''(no osFunctions)'' [[ | + | '''LSL Plus''' ''(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]] |
| − | :* [http://lslplus.sourceforge.net/ | + | :* [http://lslplus.sourceforge.net/ LSLplus] |
:Open source [http://www.eclipse.org/ Eclipse] plugin. Regular updates. Not quite as quick to get installed as LSLEditor, but very good tool. | :Open source [http://www.eclipse.org/ 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++''' ''(osFunctions supported with add-on UDF)'' [[Image:Windows_logo.png|24px|frameless|Windows version available]] |
:* [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] | ||
: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. | ||
---- | ---- | ||
| − | '''KATE''' ''(no osFunctions)'' [[ | + | '''KATE''' ''(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]] |
:* [http://kate-editor.org/ Kate Homepage] | :* [http://kate-editor.org/ Kate Homepage] | ||
: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. | ||
| Line 81: | Line 81: | ||
| − | ===Syntax Highlighting=== | + | === Syntax Highlighting === |
* [http://qbnz.com/highlighter/ GeSHi project home page] | * [http://qbnz.com/highlighter/ GeSHi project home page] | ||
| Line 88: | Line 88: | ||
* 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] | ||
| − | ===Miscelaneous:=== | + | === Miscelaneous: === |
| − | * [http://www.hilarymason.com/blog/secondlife/autoscript-creates-lsl-scripts-without-code/ | + | * [http://www.hilarymason.com/blog/secondlife/autoscript-creates-lsl-scripts-without-code/ AutoScript, Simple & Quick Code generator for simple things (ONLINE)] |
| − | * [http://code.google.com/p/lslsnippets/ | + | * [http://code.google.com/p/lslsnippets/ lslsnippets ] |
| − | * [http://www.vtoreality.com/2006/free-offsite-storage-for-lsl-scripts-up-to-250k/186/ | + | * [http://www.vtoreality.com/2006/free-offsite-storage-for-lsl-scripts-up-to-250k/186/ Free offsite storage for LSL scripts up to 250k ] |
| − | * [http://www.freeslscripts.gendersquare.org/index.php | + | * [http://www.freeslscripts.gendersquare.org/index.php Free SL Scripts (library)] |
| − | * [http://s4sl.blogspot.com/ | + | * [http://s4sl.blogspot.com/ Scratch for SecondLife (Script Code generator with Nice Interface - UPDATED JUL.09.2009)] |
| − | * [http://www.peregrinesalon.com/2009/01/05/major-upgrade-to-animated-gif-to-animated-sl-texture-conversion-tool-v04/ | + | * [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] |
* [[Presentation Board]] - Simple Presentation Board that slides through inventory textures... | * [[Presentation Board]] - Simple Presentation Board that slides through inventory textures... | ||
| Line 106: | Line 106: | ||
* [http://www.free-lsl-scripts.com/cgi/freescripts.plx More then 1000 open source/public domain scripts (library)] | * [http://www.free-lsl-scripts.com/cgi/freescripts.plx More then 1000 open source/public domain scripts (library)] | ||
| − | * [http://greenbushlabs.com/scriptastic | + | * [http://greenbushlabs.com/scriptastic Block Based Script Building Tool (like Scratch) making LSL Scripting Simple Enough Even for Kids] |
| − | == Additional Resources for Scripting (OSSL)== | + | == 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. | 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 Implemented|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. |
| − | * [[ | + | * [[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. | ||
| 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 OpenSim 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 129: | Line 129: | ||
== See Also == | == See Also == | ||
| − | *[[ScriptEngines|Scripting Engine]] - [[Xengine]] Script Engine Transition (By Melanie_T) | + | * [[ScriptEngines|Scripting Engine]] - [[Xengine]] Script Engine Transition (By Melanie_T) |
| − | *[[Scripting Languages]] - Supported Scripting Languages | + | * [[Scripting Languages]] - Supported Scripting Languages |
| − | *[[ | + | * [[LSL Status|LSL/OSSL Status]] - Status and news about LSL and OSSL |
| − | *[[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 OpenSim with other languages | + | * [[Non-LSL scripting]] - Information on C# and scripting in OpenSim with other languages |
| − | + | ||
[[Category:Development]] | [[Category:Development]] | ||
[[Category:Users]] | [[Category:Users]] | ||
[[Category:Scripting]] | [[Category:Scripting]] | ||
Revision as of 20:10, 3 March 2012
Contents |
About OpenSim 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.
OpenSim 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 OpenSim 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 OpenSim should run faster than in Second Life.
- Stability and security: see Script Execution Sandbox.
How to use scripts in OpenSim
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 OpenSim. 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 OpenSim 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 OpenSim with other languages
