OSSL Script Library
From OpenSimulator
(Difference between revisions)
(Added script for NPC persistence per Fritigern's request.) |
|||
Line 1: | Line 1: | ||
− | {{Quicklinks}} | + | {{Quicklinks}} {{information}} |
− | {{information}} | + | |
− | + | ||
− | = | + | = OSSL Script Library = |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | == The Library == | + | === Rules for posting: === |
− | {|class="sortable" border="2" cellspacing="0 | + | |
− | | Script Name | + | #Your script '''MUST''' depend on at least one [[OSSL Functions|OSSL function]], or on other OpenSim-specific functions. |
− | | Posted by: | + | #Test your script in-world, and make sure it works, so that other people can use it. |
+ | #No copies of scripts which already exist on this wiki, unless it exists in your own user page. | ||
+ | #Please, no short scripts, and definitely no one-liners! | ||
+ | #Make sure to read "[[OSSL Script Library#Adding_your_script_to_the_Library|Adding your script to the Library]]" for important info! | ||
+ | |||
+ | == The Library == | ||
+ | |||
+ | {| class="sortable" border="2" cellspacing="0" cellpadding="3" | ||
+ | |- | ||
+ | | Script Name | ||
+ | | Posted by: | ||
| Description | | Description | ||
|- | |- | ||
− | | [[ | + | | [[OSSL Script Library/ModSendCommand|ModSendCommand]] |
− | | [[User:Justincc|Justincc]] | + | | [[User:Justincc|Justincc]] |
| Demonstrates the use of an in-world script to communicate with a specific OpenSim module. | | Demonstrates the use of an in-world script to communicate with a specific OpenSim module. | ||
|- | |- | ||
− | | [[ | + | | [[OSSL Script Library/OpenSim Radio|OpenSim Radio]] |
− | | [[User:Fritigern|Fritigern]] | + | | [[User:Fritigern|Fritigern]] |
− | | A dialog controlled radio for OpenSim. Uses OSSL functions to read stations from a notecard, | + | | A dialog controlled radio for OpenSim. Uses OSSL functions to read stations from a notecard, |
|- | |- | ||
+ | | [[OSSL Script Library/Persist NPC|Persist NPC]] | ||
+ | | [[User:Marcus Llewellyn|Marcus Llewellyn]] | ||
+ | | A short example of a method for persisting an NPC across simulator restarts. | ||
|} | |} | ||
− | == Adding your script to the Library == | + | == Adding your script to the Library == |
− | * First select, right-click, and copy the following code: | + | *First select, right-click, and copy the following code: |
− | + | <pre> |- | |
− | + | ||
| [[OSSL Script Library/SCRIPT_NAME|SCRIPT_NAME]] | | [[OSSL Script Library/SCRIPT_NAME|SCRIPT_NAME]] | ||
| [[User:YOURNAME|YOURNAME]] | | [[User:YOURNAME|YOURNAME]] | ||
| DESCRIPTION | | DESCRIPTION | ||
− | + | </pre> | |
− | * Edit the Library section, and paste the above code to the end of the list,, but just above "'''|}'''" | + | *Edit the Library section, and paste the above code to the end of the list,, but just above "'''|}'''" |
− | * Replace "'''SCRIPT_NAME'''" with the name of your script. Make sure to change both instances. | + | *Replace "'''SCRIPT_NAME'''" with the name of your script. Make sure to change both instances. |
− | * Replace "'''YOURNAME'''" with your wiki username. Make sure to change both instances. | + | *Replace "'''YOURNAME'''" with your wiki username. Make sure to change both instances. |
− | * Replace the word '''DESCRIPTION''' with a short desription of what your script does. | + | *Replace the word '''DESCRIPTION''' with a short desription of what your script does. |
− | * Click the "'''Show preview'''" button to check and see if everything works as it's supposed to. | + | *Click the "'''Show preview'''" button to check and see if everything works as it's supposed to. |
− | * If something looks wrong, change whatever is not right, and click "'''Show preview'''" again. | + | *If something looks wrong, change whatever is not right, and click "'''Show preview'''" again. |
− | * If everything looks okay, click the "'''Save page'''" button. | + | *If everything looks okay, click the "'''Save page'''" button. |
− | * In the table, look up the name of your script (it should be red) and click it. This will create a new page. | + | *In the table, look up the name of your script (it should be red) and click it. This will create a new page. |
− | * In the new page, Type '''<nowiki><source lang="lsl"></nowiki>'''. This will make the wiki recognise your script as LSL, and apply the correct source highlighting. | + | *In the new page, Type '''<nowiki><source lang="lsl"></nowiki>'''. This will make the wiki recognise your script as LSL, and apply the correct source highlighting. |
− | * Paste your script into the page. | + | *Paste your script into the page. |
− | * Immediately below your script, type '''<nowiki></source></nowiki>'''. This will tell the wiki where your script ends. | + | *Immediately below your script, type '''<nowiki></source></nowiki>'''. This will tell the wiki where your script ends. |
− | * Optionally add an introductory text, though you are encouraged to place usage instructions for your script in your script's comments. | + | *Optionally add an introductory text, though you are encouraged to place usage instructions for your script in your script's comments. |
− | * Preview the page by clicking the "'''Show preview'''" button. | + | *Preview the page by clicking the "'''Show preview'''" button. |
− | * Make changes where nescessary and click the "'''Show preview'''" button again. | + | *Make changes where nescessary and click the "'''Show preview'''" button again. |
− | * Save your page by pressing the "'''Save page'''" button, and presto! | + | *Save your page by pressing the "'''Save page'''" button, and presto! |
− | + | ||
− | [[Category:Scripts]][[Category:OSSL]] | + | [[Category:Scripts]] [[Category:OSSL]] |
Revision as of 21:28, 15 October 2011
See the conference website for more details. |
Contents |
OSSL Script Library
Rules for posting:
- Your script MUST depend on at least one OSSL function, or on other OpenSim-specific functions.
- Test your script in-world, and make sure it works, so that other people can use it.
- No copies of scripts which already exist on this wiki, unless it exists in your own user page.
- Please, no short scripts, and definitely no one-liners!
- Make sure to read "Adding your script to the Library" for important info!
The Library
Script Name | Posted by: | Description |
ModSendCommand | Justincc | Demonstrates the use of an in-world script to communicate with a specific OpenSim module. |
OpenSim Radio | Fritigern | A dialog controlled radio for OpenSim. Uses OSSL functions to read stations from a notecard, |
Persist NPC | Marcus Llewellyn | A short example of a method for persisting an NPC across simulator restarts. |
Adding your script to the Library
- First select, right-click, and copy the following code:
|- | [[OSSL Script Library/SCRIPT_NAME|SCRIPT_NAME]] | [[User:YOURNAME|YOURNAME]] | DESCRIPTION
- Edit the Library section, and paste the above code to the end of the list,, but just above "|}"
- Replace "SCRIPT_NAME" with the name of your script. Make sure to change both instances.
- Replace "YOURNAME" with your wiki username. Make sure to change both instances.
- Replace the word DESCRIPTION with a short desription of what your script does.
- Click the "Show preview" button to check and see if everything works as it's supposed to.
- If something looks wrong, change whatever is not right, and click "Show preview" again.
- If everything looks okay, click the "Save page" button.
- In the table, look up the name of your script (it should be red) and click it. This will create a new page.
- In the new page, Type <source lang="lsl">. This will make the wiki recognise your script as LSL, and apply the correct source highlighting.
- Paste your script into the page.
- Immediately below your script, type </source>. This will tell the wiki where your script ends.
- Optionally add an introductory text, though you are encouraged to place usage instructions for your script in your script's comments.
- Preview the page by clicking the "Show preview" button.
- Make changes where nescessary and click the "Show preview" button again.
- Save your page by pressing the "Save page" button, and presto!