MantisBT - opensim
View Issue Details
0008866opensim[GRID] Inventory Servicepublic2021-02-14 00:392021-03-21 13:41
Manni 
 
nonefeaturealways
newopen 
allallall
0.9.1.0 
 
Grid (Multiple Regions per Sim)
BulletSim
YEngine
Mono / Linux64
6.x
Singularity
0008866: missing examples
Please add ossl example scripts.
https://github.com/BigManzai/opensim-ossl-example-scripts [^]
This is a mirror of the opensimulator.org wiki.
Format: Explanation, First executable script, All other scripts as a remark.
No tags attached.
txt script.patch.txt (536) 2021-03-15 08:14
http://opensimulator.org/mantis/file_download.php?file_id=5048&type=bug
Issue History
2021-02-14 00:39ManniNew Issue
2021-02-14 00:50djphilNote Added: 0037563
2021-02-14 00:52djphilNote Edited: 0037563bug_revision_view_page.php?bugnote_id=37563#r9696
2021-02-14 01:45ManniNote Added: 0037564
2021-02-14 02:46tampaNote Added: 0037565
2021-02-14 03:03djphilNote Added: 0037566
2021-02-14 03:04djphilNote Edited: 0037566bug_revision_view_page.php?bugnote_id=37566#r9698
2021-02-14 03:05djphilNote Edited: 0037566bug_revision_view_page.php?bugnote_id=37566#r9699
2021-02-14 06:21piusnoelNote Added: 0037568
2021-02-14 06:51tampaNote Added: 0037569
2021-02-14 08:57Luisillo_ContepomiNote Added: 0037570
2021-02-14 08:59djphilNote Added: 0037571
2021-02-15 03:05ManniNote Added: 0037572
2021-03-15 08:11ManniNote Added: 0037668
2021-03-15 08:14ManniFile Added: script.patch.txt
2021-03-21 13:41Ferd FrederixNote Added: 0037682

Notes
(0037563)
djphil   
2021-02-14 00:50   
(edited on: 2021-02-14 00:52)
Your idea is good but your presentation of the scripts is less.
If you base it on the presentation of the scripts I made for you on the opensim wiki it seems clearer / readable / understandable to new users.

Of course this is just my humble opinion.

ref: https://forums.osgrid.org/viewtopic.php?p=28942#p28942 [^]

(0037564)
Manni   
2021-02-14 01:45   
I don't even understand what they're trying to tell me.
(0037565)
tampa   
2021-02-14 02:46   
Lacking in-line comments describing what each part does, inconsistent indentation, some are overly complex, some use functions in unsafe manners. I only looked at about a dozen, but they need a bit of work still.

Also, if you want to contribute please provide patches against master directly.
(0037566)
djphil   
2021-02-14 03:03   
(edited on: 2021-02-14 03:05)
What I'm trying to say is that:
https://github.com/BigManzai/opensim-ossl-example-scripts/blob/main/assets/ScriptsAssetSet/osSlerp.lsl [^]
Full of comments, 3 scripts in 1, it is not very presentable, clear, understandable.

I don't know if, as tampa says, full of comments on each line would make the script more readable.
Personally all the commented lines give me a headache. I always delete them to have a clear and pleasant script.

It might be better to put a simple link to the referente wiki page. The wiki is more suitable for deepening explanations.
I think you don't learn to script by reading the comments in a script but by reading the documentation.

(0037568)
piusnoel   
2021-02-14 06:21   
In my opinion this is something a grid administrator could add to the script library if wanted, but not something that should be added in general.

I agree that the current library is relatively poor, but most of the scripts contained therein are useful and easy to understand.

The first place I'm going to search for script examples is usually in the wikis, but not in the script libraries provided in the viewer.
(0037569)
tampa   
2021-02-14 06:51   
Think explanations of things can be better done in viewer. Been thinking about perhaps making each function in the script window have a right click open to "open help page" which brings up the relevant wiki page in a browser window in the viewer. Unfortunately not something we can add into OpenSim, but that would probably be best given it is in line with how, at least Windows, does help pages and such. Think everyone has once accidentally clicked on those before.

The script library is not well known to common users either. Think most either look toward the wikis or straight for examples on forums or such stuff. It's so far down the inventory list most never see it.
(0037570)
Luisillo_Contepomi   
2021-02-14 08:57   
Thanks for showing us a repository for the scripting library. (The wiki is not much help. It's very difficult to find items to enhance the library).
(0037571)
djphil   
2021-02-14 08:59   
The OSSL wiki is simple, just go to the right page.
@ http://opensimulator.org/wiki/Category:OSSL_Functions [^]
(0037572)
Manni   
2021-02-15 03:05   
So you mean the documented alternative scripts in an extra script, but that would increase the number of scripts extremely.
In addition, they mean exchanging the sparse documentation for a link to the OSSL Wiki, so that you have to constantly switch to the Wiki.

I did not find a patch of this size appropriate because copying it into the source code is much easier.

Of course, this can be done better, but it takes a lot of working hours on the part of the dev team because the source code is complicated and hardly documented.

I have now brought in 600 hours of work and tested this on 7 grids with positive feedback from many people.

Please note.
Beginners: Don't know what OSSL is, so you won't find any scripts or the wiki.
Anyone looking for OSSL in the Wiki will first come to the page on how to insert a new function with C#. I myself didn't know what OSSL was and where to find it for a long time.

Beginners: Can't understand anything from the source code if it is not sufficiently documented.


Many thanks to djphil for the many scripts that were added.
(0037668)
Manni   
2021-03-15 08:11   
#!/bin/sh
cd /opt/opensim
git clone https://github.com/BigManzai/opensim-ossl-example-scripts [^]
cp -r /opt/opensim/opensim-ossl-example-scripts/assets /opt/opensim/bin/assets
cp -r /opt/opensim/opensim-ossl-example-scripts/inventory/ScriptsLibrary /opt/opensim/bin/inventory

#Win10 PowerShell
cd C:/opensim
git clone https://github.com/BigManzai/opensim-ossl-example-scripts [^]
cp -r /opensim/opensim-ossl-example-scripts/assets /opensim/bin/assets
cp -r /opensim/opensim-ossl-example-scripts/inventory/ScriptsLibrary /opensim/bin/inventory
(0037682)
Ferd Frederix   
2021-03-21 13:41   
Thanks, Manni, this looks extremely useful. I have been doing this too, and will send a patch to you.