Scripting Documentation
From OpenSimulator
Karen Palen (Talk | contribs) (Add troubleshooting reference) |
(→Overview) |
||
| Line 4: | Line 4: | ||
== Overview == | == Overview == | ||
| − | *[[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 | *[[LSL_Status|LSL/OSSL Status]] - Status and news about LSL and OSSL | ||
Revision as of 05:51, 19 November 2010
Overview
- Scripting Engine - Xengine Script Engine Transition (By Melanie_T)
- Scripting Languages - Supported Scripting Languages
- LSL/OSSL Status - Status and news about LSL and OSSL
- Non-LSL scripting - Information on C# and scripting in OpenSim with other languages
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 LSL/OSSL Status 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 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
Have a look at the LSL wiki to learn LSL. The current procedure to get a script working in OpenSim 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 OpenSim 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 the script from the object will not always deactivate a script. If a script is running in a prim and the script is deleted, the script may persist in the prim - which can be useful. Be sure scripts are not running when you wish to delete them.
There are still some defects:
- Line numbers in error messages may miss by 1 or 2 lines.
- Linux/Mac users may need to upgrade the default mono to include "mono-complete" for some scripts. See http://opensimulator.org/mantis/view.php?id=5007 for details.
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.
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.
OspenSimulator Specific Materials:
NOTE: Be sure to check the Discussion Pages which is on the tabs at the top.
Suggested Links for LSL wikis:
Note the Tutorials, Examples & Script Libraries
Off-World Local LSL Editing Tools (note they do not support osFunctions)
LSL EDITOR
Now an Open Source project. New release is 17th May 2010 (Ver.2.4). A valuable tool and easy install.
LSL Plus
Open source. Regualar updates. Not quite as quick to get installed as LSLEditor, but very good tool.
Others are listed here: http://wiki.secondlife.com/wiki/LSL_Alternate_Editors
Miscelaneous:
Additional Resources for Scripting (OSSL)
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 OSSL.
