Scripting Documentation/de
From OpenSimulator
(→Weiteres) |
|||
Line 1: | Line 1: | ||
{{Quicklinks|Scripting_Documentation}} | {{Quicklinks|Scripting_Documentation}} | ||
− | == | + | == 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 /> | |
− | + | OpenSimulator today supports LSL (with extra OSSL and various other functions) 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. 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. | |
− | * OpenSimulator | + | * Stability and security: see [[Script Sandbox|Script Execution Sandbox]]. |
− | * | + | |
− | == | + | == 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. | |
− | [[Configuring Scripting | + | |
− | == | + | == 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 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. --> | ||
+ | <!--The current procedure to get a script working in OpenSimulator is: | ||
+ | * 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 OpenSimulator library. Check [[LSL Status]] for what commands that are supported. | ||
+ | * 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. | ||
+ | * To deactivate a script, edit the script and uncheck 'Running'. This also stops error alerts when saving scripts. | ||
+ | * Deleting a script from the object will not always stop its effects. Examples of this are hovertexts, or particles. The reason why they stay even after the script is deleted, is because hovertext and particles are prim properties, which can only be edited through a script. To get rid of the effects, you must first deactivate them in your script, before deleting the script. If you deleted your script before you've cleared the effects, you will have to make a script that will deactivate or clear them, and use them in that prim. | ||
+ | --> | ||
− | + | 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); ... 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 [http://opensimulator.org/mantis/view.php?id=5007 the bug tracker] for details. | ||
− | + | == Scripting System Status == | |
− | + | Status Tables / Charts related to LSL and OSSL functions, constants and related material.<br /> | |
− | + | ||
− | + | [[LSL Status|LSL/OSSL Status Overview]]<br /> | |
− | + | ||
− | + | ||
− | [[LSL Status|LSL/OSSL | + | |
'''LSL''' | '''LSL''' | ||
− | * [[LSL Status/Functions|LSL- | + | * [[LSL Status/Functions|LSL-Functions Status]] |
− | * [[LSL Status/Constants|LSL- | + | * [[LSL Status/Constants|LSL-Constants Status]] |
− | * [[LSL Status/Events|LSL-Events]] | + | * [[LSL Status/Events|LSL-Events Status]] |
− | * [[LSL Status/Types|LSL- | + | * [[LSL Status/Types|LSL-Types Status]] |
'''OSSL''' | '''OSSL''' | ||
− | * [[OSSL Implemented|OSSL | + | * [[OSSL Implemented|OSSL Functions with examples]] |
− | * [[OSSL | + | * [[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: === | |
− | + | ||
− | + | * [[: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: === | |
− | + | * [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 | ||
+ | |||
+ | == Off-World Local LSL Editing Tools & Syntax Highlighters == | ||
+ | Note: most do not support osFunctions | ||
+ | |||
+ | '''LSL EDITOR''' ''(no osFunctions)'' [[Image:Windows_logo.png|24px|frameless|Windows version available]] | ||
+ | :* [http://sourceforge.net/projects/lsleditor/ LSLeditor SourceForge] | ||
+ | :* [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. | ||
+ | ---- | ||
+ | '''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/ LSLplus] | ||
+ | :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)'' [[Image:Windows_logo.png|24px|frameless|Windows version available]] | ||
+ | :* [http://notepad-plus-plus.org/ Notepad Plus Plus] | ||
+ | :* [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. | ||
+ | ---- | ||
+ | '''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] | ||
+ | :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)'' [[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://www.sublimetext.com Sublime Text 2]. | ||
+ | :* [http://github.com/Makopo/sublime-text-lsl 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). | ||
+ | ---- | ||
+ | More editors are listed at http://wiki.secondlife.com/wiki/LSL_Alternate_Editors | ||
+ | |||
+ | |||
+ | === Syntax Highlighting === | ||
+ | |||
+ | * [http://qbnz.com/highlighter/ GeSHi project home page] | ||
+ | * [https://sourceforge.net/projects/geshi/files/geshi/GeSHi%201.0.8.10/ Most current version of GeSHI for download] | ||
+ | * [https://github.com/WhiteStar-Magic/Scripting-Syntax-Highlights GeSHi LSL support file] includes osFunctions & updated | ||
+ | * Extra Reference at MediaWiki: [http://www.mediawiki.org/wiki/Extension:SyntaxHighlight_GeSHi GeSHi Syntax Highlighter for WIKI and Forums] | ||
+ | |||
+ | === Miscellaneous: === | ||
+ | |||
+ | * [http://scriptastic.greenbush.us A simple web based Scratch like environment for creating LSL code and teaching kids to make LSL scripts ] | ||
+ | |||
+ | * [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/ lslsnippets ] | ||
+ | |||
+ | * [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 Free SL Scripts (library)] | ||
+ | |||
+ | * [http://s4sl.blogspot.com/ Scratch for SecondLife (Script Code generator with Nice Interface - UPDATED JUL.09.2009)] | ||
+ | |||
+ | * [http://inworks.ucdenver.edu/jkb/fs2lsl/ FS2LSL Flash Scratch to LSL (a feature-rich Scratch-like script code generator)] | ||
+ | |||
+ | * [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... | ||
+ | |||
+ | * [http://www.free-lsl-scripts.com/cgi/freescripts.plx More then 1000 open source/public domain scripts (library)] | ||
+ | |||
+ | * [http://greenbushlabs.com/scriptastic Block Based Script Building Tool (like Scratch) making LSL Scripting Simple Enough Even for Kids] | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
* [https://github.com/wp2opensim/FS2SL GitHub FS2LSL] - FS2LSL Online-Offline LSL/OSSL script editor for WEB or Windows (Programming for beginners) | * [https://github.com/wp2opensim/FS2SL 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 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. | ||
+ | |||
+ | == 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 | ||
+ | * [[OpenSim.Region.ScriptEngine.DotNetEngine|DotNet-Engine]] - Describes some of the esoteric parts of the DotNet-Engine | ||
+ | |||
+ | |||
+ | == See Also == | ||
+ | * [[ScriptEngines|Scripting Engine]] - [[Xengine]] Script Engine Transition (By Melanie_T) | ||
+ | * [[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. | ||
+ | * [[Threat level]] - Information about OSSL threat levels. | ||
[[Category:Development]] | [[Category:Development]] | ||
[[Category:Users]] | [[Category:Users]] | ||
[[Category:Scripting]] | [[Category:Scripting]] | ||
[[Category:German_Translations]] | [[Category:German_Translations]] |
Revision as of 13:01, 13 April 2018
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 (with extra OSSL and various other functions) 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. 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 Execution Sandbox.
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); ... 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
- Now an Open Source project. New release is February 2012 (Ver.2.44.2). A valuable tool and easy install.
- 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.
- 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).
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
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.