http://opensimulator.org/api.php?action=feedcontributions&feedformat=atom&user=RknopOpenSimulator - User contributions [en]2026-05-15T17:13:13ZUser contributionsMediaWiki 1.19.9http://opensimulator.org/wiki/DependenciesDependencies2013-04-10T03:38:05Z<p>Rknop: /* Linux and Mac OSX */</p>
<hr />
<div>{{Quicklinks}}<br />
<br />
In addition to the OpenSimulator code itself, certain other packages need to be installed on different platforms in order to get OpenSimulator binaries to run. <br />
<br />
As well as the information on this page (which should be expanded), you may find more information on dependencies in [[Build Instructions]] though this will also contain dependencies required only for building. This are also more hints in [[Troubleshooting]].<br />
<br />
After solving dependencies, you may need to configure the firewall installed in your system by default so that the viewers outside can access to OpenSimulator inside it. See [[Firewall Settings]] for more informations.<br />
<br />
[[NAT Loopback Routers]] Router and Nat Loopback Information to help you configure your Router / Modem.<br />
<br />
<br />
<br />
= Windows =<br />
<br />
OpenSimulator now requires '''.NET Framework 3.5''' when running under Windows. If you run OpenSimulator on '''Windows 7''' or '''Windows Server 2008 R2''', it is already bundled so you can run OpenSimulator 0.7.1 out-of-the-box. On '''Windows Vista''', '''Windows Server 2008''', '''Windows Server 2003''' or '''Windows XP''', you'll need to upgrade it to 3.5(or later, but NET Framework 4.0 not officially supported by OpenSimulator yet), downloading from [http://msdn.microsoft.com/en-us/netframework/cc378097 Microsoft .NET Framework Download Page@.NET Framework Developer Center]. Note that prior versions of Windows(ex. NT or 2000) are NOT supported.<br />
<br />
If you run on Windows XP ensure it is updated to at least Service Pack 2 (SP2). <br />
<br />
Double-click or execute on command prompt:<br />
*32-bit version of Windows: '''OpenSim.exe'''<br />
*64-bit version of Windows: '''OpenSim.32BitLaunch.exe'''<br />
Depending on your installation, you may have to run the program as administrator(right click -> 'Run as administrator'). It will pop up a window asking permission, select "Allow".<br />
<br />
<br />
= Linux and Mac OSX =<br />
<br />
OpenSimulator requires Mono 2.4.3 or later. '''WARNING:''' OpenSimulator is known to have significant performance and scalability problems with Mono versions 2.8.x, 2.10.0 and 2.10.1. As of Mono 2.10.2, the scalability problems appear to have been resolved. Mono 2.6.x also appears to be fine, though the mono VM does seem to have some issues (crashing with a native stacktrace) on simulators running many regions or lots of users/prims. Therefore you should either use Mono 2.6.x or Mono 2.10.2 or later. You can also use Mono 2.4.3, but it is fairly old now.<br />
<br />
There are also reports that anything between Mono 2.10.9 and 3.0.3 has major issues; 3.0.7 is supposedly OK.<br />
<br />
To run OpenSimulator with mono, execute <br />
<br />
mono --debug OpenSim.exe<br />
<br />
This is the same for 32 bit and 64 bit systems. The --debug switch isn't strictly necessary, but it will insert line numbers for stack traces if you ever need to make a bug report, and the overhead of using it is very small.<br />
<br />
== Ubuntu ==<br />
<br />
sudo apt-get install mono-complete<br />
<br />
{{anchor|CentOS}}{{anchor|RedHat}}{{anchor|RHEL}}{{anchor|Fedora}}<br />
== RHEL, Fedora, CentOS or Any Other RedHat-based Distributions ==<br />
<br />
First, run "yum info mono-core" to see the version of the mono packages in the core repository for your distribution. If it shows '''2.4.3''' or later, proceed to [[#Installing from Core Repository]]. If not, skip to [[#Installing from Mono Repository]]. Note that the current version you can get from yum repository for some distributions is lower than requirement (ex. '''1.2.4''' on CentOS). Unlike Ubuntu, RedHat-based distributions should be always conservative, therefore it is natural that they don't so often update their repository. What you can do to manage this problem is to add an extra repository for mono.<br />
<br />
=== Installing from Core Repository ===<br />
<br />
Just type:<br />
<pre><br />
sudo yum install mono-core mono-data-sqlite mono-extras libgdiplus<br />
</pre><br />
It will also install dependent modules. After that you can launch OpenSim.exe with mono out-of-the-box.<br />
<br />
=== Installing from Mono Repository ===<br />
<br />
This procedure is tested on CentOS 5.5 & 5.6 box with OpenSimulator 0.7.1.<br />
<br />
Go to yum config file folder and create new one for mono.<br />
<pre><br />
cd /etc/yum.repos.d<br />
sudo vi mono.repo<br />
</pre><br />
<br />
And then in mono.repo :<br />
<pre><br />
[mono]<br />
name = novell-mono<br />
baseurl=http://ftp.novell.com/pub/mono/download-stable/RHEL_5/<br />
enabled=1<br />
gpgcheck=0<br />
</pre><br />
<br />
Now, you can yum install the later version of mono from this repository. Additional note that make sure all of mono packages are i386(not IA64 build). If your box is 32bit, don't care and you can even install properly without ".i386" suffix.<br />
<pre><br />
sudo yum install mono-addon-core.i386 mono-addon-data.i386 mono-addon-data-sqlite.i386 \<br />
mono-addon-extras.i386 mono-addon-web.i386 mono-addon-winforms.i386 mono-addon-libgdiplus0.i386<br />
</pre><br />
<br />
Yum will install mono into /opt/novell/mono, so you can create a symbolic link to /usr/bin :<br />
<pre><br />
sudo ln -s /opt/novell/mono/bin/mono /usr/bin/mono<br />
</pre><br />
<br />
After that, you should be able to launch OpenSim.exe without any errors.<br />
<br />
<br />
== Debian ==<br />
<br />
Debian 4 (Etch) is no longer supported by debian.org. Update at least to 5 (Lenny) before running OpenSimulator. See [http://www.debian.org/releases/lenny/i386/release-notes/ch-upgrading.html Upgrades from previous release@debian.org] for detail.<br />
<br />
For Debian 5 (Lenny) or later, just Type:<br />
<pre><br />
sudo aptitude install mono-gmcs libmono-microsoft8.0-cil \<br />
libmono-system-runtime2.0-cil libmono-i18n2.0-cil<br />
</pre><br />
<br />
You can even use apt-get instead of aptitude. They both will also install dependent packages.<br />
<br />
Tested on Debian 5(Lenny), Debian 6(Squeeze) and Debian 7(Wheezy) unstable.<br />
<br />
<br />
== openSuSE ==<br />
<br />
Just type:<br />
<pre><br />
sudo zypper install mono-core mono-data-sqlite mono-extras libgdiplus<br />
</pre><br />
It will also install dependent modules. After that you can launch OpenSim.exe with mono out-of-the-box.<br />
<br />
== Mac OS X ==<br />
<br />
All you have to do is to fetch Mono '''Runtime''' package from [http://www.go-mono.com/mono-downloads/download.html Mono Download Page] and install it. Alternatively, you can install mono with [http://mxcl.github.com/homebrew/ homebrew] with:<br />
<pre><br />
brew install mono<br />
</pre><br />
<br />
If you are using OS X 10.4, you should also install X11 from the OS X install CDs. In OS X 10.5, this is not required.<br />
<br />
= Locales and Regional Settings =<br />
OpenSimulator will only work properly when you run it with an English locale or regional setting. With other settings than English, you are likely to see a variety of issues, ranging from misbehaving scripts to crashes.<br />
<br />
== Linux ==<br />
In Linux, you can easily use the standard "C" locale just for running OpenSim.exe, as explained in [[Troubleshooting#ScriptEngine Issues]]:<br />
<pre><br />
env LANG=C mono OpenSim.exe<br />
</pre><br />
<br />
For information about changing your locale in a more general way, see [[Troubleshooting#Locales Issues]]<br />
<br />
== Windows ==<br />
If you are not using an English regional setting in Windows by default, then there is not a solution as easy as for Linux, unfortunately. I did it with an additional user account that I created just for OpenSimulator in which I set the regional setting to "English (US)". I run OpenSim.exe from my normal user account with "Run as..." (or check "Run with different credentials" in a shortcut's advanced properties) and specify the OpenSimulator account as the one to be used.<br />
<br />
<br />
= Additional Resources =<br />
<br />
OSGrid Technical Support Forum with many installation tutorials:&nbsp; [http://osgrid.org/forums/viewforum.php?f=14 osgrid.org/forums/viewforum.php] <br />
<br />
MONO&nbsp;Project:&nbsp; [http://www.mono-project.com/Main_Page www.mono-project.com/Main_Page]</div>Rknophttp://opensimulator.org/wiki/Codebase_overviewCodebase overview2011-08-09T23:41:27Z<p>Rknop: /* Codebase overview */</p>
<hr />
<div>__NOTOC__<br />
{{Quicklinks}}<br />
<br /><br />
==Coding restrictions==<br />
<br />
Because OpenSim has to run on both Windows and Mono (usually on Linux or Mac), we are limited to the parts of .net that [http://en.wikipedia.org/wiki/Mono_(software) Mono] supports.<br />
<br />
==Codebase overview==<br />
<br />
(This is probably quite out of date. On 2011-08-08, a few edits were made to bring pieces of it up to date, but the editor doesn't have enough of an overview in head to remove all the parts that aren't current. Edits will continue.)<br />
<br />
OpenSim is already a fairly large and intricate project, so patience is required to start understanding it.<br />
<br />
At the top level, OpenSim code is broken up into seven sections. There's also a bit more detail on the most significant packages within those sections.<br />
<br />
* '''OpenSim'''. This contains the classes which launch the OpenSim region server and handle the console<br />
** Startup<br />
*** The Main() for <tt>OpenSim.exe</tt> can be found in the file <tt>OpenSim/Region/Application/Application.cs</tt>. It does a bunch of configuration checks, but the meat of it is the instantiation of an '''OpenSim''' object, calling its Startup() method (which gets things rolling in separate threads), and then blocking the initial thread by prompting on the main console (using the Prompt() method MainConsole.Instance)<br />
*** OpenSim.OpenSim.Startup() comes from an ancestor, OpenSim.Framework.Servers.BaseOpenSimServer; it calls StartupSpecific()<br />
*** OpenSim.OpenSim.StartupSpecific() exists. It creates a console, registers the region console commands, makes a couple of status stream handlers, runs startup commands if any are specified in config, and hooks up its WatchdogTimeoutHandler to Watchdog. It then calls its base class' StartupSpecific(), and each base class calls ''its'' base class' StartupSpecific() (all the way back up to OpenSim.Framework.Servers.BaseOpenSimServer.StartupSpecific()).<br />
*** ancestor OpenSim.OpenSimBase starts up simulation and estate data services; creates a ModuleLoader (in field <tt>m_moduleLoader</tt>); and loads plugins of type IApplicationPlugin at extension point ("/OpenSim/Startup") (I have to admit to not fully knowing what that means...), and initializes each one of them.<br />
*** ancestor OpenSim.Region.ClientStack.RegionApplicationBase starts up an http server in its StartupSpecific()<br />
*** ancestor OpenSim.Framework.Servers.BaseOpenSimServer starts up (something to do with) the console in its StartupSpecific()<br />
*** I have yet to figure out where in all of this the region heartbeat actually gets going.... It may actually be inside a Plugin (LoadRegionsPlugin)<br />
<br />
* '''OpenSim.ApplicationPlugins'''. Each package is an individual application plugin - an application plugin is a modular piece of code that has an effect on the entire region server. See [[RegionModules]] for more details or one of [http://justincc.wordpress.com/2008/05/08/opensim-tech-basics-my-god-its-full-of-modules/ justincc's blogposts] for a higher level overview (which should really be in this wiki).<br />
<br />
* '''OpenSim.Data'''. This is all the low level database manipulation stuff. In here, you'll see packages for SQLite, MySQL and MSSQL (which tends to lag), as well as code for [http://www.hibernate.org/ NHibernate] which will hopefully reduce our reliance on manipulation code for specific databases.<br />
<br />
* '''OpenSim.Framework'''. General framework code used by the rest of OpenSim which is felt to be not specific to a region. <br />
** ''OpenSim.Framework.Communications''. Contains asset and inventory caching code (to cut down on communication with a remote asset or inventory service), and contains CAPS code, a Linden approach to splitting some aspects of the Second Life protocol into independent, secured services. See a [http://mrtopf.de/blog/secondlife/slga-capabilities-explained-technical/ blog post] from Tao for more background on this.<br />
** ''OpenSim.Framework.Servers''. Contains generic server code, such as the base OpenSim server and http servers.<br />
** ''OpenSim.Framework.Stats''. Collects statistical information on OpenSim operations.<br />
<br />
* '''OpenSim.Server''': these are things that are part of the R.O.B.U.S.T. services, including grid servers, avatar servers, asset servers, inventory servers, and the like.<br />
<br />
* '''OpenSim.Region'''. Contains most of the meaty code that it specifically concerned with region manipulation.<br />
** ''OpenSim.Region.ClientStack.LindenUDP''. The code necessary for communicating with clients using the Second Life protocol.<br />
** ''OpenSim.Region.Communications.Local''. Code used for communicating with non-region services (user, asset, grid, etc.) when OpenSim is running in standalone mode.<br />
** ''OpenSim.Region.Communications.OGS1''. Code for communicating with remote UGAI services using the Open Grid Services 1 protocol.<br />
** ''OpenSim.Region.Environment''. A large package containing both the vast majority of the region modules (categorized under modules) and the central scene manipulation code (under Scenes, appropriately enough). Modules here do everything from handling region chat to loading and saving terrain.<br />
** ''OpenSim.Region.Modules''. More region module code. Actually, I'm not too sure why these aren't in the OpenSim.Region.Environment package.<br />
** ''OpenSim.Region.Physics''. General physics framework code and plugins for specific engines (BulletX, ODE, etc). The ODE code is by far the most reliable and stable.<br />
** ''OpenSim.Region.ScriptEngine''. Script engine code that powers the scripts run within OpenSim. Currently there are two engines, the classic [[DotNetEngine]] and the relatively new [[XEngine]].<br />
** ''[[Overview of How RegionsWork|OpenSim.Region.Framework.Scenes.Scene]]'' is the "heart" of OpenSim functionality. It has the "main loop" for a region, in the method <tt>Update()</tt>.<br />
<br />
<br />
* '''OpenSim.Tests'''. Test code. Really, we don't actually have much of this (yet).</div>Rknophttp://opensimulator.org/wiki/Codebase_overviewCodebase overview2011-08-09T22:50:03Z<p>Rknop: /* Codebase overview */</p>
<hr />
<div>__NOTOC__<br />
{{Quicklinks}}<br />
<br /><br />
==Coding restrictions==<br />
<br />
Because OpenSim has to run on both Windows and Mono (usually on Linux or Mac), we are limited to the parts of .net that [http://en.wikipedia.org/wiki/Mono_(software) Mono] supports.<br />
<br />
==Codebase overview==<br />
<br />
(This is probably quite out of date. On 2011-08-08, a few edits were made to bring pieces of it up to date, but the editor doesn't have enough of an overview in head to remove all the parts that aren't current. Edits will continue.)<br />
<br />
OpenSim is already a fairly large and intricate project, so patience is required to start understanding it.<br />
<br />
At the top level, OpenSim code is broken up into seven sections. There's also a bit more detail on the most significant packages within those sections.<br />
<br />
* '''OpenSim'''. This contains the classes which launch the OpenSim region server and handle the console<br />
** Startup<br />
*** The Main() for <tt>OpenSim.exe</tt> can be found in the file <tt>OpenSim/Region/Application/Application.cs</tt>. It does a bunch of configuration checks, but the meat of it is the instantiation of an '''OpenSim''' object, calling its Startup() method (which gets things rolling in separate threads), and then blocking the initial thread by prompting on the main console (using the Prompt() method MainConsole.Instance)<br />
*** OpenSim.OpenSim.Startup() comes from an ancestor, OpenSim.Framework.Servers.BaseOpenSimServer; it calls StartupSpecific()<br />
*** OpenSim.OpenSim.StartupSpecific() exists, but much of the meat of really getting a region running is found in the base class' method OpenSim.OpenSimBase.StartupSpecific() (and in other versions of StartupSpecific() on up the inheritance hierarchy).<br />
<br />
* '''OpenSim.ApplicationPlugins'''. Each package is an individual application plugin - an application plugin is a modular piece of code that has an effect on the entire region server. See [[RegionModules]] for more details or one of [http://justincc.wordpress.com/2008/05/08/opensim-tech-basics-my-god-its-full-of-modules/ justincc's blogposts] for a higher level overview (which should really be in this wiki).<br />
<br />
* '''OpenSim.Data'''. This is all the low level database manipulation stuff. In here, you'll see packages for SQLite, MySQL and MSSQL (which tends to lag), as well as code for [http://www.hibernate.org/ NHibernate] which will hopefully reduce our reliance on manipulation code for specific databases.<br />
<br />
* '''OpenSim.Framework'''. General framework code used by the rest of OpenSim which is felt to be not specific to a region. <br />
** ''OpenSim.Framework.Communications''. Contains asset and inventory caching code (to cut down on communication with a remote asset or inventory service), and contains CAPS code, a Linden approach to splitting some aspects of the Second Life protocol into independent, secured services. See a [http://mrtopf.de/blog/secondlife/slga-capabilities-explained-technical/ blog post] from Tao for more background on this.<br />
** ''OpenSim.Framework.Servers''. Contains generic server code, such as the base OpenSim server and http servers.<br />
** ''OpenSim.Framework.Stats''. Collects statistical information on OpenSim operations.<br />
<br />
* '''OpenSim.Server''': these are things that are part of the R.O.B.U.S.T. services, including grid servers, avatar servers, asset servers, inventory servers, and the like.<br />
<br />
* '''OpenSim.Region'''. Contains most of the meaty code that it specifically concerned with region manipulation.<br />
** ''OpenSim.Region.ClientStack.LindenUDP''. The code necessary for communicating with clients using the Second Life protocol.<br />
** ''OpenSim.Region.Communications.Local''. Code used for communicating with non-region services (user, asset, grid, etc.) when OpenSim is running in standalone mode.<br />
** ''OpenSim.Region.Communications.OGS1''. Code for communicating with remote UGAI services using the Open Grid Services 1 protocol.<br />
** ''OpenSim.Region.Environment''. A large package containing both the vast majority of the region modules (categorized under modules) and the central scene manipulation code (under Scenes, appropriately enough). Modules here do everything from handling region chat to loading and saving terrain.<br />
** ''OpenSim.Region.Modules''. More region module code. Actually, I'm not too sure why these aren't in the OpenSim.Region.Environment package.<br />
** ''OpenSim.Region.Physics''. General physics framework code and plugins for specific engines (BulletX, ODE, etc). The ODE code is by far the most reliable and stable.<br />
** ''OpenSim.Region.ScriptEngine''. Script engine code that powers the scripts run within OpenSim. Currently there are two engines, the classic [[DotNetEngine]] and the relatively new [[XEngine]].<br />
** ''[[Overview of How RegionsWork|OpenSim.Region.Framework.Scenes.Scene]]'' is the "heart" of OpenSim functionality. It has the "main loop" for a region, in the method <tt>Update()</tt>.<br />
<br />
<br />
* '''OpenSim.Tests'''. Test code. Really, we don't actually have much of this (yet).</div>Rknophttp://opensimulator.org/wiki/Codebase_overviewCodebase overview2011-08-09T22:49:31Z<p>Rknop: </p>
<hr />
<div>__NOTOC__<br />
{{Quicklinks}}<br />
<br /><br />
==Coding restrictions==<br />
<br />
Because OpenSim has to run on both Windows and Mono (usually on Linux or Mac), we are limited to the parts of .net that [http://en.wikipedia.org/wiki/Mono_(software) Mono] supports.<br />
<br />
==Codebase overview==<br />
<br />
(This is probably quite out of date. On 2011-08-08, a few edits were made to bring pieces of it up to date, but the editor doesn't have enough of an overview in head to remove all the parts that aren't current. Edits will continue.)<br />
<br />
OpenSim is already a fairly large and intricate project, so patience is required to start understanding it.<br />
<br />
At the top level, OpenSim code is broken up into seven sections. There's also a bit more detail on the most significant packages within those sections.<br />
<br />
* '''OpenSim'''. This contains the classes which launch the OpenSim region server and handle the console<br />
** Startup<br />
*** The Main() for <tt>OpenSim.exe</tt> can be found in the file <tt>OpenSim/Region/Application/Application.cs</tt>. It does a bunch of configuration checks, but the meat of it is the instantiation of an '''OpenSim''' object, calling its Startup() method (which gets things rolling in separate threads), and then blocking the initial thread by prompting on the main console (using the Prompt() method MainConsole.Instance)<br />
*** OpenSim.OpenSim.Startup() comes from an ancestor, OpenSim.Framework.Servers.BaseOpenSimServer; it calls StartupSpecific()<br />
*** OpenSim.OpenSim.StartupSpecific() exists, but much of the meat of really getting a region running is found in the base class' method OpenSim.OpenSimBase.StartupSpecific() (and in other versions of StartupSpecific() on up the inheritance hierarchy).<br />
<br />
* '''OpenSim.ApplicationPlugins'''. Each package is an individual application plugin - an application plugin is a modular piece of code that has an effect on the entire region server. See [[RegionModules]] for more details or one of [http://justincc.wordpress.com/2008/05/08/opensim-tech-basics-my-god-its-full-of-modules/ justincc's blogposts] for a higher level overview (which should really be in this wiki).<br />
<br />
* '''OpenSim.Data'''. This is all the low level database manipulation stuff. In here, you'll see packages for SQLite, MySQL and MSSQL (which tends to lag), as well as code for [http://www.hibernate.org/ NHibernate] which will hopefully reduce our reliance on manipulation code for specific databases.<br />
<br />
* '''OpenSim.Framework'''. General framework code used by the rest of OpenSim which is felt to be not specific to a region. <br />
** ''OpenSim.Framework.Communications''. Contains asset and inventory caching code (to cut down on communication with a remote asset or inventory service), and contains CAPS code, a Linden approach to splitting some aspects of the Second Life protocol into independent, secured services. See a [http://mrtopf.de/blog/secondlife/slga-capabilities-explained-technical/ blog post] from Tao for more background on this.<br />
** ''OpenSim.Framework.Servers''. Contains generic server code, such as the base OpenSim server and http servers.<br />
** ''OpenSim.Framework.Stats''. Collects statistical information on OpenSim operations.<br />
<br />
* '''OpenSim.Server''': these are things that are part of the R.O.B.U.S.T. services, including grid servers, avatar servers, asset servers, inventory servers, and the like.<br />
<br />
* '''OpenSim.Region'''. Contains most of the meaty code that it specifically concerned with region manipulation.<br />
** ''OpenSim.Region.ClientStack.LindenUDP''. The code necessary for communicating with clients using the Second Life protocol.<br />
** ''OpenSim.Region.Communications.Local''. Code used for communicating with non-region services (user, asset, grid, etc.) when OpenSim is running in standalone mode.<br />
** ''OpenSim.Region.Communications.OGS1''. Code for communicating with remote UGAI services using the Open Grid Services 1 protocol.<br />
** ''OpenSim.Region.Environment''. A large package containing both the vast majority of the region modules (categorized under modules) and the central scene manipulation code (under Scenes, appropriately enough). Modules here do everything from handling region chat to loading and saving terrain.<br />
** ''OpenSim.Region.Modules''. More region module code. Actually, I'm not too sure why these aren't in the OpenSim.Region.Environment package.<br />
** ''OpenSim.Region.Physics''. General physics framework code and plugins for specific engines (BulletX, ODE, etc). The ODE code is by far the most reliable and stable.<br />
** ''OpenSim.Region.ScriptEngine''. Script engine code that powers the scripts run within OpenSim. Currently there are two engines, the classic [[DotNetEngine]] and the relatively new [[XEngine]].<br />
** ''[[Overview of How RegionsWork|OpenSim.Region.Framework.Scene.Scene]]'' is the "heart" of OpenSim functionality. It has the "main loop" for a region, in the method <tt>Update()</tt>.<br />
<br />
<br />
* '''OpenSim.Tests'''. Test code. Really, we don't actually have much of this (yet).</div>Rknophttp://opensimulator.org/wiki/Codebase_overviewCodebase overview2011-08-09T22:43:23Z<p>Rknop: /* Codebase overview */</p>
<hr />
<div>__NOTOC__<br />
{{Quicklinks}}<br />
<br /><br />
==Coding restrictions==<br />
<br />
Because OpenSim has to run on both Windows and Mono (usually on Linux or Mac), we are limited to the parts of .net that [http://en.wikipedia.org/wiki/Mono_(software) Mono] supports.<br />
<br />
==Codebase overview==<br />
<br />
(This is probably quite out of date. On 2011-08-08, a few edits were made to bring pieces of it up to date, but the editor doesn't have enough of an overview in head to remove all the parts that aren't current. Edits will continue.)<br />
<br />
OpenSim is already a fairly large and intricate project, so patience is required to start understanding it.<br />
<br />
At the top level, OpenSim code is broken up into seven sections. There's also a bit more detail on the most significant packages within those sections.<br />
<br />
* '''OpenSim'''. This contains the classes which launch the OpenSim region server and handle the console<br />
** The Main() for <tt>OpenSim.exe</tt> can be found in the file <tt>OpenSim/Region/Application/Application.cs</tt>. It does a bunch of configuration checks, but the meat of it is the instantiation of an '''OpenSim''' object, calling its Startup() method (which gets things rolling in separate threads), and then blocking the initial thread by prompting on the main console (using the Prompt() method MainConsole.Instance)<br />
** OpenSim.OpenSim.Startup() comes from an ancestor, OpenSim.Framework.Servers.BaseOpenSimServer; it calls StartupSpecific()<br />
** OpenSim.OpenSim.StartupSpecific() exists, but much of the meat of really getting a region running is found in the base class' method OpenSim.OpenSimBase.StartupSpecific() (and in other versions of StartupSpecific() on up the inheritance hierarchy).<br />
<br />
* '''OpenSim.ApplicationPlugins'''. Each package is an individual application plugin - an application plugin is a modular piece of code that has an effect on the entire region server. See [[RegionModules]] for more details or one of [http://justincc.wordpress.com/2008/05/08/opensim-tech-basics-my-god-its-full-of-modules/ justincc's blogposts] for a higher level overview (which should really be in this wiki).<br />
<br />
* '''OpenSim.Data'''. This is all the low level database manipulation stuff. In here, you'll see packages for SQLite, MySQL and MSSQL (which tends to lag), as well as code for [http://www.hibernate.org/ NHibernate] which will hopefully reduce our reliance on manipulation code for specific databases.<br />
<br />
* '''OpenSim.Framework'''. General framework code used by the rest of OpenSim which is felt to be not specific to a region. <br />
** ''OpenSim.Framework.Communications''. Contains asset and inventory caching code (to cut down on communication with a remote asset or inventory service), and contains CAPS code, a Linden approach to splitting some aspects of the Second Life protocol into independent, secured services. See a [http://mrtopf.de/blog/secondlife/slga-capabilities-explained-technical/ blog post] from Tao for more background on this.<br />
** ''OpenSim.Framework.Servers''. Contains generic server code, such as the base OpenSim server and http servers.<br />
** ''OpenSim.Framework.Stats''. Collects statistical information on OpenSim operations.<br />
<br />
* '''OpenSim.Server''': these are things that are part of the R.O.B.U.S.T. services, including grid servers, avatar servers, asset servers, inventory servers, and the like.<br />
<br />
* '''OpenSim.Region'''. Contains most of the meaty code that it specifically concerned with region manipulation.<br />
** ''OpenSim.Region.ClientStack.LindenUDP''. The code necessary for communicating with clients using the Second Life protocol.<br />
** ''OpenSim.Region.Communications.Local''. Code used for communicating with non-region services (user, asset, grid, etc.) when OpenSim is running in standalone mode.<br />
** ''OpenSim.Region.Communications.OGS1''. Code for communicating with remote UGAI services using the Open Grid Services 1 protocol.<br />
** ''OpenSim.Region.Environment''. A large package containing both the vast majority of the region modules (categorized under modules) and the central scene manipulation code (under Scenes, appropriately enough). Modules here do everything from handling region chat to loading and saving terrain.<br />
** ''OpenSim.Region.Modules''. More region module code. Actually, I'm not too sure why these aren't in the OpenSim.Region.Environment package.<br />
** ''OpenSim.Region.Physics''. General physics framework code and plugins for specific engines (BulletX, ODE, etc). The ODE code is by far the most reliable and stable.<br />
** ''OpenSim.Region.ScriptEngine''. Script engine code that powers the scripts run within OpenSim. Currently there are two engines, the classic [[DotNetEngine]] and the relatively new [[XEngine]].<br />
<br />
* '''OpenSim.Tests'''. Test code. Really, we don't actually have much of this (yet).</div>Rknophttp://opensimulator.org/wiki/Codebase_overviewCodebase overview2011-08-09T00:58:00Z<p>Rknop: /* Codebase overview */</p>
<hr />
<div>__NOTOC__<br />
{{Quicklinks}}<br />
<br /><br />
==Coding restrictions==<br />
<br />
Because OpenSim has to run on both Windows and Mono (usually on Linux or Mac), we are limited to the parts of .net that [http://en.wikipedia.org/wiki/Mono_(software) Mono] supports.<br />
<br />
==Codebase overview==<br />
<br />
(This is probably quite out of date. On 2011-08-08, a few edits were made to bring pieces of it up to date, but the editor doesn't have enough of an overview in head to remove all the parts that aren't current. Edits will continue.)<br />
<br />
OpenSim is already a fairly large and intricate project, so patience is required to start understanding it.<br />
<br />
At the top level, OpenSim code is broken up into seven sections. There's also a bit more detail on the most significant packages within those sections.<br />
<br />
* '''OpenSim'''. This contains the classes which launch the OpenSim region server and handle the console<br />
** The Main() for <tt>OpenSim.exe</tt> can be found in the file <tt>OpenSim/Region/Application/Application.cs</tt><br />
* '''OpenSim.ApplicationPlugins'''. Each package is an individual application plugin - an application plugin is a modular piece of code that has an effect on the entire region server. See [[RegionModules]] for more details or one of [http://justincc.wordpress.com/2008/05/08/opensim-tech-basics-my-god-its-full-of-modules/ justincc's blogposts] for a higher level overview (which should really be in this wiki).<br />
* '''OpenSim.Data'''. This is all the low level database manipulation stuff. In here, you'll see packages for SQLite, MySQL and MSSQL (which tends to lag), as well as code for [http://www.hibernate.org/ NHibernate] which will hopefully reduce our reliance on manipulation code for specific databases.<br />
* '''OpenSim.Framework'''. General framework code used by the rest of OpenSim which is felt to be not specific to a region. <br />
** ''OpenSim.Framework.Communications''. Contains asset and inventory caching code (to cut down on communication with a remote asset or inventory service), and contains CAPS code, a Linden approach to splitting some aspects of the Second Life protocol into independent, secured services. See a [http://mrtopf.de/blog/secondlife/slga-capabilities-explained-technical/ blog post] from Tao for more background on this.<br />
** ''OpenSim.Framework.Servers''. Contains generic server code, such as the base OpenSim server and http servers.<br />
** ''OpenSim.Framework.Stats''. Collects statistical information on OpenSim operations.<br />
* '''OpenSim.Server''': these are things that are part of the R.O.B.U.S.T. services, including grid servers, avatar servers, asset servers, inventory servers, and the like.<br />
* '''OpenSim.Region'''. Contains most of the meaty code that it specifically concerned with region manipulation.<br />
** ''OpenSim.Region.ClientStack.LindenUDP''. The code necessary for communicating with clients using the Second Life protocol.<br />
** ''OpenSim.Region.Communications.Local''. Code used for communicating with non-region services (user, asset, grid, etc.) when OpenSim is running in standalone mode.<br />
** ''OpenSim.Region.Communications.OGS1''. Code for communicating with remote UGAI services using the Open Grid Services 1 protocol.<br />
** ''OpenSim.Region.Environment''. A large package containing both the vast majority of the region modules (categorized under modules) and the central scene manipulation code (under Scenes, appropriately enough). Modules here do everything from handling region chat to loading and saving terrain.<br />
** ''OpenSim.Region.Modules''. More region module code. Actually, I'm not too sure why these aren't in the OpenSim.Region.Environment package.<br />
** ''OpenSim.Region.Physics''. General physics framework code and plugins for specific engines (BulletX, ODE, etc). The ODE code is by far the most reliable and stable.<br />
** ''OpenSim.Region.ScriptEngine''. Script engine code that powers the scripts run within OpenSim. Currently there are two engines, the classic [[DotNetEngine]] and the relatively new [[XEngine]].<br />
* '''OpenSim.Tests'''. Test code. Really, we don't actually have much of this (yet).</div>Rknophttp://opensimulator.org/wiki/Updatelibrary.pyUpdatelibrary.py2011-07-22T01:40:04Z<p>Rknop: </p>
<hr />
<div>A python script for maintaining a server inventory library and associated asset set. See [[Custom Libraries]] for more information.<br />
<br />
You can download the current version from [http://www.sonic.net/~rknop/php/vw/updatelibrary.py http://www.sonic.net/~rknop/php/vw/updatelibrary.py]<br />
<br />
<pre><br />
#!/usr/bin/python<br />
<br />
# updatelibrary.py Version 1.2 by Rob Knop aka Prospero Frobozz (rknop@pobox.com)<br />
<br />
# Written with some reference to genassets.pl by Illuminous Beltran/IBM,<br />
# as found on the OpenSim wiki.<br />
<br />
# Copyright 2011 Rob Knop (aka Prospero Frobozz). All rights reserved.<br />
#<br />
# Redistribution and use in source and binary forms, with or without<br />
# modification, are permitted provided that the following conditions are<br />
# met:<br />
#<br />
# 1. Redistributions of source code must retain the above copyright<br />
# notice, this list of conditions and the following disclaimer.<br />
<br />
# 2. Redistributions in binary form must reproduce the above<br />
# copyright notice, this list of conditions and the following<br />
# disclaimer in the documentation and/or other materials provided<br />
# with the distribution.<br />
#<br />
# THIS SOFTWARE IS PROVIDED BY ROB KNOP ``AS IS'' AND ANY<br />
# EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE<br />
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR<br />
# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL ROB KNOP OR<br />
# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,<br />
# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,<br />
# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR<br />
# PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF<br />
# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING<br />
# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS<br />
# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.<br />
#<br />
# The views and conclusions contained in the software and documentation<br />
# are those of the authors and should not be interpreted as representing<br />
# official policies, either expressed or implied, of Rob Knop.<br />
<br />
<br />
import os, os.path, sys, stat, shutil, re, uuid<br />
import xml.dom, xml.dom.minidom<br />
import traceback<br />
from optparse import OptionParser<br />
<br />
<br />
opensim_library_root_uuid = "00000112-000f-0000-0000-000100bba000"<br />
<br />
# **********************************************************************<br />
<br />
class AssetExistsException(Exception):<br />
def __init__(self, value):<br />
self.value = value<br />
def __str__(self, value):<br />
return repr(value)<br />
<br />
class InventoryException(Exception):<br />
def __init__(self, value):<br />
self.value = value<br />
def __str__(self, value):<br />
return repr(value)<br />
<br />
class NiniException(Exception):<br />
def __init__(self, value):<br />
self.value = value<br />
def __str__(self, value):<br />
return repr(value)<br />
<br />
# **********************************************************************<br />
class NiniSection(object):<br />
def __init__(self, sectionname, keyvalues):<br />
self.sectionname = sectionname<br />
self.keyvalues = keyvalues<br />
<br />
def name(self):<br />
return self.sectionname<br />
<br />
def keyvalues(self):<br />
return self.keyvalues<br />
<br />
def value(self, key):<br />
return self.keyvalues[key]<br />
<br />
def setvalue(self, key, value):<br />
self.keyvalues[key] = value<br />
<br />
# **********************************************************************<br />
<br />
class NiniThing(object):<br />
def __init__(self, keynames, ninitype):<br />
self.keynames = keynames<br />
self.ninitype = ninitype<br />
<br />
def readXML(self, filename):<br />
sections = []<br />
<br />
if not os.path.exists(filename):<br />
sys.stderr.write("WARNING: {0} file {1} doesn't exist. Returning empty list.\n".<br />
format(self.ninitype, filename))<br />
return sections<br />
<br />
xmlblob = xml.dom.minidom.parse(filename)<br />
topelem = xmlblob.documentElement<br />
if topelem.tagName != "Nini":<br />
raise NiniException("Error not a Nini file: {0}".format(filename))<br />
<br />
for sec in topelem.childNodes:<br />
if sec.nodeType == xml.dom.Node.ELEMENT_NODE:<br />
if sec.tagName != 'Section':<br />
raise NiniException("Error {0} file: expecting a 'Section', found a {1}".<br />
format(self.ninitype), sec.tagName)<br />
<br />
item = NiniSection(sec.getAttribute("Name"), dict())<br />
for keyname in self.keynames:<br />
item.setvalue(keyname, "")<br />
<br />
for seckey in sec.childNodes:<br />
if seckey.nodeType == xml.dom.Node.ELEMENT_NODE:<br />
if seckey.tagName != "Key":<br />
raise NiniException("Error reading {0}: expecting a 'Key', found a {1}".<br />
format(self.ninitype, seckey.tagName) )<br />
item.setvalue(seckey.getAttribute("Name"), seckey.getAttribute("Value"))<br />
<br />
sections.append(item)<br />
<br />
xmlblob.unlink()<br />
<br />
return sections<br />
<br />
def writeXML(self, filename, sections):<br />
ofh = open(filename, "w")<br />
<br />
ofh.write("<Nini>\n")<br />
<br />
for item in sections:<br />
ofh.write(" <Section Name=\"{0}\">\n".format(item.name()))<br />
for keyname in self.keynames:<br />
ofh.write(" <Key Name=\"{0}\" Value=\"{1}\" />\n".format(keyname, item.value(keyname)))<br />
ofh.write(" </Section>\n\n")<br />
<br />
ofh.write("</Nini>\n")<br />
ofh.close()<br />
<br />
<br />
# **********************************************************************<br />
<br />
class AssetSet(NiniThing):<br />
def __init__(self):<br />
super(AssetSet,self).__init__( [ "assetID",<br />
"name",<br />
"assetType",<br />
"inventoryType",<br />
"fileName"<br />
],<br />
"Asset Set" )<br />
self.assets = []<br />
<br />
def __iter__(self):<br />
return self.assets.__iter__()<br />
<br />
def addasset(self, uuid, name, asstype, invtype, filename):<br />
ass = NiniSection(filename,<br />
{ 'assetID': uuid,<br />
'name': name,<br />
'assetType': asstype,<br />
'inventoryType': invtype,<br />
'fileName': filename }<br />
)<br />
self.assets.append(ass)<br />
return ass<br />
<br />
def findbyfilename(self, filename):<br />
for ass in self.assets:<br />
if ass.value('fileName') == filename:<br />
return ass<br />
return None<br />
<br />
def findbyuuid(self, uuid):<br />
for ass in self.assets:<br />
if ass.value('assetID') == uuid:<br />
return ass<br />
return None<br />
<br />
def readXML(self, filename):<br />
self.assets = super(AssetSet, self).readXML(filename)<br />
<br />
def writeXML(self, filename):<br />
super(AssetSet, self).writeXML(filename, self.assets)<br />
<br />
# **********************************************************************<br />
<br />
class InvFolders(NiniThing):<br />
def __init__(self):<br />
super(InvFolders, self).__init__( [ "folderID",<br />
"parentFolderID",<br />
"name",<br />
"type"<br />
],<br />
"Inventory Folders" )<br />
self.folders = []<br />
<br />
def __iter__(self):<br />
return self.folders.__iter__()<br />
<br />
def findbyuuid(self, uuid):<br />
for folder in self.folders:<br />
if folder.value('folderID') == uuid:<br />
return folder<br />
return None<br />
<br />
# NOTE -- findbyname only finds the first folder of<br />
# the given name inside the given parent folder.<br />
# It is possible, if perverse, to have more than<br />
# one folder with the same name...<br />
<br />
def findbyname(self, name, parentid):<br />
for folder in self.folders:<br />
if ( ( folder.value('parentFolderID') == parentid ) and<br />
( folder.value('name') == name ) ):<br />
return folder<br />
return None<br />
<br />
def ensureexists(self, path, name, parentid):<br />
if ( ( parentid != opensim_library_root_uuid ) and<br />
( not self.findbyuuid(parentid) ) ):<br />
raise InventoryException("No such parent folder exists: " + str(parentid))<br />
<br />
folder = self.findbyname(name, parentid)<br />
if folder != None:<br />
return folder<br />
<br />
# HACK ALERT -- I want this "type 6" to become whatever the right<br />
# type is for no icon<br />
# http://opensimulator.org/wiki/AssetServer/DeveloperDocs doesn't tell me enough<br />
<br />
folder = NiniSection(path,<br />
{ 'folderID' : uuid.uuid4(),<br />
'parentFolderID' : parentid,<br />
'name' : name,<br />
'type' : -1<br />
}<br />
)<br />
self.folders.append(folder)<br />
<br />
return folder<br />
<br />
<br />
def readXML(self, filename):<br />
self.folders = super(InvFolders, self).readXML(filename)<br />
<br />
def writeXML(self, filename):<br />
super(InvFolders, self).writeXML(filename, self.folders)<br />
<br />
<br />
<br />
# **********************************************************************<br />
<br />
class InvItems(NiniThing):<br />
def __init__(self, folders):<br />
super(InvItems, self).__init__( [ "inventoryID",<br />
"assetID",<br />
"folderID",<br />
"name",<br />
"description",<br />
"assetType",<br />
"inventoryType",<br />
"currentPermissions",<br />
"nextPermissions",<br />
"everyonePermissions",<br />
"basePermissions"<br />
],<br />
"Inventory Items" )<br />
self.folders = folders<br />
self.items = []<br />
<br />
def findbyinvid(self, uuid):<br />
for item in self.items:<br />
if item.value('inventoryID') == uuid:<br />
return item<br />
return None<br />
<br />
# Note -- findbyname only finds the first one of that name<br />
# in that folder. You can have more than one thing of<br />
# the same name in a given folder....<br />
<br />
def findbyname(self, name, folderid):<br />
for item in self.items:<br />
if ( ( item.value('name') == name ) and<br />
( item.value('folderID') == folderid) ):<br />
return item<br />
return None<br />
<br />
def ensureexists(self, path, name, assetid, assettype, invtype, folderid):<br />
if ( ( folderid != opensim_library_root_uuid) and<br />
( not self.folders.findbyuuid(folderid) ) ):<br />
raise InventoryException("No such folder for item: " + str(folderid))<br />
<br />
for item in self.items:<br />
if ( ( item.value('assetID') == assetid ) and<br />
( item.value('folderID') == folderid ) and<br />
( item.value('name') == name ) ):<br />
return item<br />
<br />
item = NiniSection(path,<br />
{ 'inventoryID' : uuid.uuid4(),<br />
'assetID' : assetid,<br />
'folderID' : folderid,<br />
'name' : name,<br />
'description' : "",<br />
'assetType' : assettype,<br />
'inventoryType' : invtype,<br />
'currentPermissions' : "2147483647",<br />
'nextPermissions' : "2147483647",<br />
'everyonePermissions' : "2147483647",<br />
'basePermissions' : "2147483647"<br />
}<br />
)<br />
self.items.append(item)<br />
<br />
return item<br />
<br />
<br />
def readXML(self, filename):<br />
self.items = super(InvItems, self).readXML(filename)<br />
<br />
def writeXML(self, filename):<br />
super(InvItems, self).writeXML(filename, self.items)<br />
<br />
<br />
# **********************************************************************<br />
<br />
class LibraryGenerator(object):<br />
def __init__(self, libname, shortname):<br />
self.libname = libname<br />
self.shortname = shortname<br />
self.asset_dir = os.path.abspath(os.path.join("assets", "{0}AssetSet".format(shortname)))<br />
self.inv_dir = os.path.abspath(os.path.join("inventory", shortname))<br />
self.asset_xmlfile = "{0}AssetSet.xml".format(shortname)<br />
self.folders_xmlfile = "{0}InvFolders.xml".format(shortname)<br />
self.items_xmlfile = "{0}InvItems.xml".format(shortname)<br />
self.skips = []<br />
self.wipeinv = False<br />
<br />
self.matchj2k = re.compile("\.j2k$")<br />
self.matchtxt = re.compile("\.txt$")<br />
self.matchlsl = re.compile("\.lsl$")<br />
self.endsinslash = re.compile("/$")<br />
self.commentline = re.compile("^\s*#")<br />
self.blankline = re.compile("^\s*$")<br />
self.assetlistline = re.compile("^\s*([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})\s*(\d+)\s*(\d+)\s*(.*\S)\s*$")<br />
<br />
def set_skip_patterns(self, skips):<br />
self.skips = skips<br />
<br />
def set_asset_dir(self, asset_dir):<br />
self.asset_dir = asset_dir<br />
<br />
def set_inv_dir(self, inv_dir):<br />
self.inv_dir = inv_dir<br />
<br />
def set_asset_xmlfile(self, asset_xmlfile):<br />
self.asset_xmlfile = asset_xmlfile<br />
<br />
def set_folders_xmlfile(self, folders_xmlfile):<br />
self.folders_xmlfile = folders_xmlfile<br />
<br />
def set_items_xmlfile(self, items_xmlfile):<br />
self.items_xmlfile = items_xmlfile<br />
<br />
def wipe_inventory(self):<br />
self.wipeinv = True<br />
<br />
<br />
def run(self):<br />
# Create our storage for things, and read any current<br />
# XML files if they exist<br />
<br />
self.assets = AssetSet()<br />
self.assets.readXML(os.path.join(self.asset_dir, self.asset_xmlfile))<br />
<br />
self.folders = InvFolders()<br />
if not self.wipeinv:<br />
self.folders.readXML(os.path.join(self.inv_dir, self.folders_xmlfile))<br />
<br />
self.items = InvItems(self.folders)<br />
if not self.wipeinv:<br />
self.items.readXML(os.path.join(self.inv_dir, self.items_xmlfile))<br />
<br />
<br />
# Run the recursive directory processor thingie<br />
<br />
origdir = os.getcwd()<br />
os.chdir(self.asset_dir)<br />
self.process_dir(opensim_library_root_uuid, "", "")<br />
os.chdir(origdir)<br />
<br />
# Write the XML files, saving copies of the old ones out of paranoia<br />
<br />
if os.path.exists(os.path.join(self.asset_dir, self.asset_xmlfile)):<br />
shutil.copy2(os.path.join(self.asset_dir, self.asset_xmlfile),<br />
os.path.join(self.asset_dir, "{0}-old".format(self.asset_xmlfile)))<br />
<br />
self.assets.writeXML(os.path.join(self.asset_dir, self.asset_xmlfile))<br />
<br />
if os.path.exists(os.path.join(self.inv_dir, self.folders_xmlfile)):<br />
shutil.copy2(os.path.join(self.inv_dir, self.folders_xmlfile),<br />
os.path.join(self.inv_dir, "{0}-old".format(self.folders_xmlfile)))<br />
<br />
self.folders.writeXML(os.path.join(self.inv_dir, self.folders_xmlfile))<br />
<br />
if os.path.exists(os.path.join(self.inv_dir, self.items_xmlfile)):<br />
shutil.copy2(os.path.join(self.inv_dir, self.items_xmlfile),<br />
os.path.join(self.inv_dir, "{0}-old".format(self.items_xmlfile)))<br />
<br />
self.items.writeXML(os.path.join(self.inv_dir, self.items_xmlfile))<br />
<br />
<br />
def process_dir(self, parent_uuid, my_name, path):<br />
origdir = os.getcwd()<br />
sys.stderr.write("Processing directory: {0} \n".format(os.path.join(self.asset_dir, path)))<br />
if my_name != "":<br />
os.chdir(my_name)<br />
else:<br />
my_name = self.libname<br />
<br />
# Create the folder XML blob if necessary<br />
<br />
if (path == ""):<br />
curfolder = self.folders.ensureexists(self.libname, my_name, parent_uuid)<br />
else:<br />
curfolder = self.folders.ensureexists(path, my_name, parent_uuid)<br />
my_uuid = curfolder.value("folderID")<br />
<br />
# Walk through this directory and process everything in it<br />
<br />
for fname in os.listdir("."):<br />
statinfo = os.stat(fname)<br />
<br />
doskip = False<br />
for skip in self.skips:<br />
if re.search(skip, fname):<br />
doskip = True<br />
if doskip: continue<br />
<br />
if stat.S_ISDIR(statinfo.st_mode):<br />
self.process_dir(my_uuid, fname, os.path.join(path, fname) )<br />
continue<br />
<br />
fpath = os.path.join(path, fname)<br />
<br />
if fpath == self.asset_xmlfile:<br />
# Ignore the XML file we're working on!<br />
continue<br />
<br />
elif fname == "addassets.lis":<br />
# Ignore the file specifing pre-existing assets to add<br />
# to inventory<br />
continue<br />
<br />
elif self.matchj2k.search(fname):<br />
asset_type = 0<br />
elif self.matchtxt.search(fname):<br />
asset_type = 7<br />
elif self.matchlsl.search(fname):<br />
asset_type = 10<br />
else:<br />
sys.stderr.write("WARNING: Skipping unrecognized file " +<br />
fname + "\n")<br />
continue<br />
<br />
# Strip the extension for aesthetic purposes<br />
# (Right now, that must be .txt, .lsl, or .j2k, so<br />
# we can assume it's 4 characters long.)<br />
<br />
name = fname[0:-4]<br />
<br />
# Create the asset XML blob if necessary<br />
<br />
ass = self.assets.findbyfilename(fpath)<br />
if ass == None:<br />
ass = self.assets.addasset(uuid.uuid4(), name, asset_type,<br />
asset_type, os.path.join(path, fname))<br />
<br />
# Create the inventory XML blob if necessary<br />
<br />
self.items.ensureexists(os.path.join(path, name), name, ass.value('assetID'), <br />
asset_type, asset_type, my_uuid)<br />
<br />
# Add pre-existing assets (to inventory only) from file addassets.lis<br />
<br />
if os.path.exists("addassets.lis"):<br />
asslis = open("addassets.lis")<br />
for line in asslis:<br />
line.rstrip("\r\n")<br />
if self.blankline.search(line) or self.commentline.search(line):<br />
continue<br />
match = self.assetlistline.search(line)<br />
if match == None:<br />
sys.stderr.write("WARNING : error parsing line in {0}\n".<br />
format(os.path.join(path, "addassets.lis")))<br />
sys.stderr.write("Offending line: \"{0}\"\n".format(line))<br />
continue<br />
self.items.ensureexists(os.path.join(path, match.group(4)), match.group(4), <br />
match.group(1), match.group(2), match.group(3), my_uuid)<br />
asslis.close()<br />
<br />
# We're done; restore the CWD to where we started and return<br />
<br />
os.chdir(origdir)<br />
<br />
# **********************************************************************<br />
<br />
def main():<br />
<br />
usage = """<br />
updatelibrary.py -n "Library Name" -s ShortLibName [options]<br />
<br />
Goes through your asset set directory. (See below for how to specify<br />
it, and what the default is.) Finds all .j2k images, .txt files, and<br />
.lsl files in that directory and all subdirectories. Generates an<br />
Asset Set XML file for all of those files. Also generates library<br />
Inventory Folder and Inventory Item XML files for all of those assets,<br />
organized in a folder hierarchy that matches the directory hierarchy.<br />
<br />
Additional assets that already exist in the grid's asset store may be<br />
specified in each directory in a file named "addassets.lis".<br />
<br />
For more documentation, see http://opensimulator.org/wiki/Custom_Libraries<br />
<br />
When done, you will need to manually add your asset directory to the<br />
OpenSim AssetSets.xml file (in "assets" under the OpenSim bin<br />
directory), and your inventory XML files to the Libraries.xml file (in<br />
"inventory" under the OpenSim bin directory).<br />
<br />
Written 2011 by Rob Knop aka Prospero Frobozz. I've only used this on<br />
Linux; I have no idea how well it will function on Windows. If you're<br />
on Windows, I recommend http://www.ubuntu.com<br />
<br />
Run updatelibrary.py --help for option listings<br />
"""<br />
<br />
parser = OptionParser(usage = usage)<br />
<br />
parser.add_option("-n", "--lib-name", action="store", type="string",<br />
dest="libname", default="New Library",<br />
help="The name of your library as it appears in the viewer")<br />
<br />
parser.add_option("-s", "--short-name", action="store", type="string",<br />
dest="shortname", default="NewLibrary",<br />
help="A name without spaces of your library for filename purposes.")<br />
<br />
parser.add_option("-w", "--wipe-inventory", action="store_true", default=False,<br />
dest="wipeinv",<br />
help="Wipe & start over the inventory? (Safe! Use this if you've removed things.)")<br />
<br />
parser.add_option("-a", "--asset-dir", action="store",<br />
type="string", dest="asset_dir",<br />
default=None,<br />
help="Directory where your .j2k, .txt, and .lsl files are, and which will "+<br />
"serve as the Assset Set in the OpenSim library. Defaults to assets/[shortname]AssetSet")<br />
<br />
parser.add_option("-i", "--inv-dir", action="store", type="string",<br />
dest="inv_dir", default=None,<br />
help="Directory in which to put the inventory XML files. Defaults to "+<br />
"inventory/[shortname]")<br />
<br />
parser.add_option("", "--asset-xmlfile", action="store",<br />
type="string", dest="asset_xmlfile", default=None,<br />
help="Name of Asset XML file. Defaults to [shortname]AssetSet.xml")<br />
<br />
parser.add_option("", "--folders-xmlfile", action="store",<br />
type="string", dest="folders_xmlfile", default=None,<br />
help="Name of Inventory Folders XML file. Defaults to [shortname]InvFolders.xml")<br />
<br />
parser.add_option("", "--items-xmlfile", action="store",<br />
type="string", dest="items_xmlfile", default=None,<br />
help="Name of Inventory Folders XML file. Defaults to [shortname]InvItems.xml")<br />
<br />
parser.add_option("", "--skip", action="append", type="string",<br />
dest="skip_patterns",<br />
default=['^\.hg$', '^\.git$', '^\.svn$'],<br />
help="Regex for filenames to not process")<br />
<br />
if len(sys.argv) < 2:<br />
parser.print_usage()<br />
sys.exit(0)<br />
<br />
options, args = parser.parse_args()<br />
<br />
try:<br />
generator = LibraryGenerator(options.libname, options.shortname)<br />
<br />
if options.skip_patterns:<br />
generator.set_skip_patterns(options.skip_patterns)<br />
<br />
if options.asset_dir != None:<br />
generator.set_asset_dir(options.asset_dir)<br />
<br />
if options.inv_dir != None:<br />
generator.set_inv_dir(options.inv_dir)<br />
<br />
if options.asset_xmlfile != None:<br />
generator.set_asset_xmlfile(options.asset_xmlfile)<br />
<br />
if options.folders_xmlfile != None:<br />
generator.set_folders_xmlfile(options.folders_xmlfile)<br />
<br />
if options.items_xmlfile != None:<br />
generator.set_items_xmlfile(options.items_xmlfile)<br />
<br />
if options.wipeinv:<br />
generator.wipe_inventory()<br />
<br />
generator.run()<br />
<br />
except Exception:<br />
print "FAIL"<br />
traceback.print_exc()<br />
sys.exit(20)<br />
<br />
<br />
# **********************************************************************<br />
<br />
if __name__ == "__main__":<br />
sys.exit(main())<br />
</pre></div>Rknophttp://opensimulator.org/wiki/Updatelibrary.pyUpdatelibrary.py2011-07-21T22:03:42Z<p>Rknop: </p>
<hr />
<div>A python script for maintaining a server inventory library and associated asset set. See [[Custom Libraries]] for more information.<br />
<br />
You can download the current version from [http://www.sonic.net/~rknop/php/vw/updatelibrary.py http://www.sonic.net/~rknop/php/vw/updatelibrary.py]<br />
<br />
<pre><br />
#!/usr/bin/python<br />
<br />
# updatelibrary.py Version 1.1 by Rob Knop aka Prospero Frobozz (rknop@pobox.com)<br />
<br />
# Written with some reference to genassets.pl by Illuminous Beltran/IBM,<br />
# as found on the OpenSim wiki.<br />
<br />
# Copyright 2011 Rob Knop (aka Prospero Frobozz). All rights reserved.<br />
#<br />
# Redistribution and use in source and binary forms, with or without<br />
# modification, are permitted provided that the following conditions are<br />
# met:<br />
#<br />
# 1. Redistributions of source code must retain the above copyright<br />
# notice, this list of conditions and the following disclaimer.<br />
<br />
# 2. Redistributions in binary form must reproduce the above<br />
# copyright notice, this list of conditions and the following<br />
# disclaimer in the documentation and/or other materials provided<br />
# with the distribution.<br />
#<br />
# THIS SOFTWARE IS PROVIDED BY ROB KNOP ``AS IS'' AND ANY<br />
# EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE<br />
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR<br />
# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL ROB KNOP OR<br />
# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,<br />
# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,<br />
# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR<br />
# PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF<br />
# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING<br />
# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS<br />
# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.<br />
#<br />
# The views and conclusions contained in the software and documentation<br />
# are those of the authors and should not be interpreted as representing<br />
# official policies, either expressed or implied, of Rob Knop.<br />
<br />
<br />
import os, os.path, sys, stat, shutil, re, uuid<br />
import xml.dom, xml.dom.minidom<br />
import traceback<br />
from optparse import OptionParser<br />
<br />
<br />
opensim_library_root_uuid = "00000112-000f-0000-0000-000100bba000"<br />
<br />
# **********************************************************************<br />
<br />
class AssetExistsException(Exception):<br />
def __init__(self, value):<br />
self.value = value<br />
def __str__(self, value):<br />
return repr(value)<br />
<br />
class InventoryException(Exception):<br />
def __init__(self, value):<br />
self.value = value<br />
def __str__(self, value):<br />
return repr(value)<br />
<br />
class NiniException(Exception):<br />
def __init__(self, value):<br />
self.value = value<br />
def __str__(self, value):<br />
return repr(value)<br />
<br />
# **********************************************************************<br />
class NiniSection(object):<br />
def __init__(self, sectionname, keyvalues):<br />
self.sectionname = sectionname<br />
self.keyvalues = keyvalues<br />
<br />
def name(self):<br />
return self.sectionname<br />
<br />
def keyvalues(self):<br />
return self.keyvalues<br />
<br />
def value(self, key):<br />
return self.keyvalues[key]<br />
<br />
def setvalue(self, key, value):<br />
self.keyvalues[key] = value<br />
<br />
# **********************************************************************<br />
<br />
class NiniThing(object):<br />
def __init__(self, keynames, ninitype):<br />
self.keynames = keynames<br />
self.ninitype = ninitype<br />
<br />
def readXML(self, filename):<br />
sections = []<br />
<br />
if not os.path.exists(filename):<br />
sys.stderr.write("WARNING: {0} file {1} doesn't exist. Returning empty list.\n".<br />
format(self.ninitype, filename))<br />
return sections<br />
<br />
xmlblob = xml.dom.minidom.parse(filename)<br />
topelem = xmlblob.documentElement<br />
if topelem.tagName != "Nini":<br />
raise NiniException("Error not a Nini file: {0}".format(filename))<br />
<br />
for sec in topelem.childNodes:<br />
if sec.nodeType == xml.dom.Node.ELEMENT_NODE:<br />
if sec.tagName != 'Section':<br />
raise NiniException("Error {0} file: expecting a 'Section', found a {1}".<br />
format(self.ninitype), sec.tagName)<br />
<br />
item = NiniSection(sec.getAttribute("Name"), dict())<br />
for keyname in self.keynames:<br />
item.setvalue(keyname, "")<br />
<br />
for seckey in sec.childNodes:<br />
if seckey.nodeType == xml.dom.Node.ELEMENT_NODE:<br />
if seckey.tagName != "Key":<br />
raise NiniException("Error reading {0}: expecting a 'Key', found a {1}".<br />
format(self.ninitype, seckey.tagName) )<br />
item.setvalue(seckey.getAttribute("Name"), seckey.getAttribute("Value"))<br />
<br />
sections.append(item)<br />
<br />
xmlblob.unlink()<br />
<br />
return sections<br />
<br />
def writeXML(self, filename, sections):<br />
ofh = open(filename, "w")<br />
<br />
ofh.write("<Nini>\n")<br />
<br />
for item in sections:<br />
ofh.write(" <Section Name=\"{0}\">\n".format(item.name()))<br />
for keyname in self.keynames:<br />
ofh.write(" <Key Name=\"{0}\" Value=\"{1}\" />\n".format(keyname, item.value(keyname)))<br />
ofh.write(" </Section>\n\n")<br />
<br />
ofh.write("</Nini>\n")<br />
ofh.close()<br />
<br />
<br />
# **********************************************************************<br />
<br />
class AssetSet(NiniThing):<br />
def __init__(self):<br />
super(AssetSet,self).__init__( [ "assetID",<br />
"name",<br />
"assetType",<br />
"inventoryType",<br />
"fileName"<br />
],<br />
"Asset Set" )<br />
self.assets = []<br />
<br />
def __iter__(self):<br />
return self.assets.__iter__()<br />
<br />
def addasset(self, uuid, name, asstype, invtype, filename):<br />
ass = NiniSection(filename,<br />
{ 'assetID': uuid,<br />
'name': name,<br />
'assetType': asstype,<br />
'inventoryType': invtype,<br />
'fileName': filename }<br />
)<br />
self.assets.append(ass)<br />
return ass<br />
<br />
def findbyfilename(self, filename):<br />
for ass in self.assets:<br />
if ass.value('fileName') == filename:<br />
return ass<br />
return None<br />
<br />
def findbyuuid(self, uuid):<br />
for ass in self.assets:<br />
if ass.value('assetID') == uuid:<br />
return ass<br />
return None<br />
<br />
def readXML(self, filename):<br />
self.assets = super(AssetSet, self).readXML(filename)<br />
<br />
def writeXML(self, filename):<br />
super(AssetSet, self).writeXML(filename, self.assets)<br />
<br />
# **********************************************************************<br />
<br />
class InvFolders(NiniThing):<br />
def __init__(self):<br />
super(InvFolders, self).__init__( [ "folderID",<br />
"parentFolderID",<br />
"name",<br />
"type"<br />
],<br />
"Inventory Folders" )<br />
self.folders = []<br />
<br />
def __iter__(self):<br />
return self.folders.__iter__()<br />
<br />
def findbyuuid(self, uuid):<br />
for folder in self.folders:<br />
if folder.value('folderID') == uuid:<br />
return folder<br />
return None<br />
<br />
# NOTE -- findbyname only finds the first folder of<br />
# the given name inside the given parent folder.<br />
# It is possible, if perverse, to have more than<br />
# one folder with the same name...<br />
<br />
def findbyname(self, name, parentid):<br />
for folder in self.folders:<br />
if ( ( folder.value('parentFolderID') == parentid ) and<br />
( folder.value('name') == name ) ):<br />
return folder<br />
return None<br />
<br />
def ensureexists(self, path, name, parentid):<br />
if ( ( parentid != opensim_library_root_uuid ) and<br />
( not self.findbyuuid(parentid) ) ):<br />
raise InventoryException("No such parent folder exists: " + str(parentid))<br />
<br />
folder = self.findbyname(name, parentid)<br />
if folder != None:<br />
return folder<br />
<br />
# HACK ALERT -- I want this "type 6" to become whatever the right<br />
# type is for no icon<br />
# http://opensimulator.org/wiki/AssetServer/DeveloperDocs doesn't tell me enough<br />
<br />
folder = NiniSection(path,<br />
{ 'folderID' : uuid.uuid4(),<br />
'parentFolderID' : parentid,<br />
'name' : name,<br />
'type' : -1<br />
}<br />
)<br />
self.folders.append(folder)<br />
<br />
return folder<br />
<br />
<br />
def readXML(self, filename):<br />
self.folders = super(InvFolders, self).readXML(filename)<br />
<br />
def writeXML(self, filename):<br />
super(InvFolders, self).writeXML(filename, self.folders)<br />
<br />
<br />
<br />
# **********************************************************************<br />
<br />
class InvItems(NiniThing):<br />
def __init__(self, folders):<br />
super(InvItems, self).__init__( [ "inventoryID",<br />
"assetID",<br />
"folderID",<br />
"name",<br />
"description",<br />
"assetType",<br />
"inventoryType",<br />
"currentPermissions",<br />
"nextPermissions",<br />
"everyonePermissions",<br />
"basePermissions"<br />
],<br />
"Inventory Items" )<br />
self.folders = folders<br />
self.items = []<br />
<br />
def findbyinvid(self, uuid):<br />
for item in self.items:<br />
if item.value('inventoryID') == uuid:<br />
return item<br />
return None<br />
<br />
# Note -- findbyname only finds the first one of that name<br />
# in that folder. You can have more than one thing of<br />
# the same name in a given folder....<br />
<br />
def findbyname(self, name, folderid):<br />
for item in self.items:<br />
if ( ( item.value('name') == name ) and<br />
( item.value('folderID') == folderid) ):<br />
return item<br />
return None<br />
<br />
def ensureexists(self, path, name, assetid, assettype, invtype, folderid):<br />
if ( ( folderid != opensim_library_root_uuid) and<br />
( not self.folders.findbyuuid(folderid) ) ):<br />
raise InventoryException("No such folder for item: " + str(folderid))<br />
<br />
for item in self.items:<br />
if ( ( item.value('assetID') == assetid ) and<br />
( item.value('folderID') == folderid ) and<br />
( item.value('name') == name ) ):<br />
return item<br />
<br />
item = NiniSection(path,<br />
{ 'inventoryID' : uuid.uuid4(),<br />
'assetID' : assetid,<br />
'folderID' : folderid,<br />
'name' : name,<br />
'description' : "",<br />
'assetType' : assettype,<br />
'inventoryType' : invtype,<br />
'currentPermissions' : "2147483647",<br />
'nextPermissions' : "2147483647",<br />
'everyonePermissions' : "2147483647",<br />
'basePermissions' : "2147483647"<br />
}<br />
)<br />
self.items.append(item)<br />
<br />
return item<br />
<br />
<br />
def readXML(self, filename):<br />
self.items = super(InvItems, self).readXML(filename)<br />
<br />
def writeXML(self, filename):<br />
super(InvItems, self).writeXML(filename, self.items)<br />
<br />
<br />
# **********************************************************************<br />
<br />
class LibraryGenerator(object):<br />
def __init__(self, libname, shortname):<br />
self.libname = libname<br />
self.shortname = shortname<br />
self.asset_dir = os.path.abspath(os.path.join("assets", "{0}AssetSet".format(shortname)))<br />
self.inv_dir = os.path.abspath(os.path.join("inventory", shortname))<br />
self.asset_xmlfile = "{0}AssetSet.xml".format(shortname)<br />
self.folders_xmlfile = "{0}InvFolders.xml".format(shortname)<br />
self.items_xmlfile = "{0}InvItems.xml".format(shortname)<br />
self.skips = []<br />
<br />
self.matchj2k = re.compile("\.j2k$")<br />
self.matchtxt = re.compile("\.txt$")<br />
self.matchlsl = re.compile("\.lsl$")<br />
self.endsinslash = re.compile("/$")<br />
self.commentline = re.compile("^\s*#")<br />
self.blankline = re.compile("^\s*$")<br />
self.assetlistline = re.compile("^\s*([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})\s*(\d+)\s*(\d+)\s*(.*\S)\s*$")<br />
<br />
def set_skip_patterns(self, skips):<br />
self.skips = skips<br />
<br />
def set_asset_dir(self, asset_dir):<br />
self.asset_dir = asset_dir<br />
<br />
def set_inv_dir(self, inv_dir):<br />
self.inv_dir = inv_dir<br />
<br />
def set_asset_xmlfile(self, asset_xmlfile):<br />
self.asset_xmlfile = asset_xmlfile<br />
<br />
def set_folders_xmlfile(self, folders_xmlfile):<br />
self.folders_xmlfile = folders_xmlfile<br />
<br />
def set_items_xmlfile(self, items_xmlfile):<br />
self.items_xmlfile = items_xmlfile<br />
<br />
<br />
def run(self):<br />
# Create our storage for things, and read any current<br />
# XML files if they exist<br />
<br />
self.assets = AssetSet()<br />
self.assets.readXML(os.path.join(self.asset_dir, self.asset_xmlfile))<br />
<br />
self.folders = InvFolders()<br />
self.folders.readXML(os.path.join(self.inv_dir, self.folders_xmlfile))<br />
<br />
self.items = InvItems(self.folders)<br />
self.items.readXML(os.path.join(self.inv_dir, self.items_xmlfile))<br />
<br />
<br />
# Run the recursive directory processor thingie<br />
<br />
origdir = os.getcwd()<br />
os.chdir(self.asset_dir)<br />
self.process_dir(opensim_library_root_uuid, "", "")<br />
os.chdir(origdir)<br />
<br />
# Write the XML files, saving copies of the old ones out of paranoia<br />
<br />
if os.path.exists(os.path.join(self.asset_dir, self.asset_xmlfile)):<br />
shutil.copy2(os.path.join(self.asset_dir, self.asset_xmlfile),<br />
os.path.join(self.asset_dir, "{0}-old".format(self.asset_xmlfile)))<br />
<br />
self.assets.writeXML(os.path.join(self.asset_dir, self.asset_xmlfile))<br />
<br />
if os.path.exists(os.path.join(self.inv_dir, self.folders_xmlfile)):<br />
shutil.copy2(os.path.join(self.inv_dir, self.folders_xmlfile),<br />
os.path.join(self.inv_dir, "{0}-old".format(self.folders_xmlfile)))<br />
<br />
self.folders.writeXML(os.path.join(self.inv_dir, self.folders_xmlfile))<br />
<br />
if os.path.exists(os.path.join(self.inv_dir, self.items_xmlfile)):<br />
shutil.copy2(os.path.join(self.inv_dir, self.items_xmlfile),<br />
os.path.join(self.inv_dir, "{0}-old".format(self.items_xmlfile)))<br />
<br />
self.items.writeXML(os.path.join(self.inv_dir, self.items_xmlfile))<br />
<br />
<br />
def process_dir(self, parent_uuid, my_name, path):<br />
origdir = os.getcwd()<br />
sys.stderr.write("Processing directory: {0} \n".format(os.path.join(self.asset_dir, path)))<br />
if my_name != "":<br />
os.chdir(my_name)<br />
else:<br />
my_name = self.libname<br />
<br />
# Create the folder XML blob if necessary<br />
<br />
if (path == ""):<br />
curfolder = self.folders.ensureexists(self.libname, my_name, parent_uuid)<br />
else:<br />
curfolder = self.folders.ensureexists(path, my_name, parent_uuid)<br />
my_uuid = curfolder.value("folderID")<br />
<br />
# Walk through this directory and process everything in it<br />
<br />
for fname in os.listdir("."):<br />
statinfo = os.stat(fname)<br />
<br />
doskip = False<br />
for skip in self.skips:<br />
if re.search(skip, fname):<br />
doskip = True<br />
if doskip: continue<br />
<br />
if stat.S_ISDIR(statinfo.st_mode):<br />
self.process_dir(my_uuid, fname, os.path.join(path, fname) )<br />
continue<br />
<br />
fpath = os.path.join(path, fname)<br />
<br />
if fpath == self.asset_xmlfile:<br />
# Ignore the XML file we're working on!<br />
continue<br />
<br />
elif fname == "addassets.lis":<br />
# Ignore the file specifing pre-existing assets to add<br />
# to inventory<br />
continue<br />
<br />
elif self.matchj2k.search(fname):<br />
asset_type = 0<br />
elif self.matchtxt.search(fname):<br />
asset_type = 7<br />
elif self.matchlsl.search(fname):<br />
asset_type = 10<br />
else:<br />
sys.stderr.write("WARNING: Skipping unrecognized file " +<br />
fname + "\n")<br />
continue<br />
<br />
# Strip the extension for aesthetic purposes<br />
# (Right now, that must be .txt, .lsl, or .j2k, so<br />
# we can assume it's 4 characters long.)<br />
<br />
name = fname[0:-4]<br />
<br />
# Create the asset XML blob if necessary<br />
<br />
ass = self.assets.findbyfilename(fpath)<br />
if ass == None:<br />
ass = self.assets.addasset(uuid.uuid4(), name, asset_type,<br />
asset_type, os.path.join(path, fname))<br />
<br />
# Create the inventory XML blob if necessary<br />
<br />
self.items.ensureexists(os.path.join(path, name), name, ass.value('assetID'), <br />
asset_type, asset_type, my_uuid)<br />
<br />
# Add pre-existing assets (to inventory only) from file addassets.lis<br />
<br />
if os.path.exists("addassets.lis"):<br />
asslis = open("addassets.lis")<br />
for line in asslis:<br />
line.rstrip("\r\n")<br />
if self.blankline.search(line) or self.commentline.search(line):<br />
continue<br />
match = self.assetlistline.search(line)<br />
if match == None:<br />
sys.stderr.write("WARNING : error parsing line in {0}\n".<br />
format(os.path.join(path, "addassets.lis")))<br />
sys.stderr.write("Offending line: \"{0}\"\n".format(line))<br />
continue<br />
self.items.ensureexists(os.path.join(path, match.group(4)), match.group(4), <br />
match.group(1), match.group(2), match.group(3), my_uuid)<br />
asslis.close()<br />
<br />
# We're done; restore the CWD to where we started and return<br />
<br />
os.chdir(origdir)<br />
<br />
# **********************************************************************<br />
<br />
def main():<br />
<br />
usage = """<br />
updatelibrary.py -n "Library Name" -s ShortLibName [options]<br />
<br />
Goes through your asset set directory. (See below for how to specify<br />
it, and what the default is.) Finds all .j2k images, .txt files, and<br />
.lsl files in that directory and all subdirectories. Generates an<br />
Asset Set XML file for all of those files. Also generates library<br />
Inventory Folder and Inventory Item XML files for all of those assets,<br />
organized in a folder hierarchy that matches the directory hierarchy.<br />
<br />
Additional assets that already exist in the grid's asset store may be<br />
specified in each directory in a file named "addassets.lis".<br />
<br />
For more documentation, see http://opensimulator.org/wiki/Custom_Libraries<br />
<br />
When done, you will need to manually add your asset directory to the<br />
OpenSim AssetSets.xml file (in "assets" under the OpenSim bin<br />
directory), and your inventory XML files to the Libraries.xml file (in<br />
"inventory" under the OpenSim bin directory).<br />
<br />
Written 2011 by Rob Knop aka Prospero Frobozz. I've only used this on<br />
Linux; I have no idea how well it will function on Windows. If you're<br />
on Windows, I recommend http://www.ubuntu.com<br />
<br />
Run updatelibrary.py --help for option listings<br />
"""<br />
<br />
parser = OptionParser(usage = usage)<br />
<br />
parser.add_option("-n", "--lib-name", action="store", type="string",<br />
dest="libname", default="New Library",<br />
help="The name of your library as it appears in the viewer")<br />
<br />
parser.add_option("-s", "--short-name", action="store", type="string",<br />
dest="shortname", default="NewLibrary",<br />
help="A name without spaces of your library for filename purposes.")<br />
<br />
parser.add_option("-a", "--asset-dir", action="store",<br />
type="string", dest="asset_dir",<br />
default=None,<br />
help="Directory where your .j2k, .txt, and .lsl files are, and which will "+<br />
"serve as the Assset Set in the OpenSim library. Defaults to assets/[shortname]AssetSet")<br />
<br />
parser.add_option("-i", "--inv-dir", action="store", type="string",<br />
dest="inv_dir", default=None,<br />
help="Directory in which to put the inventory XML files. Defaults to "+<br />
"inventory/[shortname]")<br />
<br />
parser.add_option("", "--asset-xmlfile", action="store",<br />
type="string", dest="asset_xmlfile", default=None,<br />
help="Name of Asset XML file. Defaults to [shortname]AssetSet.xml")<br />
<br />
parser.add_option("", "--folders-xmlfile", action="store",<br />
type="string", dest="folders_xmlfile", default=None,<br />
help="Name of Inventory Folders XML file. Defaults to [shortname]InvFolders.xml")<br />
<br />
parser.add_option("", "--items-xmlfile", action="store",<br />
type="string", dest="items_xmlfile", default=None,<br />
help="Name of Inventory Folders XML file. Defaults to [shortname]InvItems.xml")<br />
<br />
parser.add_option("", "--skip", action="append", type="string",<br />
dest="skip_patterns",<br />
default=['^\.hg$', '^\.git$', '^\.svn$'],<br />
help="Regex for filenames to not process")<br />
<br />
if len(sys.argv) < 2:<br />
parser.print_usage()<br />
sys.exit(0)<br />
<br />
options, args = parser.parse_args()<br />
<br />
try:<br />
generator = LibraryGenerator(options.libname, options.shortname)<br />
<br />
if options.skip_patterns:<br />
generator.set_skip_patterns(options.skip_patterns)<br />
<br />
if options.asset_dir != None:<br />
generator.set_asset_dir(options.asset_dir)<br />
<br />
if options.inv_dir != None:<br />
generator.set_inv_dir(options.inv_dir)<br />
<br />
if options.asset_xmlfile != None:<br />
generator.set_asset_xmlfile(options.asset_xmlfile)<br />
<br />
if options.folders_xmlfile != None:<br />
generator.set_folders_xmlfile(options.folders_xmlfile)<br />
<br />
if options.items_xmlfile != None:<br />
generator.set_items_xmlfile(options.items_xmlfile)<br />
<br />
generator.run()<br />
<br />
except Exception:<br />
print "FAIL"<br />
traceback.print_exc()<br />
sys.exit(20)<br />
<br />
<br />
# **********************************************************************<br />
<br />
if __name__ == "__main__":<br />
sys.exit(main())<br />
</pre></div>Rknophttp://opensimulator.org/wiki/Updatelibrary.pyUpdatelibrary.py2011-07-16T02:22:29Z<p>Rknop: New page: A python script for maintaining a server inventory library and associated asset set. See Custom Libraries for more information. You can download the current version from [http://www....</p>
<hr />
<div>A python script for maintaining a server inventory library and associated asset set. See [[Custom Libraries]] for more information.<br />
<br />
You can download the current version from [http://www.sonic.net/~rknop/php/vw/updatelibrary.py http://www.sonic.net/~rknop/php/vw/updatelibrary.py]<br />
<br />
<pre><br />
#!/usr/bin/python<br />
<br />
# updatelibrary.py Version 1.0 by Rob Knop aka Prospero Frobozz (rknop@pobox.com)<br />
<br />
# Written with some reference to genassets.pl by Illuminous Beltran/IBM,<br />
# as found on the OpenSim wiki.<br />
<br />
# Copyright 2011 Rob Knop (aka Prospero Frobozz). All rights reserved.<br />
#<br />
# Redistribution and use in source and binary forms, with or without<br />
# modification, are permitted provided that the following conditions are<br />
# met:<br />
#<br />
# 1. Redistributions of source code must retain the above copyright<br />
# notice, this list of conditions and the following disclaimer.<br />
<br />
# 2. Redistributions in binary form must reproduce the above<br />
# copyright notice, this list of conditions and the following<br />
# disclaimer in the documentation and/or other materials provided<br />
# with the distribution.<br />
#<br />
# THIS SOFTWARE IS PROVIDED BY ROB KNOP ``AS IS'' AND ANY<br />
# EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE<br />
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR<br />
# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL ROB KNOP OR<br />
# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,<br />
# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,<br />
# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR<br />
# PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF<br />
# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING<br />
# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS<br />
# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.<br />
#<br />
# The views and conclusions contained in the software and documentation<br />
# are those of the authors and should not be interpreted as representing<br />
# official policies, either expressed or implied, of Rob Knop.<br />
<br />
<br />
import os, os.path, sys, stat, shutil, re, uuid<br />
import xml.dom, xml.dom.minidom<br />
import traceback<br />
from optparse import OptionParser<br />
<br />
<br />
opensim_library_root_uuid = "00000112-000f-0000-0000-000100bba000"<br />
<br />
# **********************************************************************<br />
<br />
class AssetExistsException(Exception):<br />
def __init__(self, value):<br />
self.value = value<br />
def __str__(self, value):<br />
return repr(value)<br />
<br />
class InventoryException(Exception):<br />
def __init__(self, value):<br />
self.value = value<br />
def __str__(self, value):<br />
return repr(value)<br />
<br />
class NiniException(Exception):<br />
def __init__(self, value):<br />
self.value = value<br />
def __str__(self, value):<br />
return repr(value)<br />
<br />
# **********************************************************************<br />
<br />
class NiniThing(object):<br />
def __init__(self, keynames, ninitype):<br />
self.keynames = keynames<br />
self.ninitype = ninitype<br />
<br />
def readXML(self, filename):<br />
sections = []<br />
<br />
if not os.path.exists(filename):<br />
sys.stderr.write("WARNING: {0} file {1} doesn't exist. Returning empty list.\n".<br />
format(self.ninitype, filename))<br />
return sections<br />
<br />
xmlblob = xml.dom.minidom.parse(filename)<br />
topelem = xmlblob.documentElement<br />
if topelem.tagName != "Nini":<br />
raise NiniException("Error not a Nini file: {0}".format(filename))<br />
<br />
for sec in topelem.childNodes:<br />
if sec.nodeType == xml.dom.Node.ELEMENT_NODE:<br />
if sec.tagName != 'Section':<br />
raise NiniException("Error {0} file: expecting a 'Section', found a {1}".<br />
format(self.ninitype), sec.tagName)<br />
<br />
item = dict()<br />
for keyname in self.keynames:<br />
item[keyname] = ""<br />
<br />
for seckey in sec.childNodes:<br />
if seckey.nodeType == xml.dom.Node.ELEMENT_NODE:<br />
if seckey.tagName != "Key":<br />
raise NiniException("Error reading {0}: expecting a 'Key', found a {1}".<br />
format(self.ninitype, seckey.tagName) )<br />
item[seckey.getAttribute("Name")] = seckey.getAttribute("Value")<br />
<br />
sections.append(item)<br />
<br />
xmlblob.unlink()<br />
<br />
return sections<br />
<br />
def writeXML(self, filename, sections):<br />
ofh = open(filename, "w")<br />
<br />
ofh.write("<Nini>\n")<br />
<br />
for item in sections:<br />
ofh.write(" <Section Name=\"{0}\">\n".format(item["name"]))<br />
for keyname in self.keynames:<br />
ofh.write(" <Key Name=\"{0}\" Value=\"{1}\" />\n".format(keyname, item[keyname]))<br />
ofh.write(" </Section>\n\n")<br />
<br />
ofh.write("</Nini>\n")<br />
ofh.close()<br />
<br />
<br />
# **********************************************************************<br />
<br />
class AssetSet(NiniThing):<br />
def __init__(self):<br />
super(AssetSet,self).__init__( [ "assetID",<br />
"name",<br />
"assetType",<br />
"inventoryType",<br />
"fileName"<br />
],<br />
"Asset Set" )<br />
self.assets = []<br />
<br />
def __iter__(self):<br />
return self.assets.__iter__()<br />
<br />
def addasset(self, uuid, name, asstype, invtype, filename):<br />
ass = { 'assetID': uuid,<br />
'name': name,<br />
'assetType': asstype,<br />
'inventoryType': invtype,<br />
'fileName': filename }<br />
self.assets.append(ass)<br />
return ass<br />
<br />
def findbyfilename(self, filename):<br />
for ass in self.assets:<br />
if ass['fileName'] == filename:<br />
return ass<br />
return None<br />
<br />
def findbyuuid(self, uuid):<br />
for ass in self.assets:<br />
if ass['assetID'] == uuid:<br />
return ass<br />
return None<br />
<br />
def readXML(self, filename):<br />
self.assets = super(AssetSet, self).readXML(filename)<br />
<br />
def writeXML(self, filename):<br />
super(AssetSet, self).writeXML(filename, self.assets)<br />
<br />
# **********************************************************************<br />
<br />
class InvFolders(NiniThing):<br />
def __init__(self):<br />
super(InvFolders, self).__init__( [ "folderID",<br />
"parentFolderID",<br />
"name",<br />
"type"<br />
],<br />
"Inventory Folders" )<br />
self.folders = []<br />
<br />
def __iter__(self):<br />
return self.folders.__iter__()<br />
<br />
def findbyuuid(self, uuid):<br />
for folder in self.folders:<br />
if folder['folderID'] == uuid:<br />
return folder<br />
return None<br />
<br />
# NOTE -- findbyname only finds the first folder of<br />
# the given name inside the given parent folder.<br />
# It is possible, if perverse, to have more than<br />
# one folder with the same name...<br />
<br />
def findbyname(self, name, parentid):<br />
for folder in self.folders:<br />
if ( ( folder['parentFolderID'] == parentid ) and<br />
( folder['name'] == name ) ):<br />
return folder<br />
return None<br />
<br />
def ensureexists(self, name, parentid):<br />
if ( ( parentid != opensim_library_root_uuid ) and<br />
( not self.findbyuuid(parentid) ) ):<br />
raise InventoryException("No such parent folder exists: " + str(parentid))<br />
<br />
folder = self.findbyname(name, parentid)<br />
if folder != None:<br />
return folder<br />
<br />
# HACK ALERT -- I want this "type 6" to become whatever the right<br />
# type is for no icon<br />
# http://opensimulator.org/wiki/AssetServer/DeveloperDocs doesn't tell me enough<br />
<br />
folder = { 'folderID' : uuid.uuid4(),<br />
'parentFolderID' : parentid,<br />
'name' : name,<br />
'type' : 6<br />
}<br />
self.folders.append(folder)<br />
<br />
return folder<br />
<br />
<br />
def readXML(self, filename):<br />
self.folders = super(InvFolders, self).readXML(filename)<br />
<br />
def writeXML(self, filename):<br />
super(InvFolders, self).writeXML(filename, self.folders)<br />
<br />
<br />
<br />
# **********************************************************************<br />
<br />
class InvItems(NiniThing):<br />
def __init__(self, folders):<br />
super(InvItems, self).__init__( [ "inventoryID",<br />
"assetID",<br />
"folderID",<br />
"name",<br />
"description",<br />
"assetType",<br />
"inventoryType",<br />
"currentPermissions",<br />
"nextPermissions",<br />
"everyonePermissions",<br />
"basePermissions"<br />
],<br />
"Inventory Items" )<br />
self.folders = folders<br />
self.items = []<br />
<br />
def findbyinvid(self, uuid):<br />
for item in self.items:<br />
if item['inventoryID'] == uuid:<br />
return item<br />
return None<br />
<br />
# Note -- findbyname only finds the first one of that name<br />
# in that folder. You can have more than one thing of<br />
# the same name in a given folder....<br />
<br />
def findbyname(self, name, folderid):<br />
for item in self.items:<br />
if ( ( item['name'] == name ) and<br />
( item['folderID'] == folderid) ):<br />
return item<br />
return None<br />
<br />
def ensureexists(self, name, assetid, assettype, invtype, folderid):<br />
if ( ( folderid != opensim_library_root_uuid) and<br />
( not self.folders.findbyuuid(folderid) ) ):<br />
raise InventoryException("No such folder for item: " + str(folderid))<br />
<br />
for item in self.items:<br />
if ( ( item['assetID'] == assetid ) and<br />
( item['folderID'] == folderid ) and<br />
( item['name'] == name ) ):<br />
return item<br />
<br />
item = { 'inventoryID' : uuid.uuid4(),<br />
'assetID' : assetid,<br />
'folderID' : folderid,<br />
'name' : name,<br />
'description' : "",<br />
'assetType' : assettype,<br />
'inventoryType' : invtype,<br />
'currentPermissions' : "2147483647",<br />
'nextPermissions' : "2147483647",<br />
'everyonePermissions' : "2147483647",<br />
'basePermissions' : "2147483647"<br />
}<br />
self.items.append(item)<br />
<br />
return item<br />
<br />
<br />
def readXML(self, filename):<br />
self.items = super(InvItems, self).readXML(filename)<br />
<br />
def writeXML(self, filename):<br />
super(InvItems, self).writeXML(filename, self.items)<br />
<br />
<br />
# **********************************************************************<br />
<br />
class LibraryGenerator(object):<br />
def __init__(self, libname, shortname):<br />
self.libname = libname<br />
self.shortname = shortname<br />
self.asset_dir = os.path.abspath(os.path.join("assets", "{0}AssetSet".format(shortname)))<br />
self.inv_dir = os.path.abspath(os.path.join("inventory", shortname))<br />
self.asset_xmlfile = "{0}AssetSet.xml".format(shortname)<br />
self.folders_xmlfile = "{0}InvFolders.xml".format(shortname)<br />
self.items_xmlfile = "{0}InvItems.xml".format(shortname)<br />
self.skips = []<br />
<br />
self.matchj2k = re.compile("\.j2k$")<br />
self.matchtxt = re.compile("\.txt$")<br />
self.matchlsl = re.compile("\.lsl$")<br />
self.endsinslash = re.compile("/$")<br />
self.commentline = re.compile("^\s*#")<br />
self.blankline = re.compile("^\s*$")<br />
self.assetlistline = re.compile("^\s*([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})\s*(\d+)\s*(\d+)\s*(.*\S)\s*$")<br />
<br />
def set_skip_patterns(self, skips):<br />
self.skips = skips<br />
<br />
def set_asset_dir(self, asset_dir):<br />
self.asset_dir = asset_dir<br />
<br />
def set_inv_dir(self, inv_dir):<br />
self.inv_dir = inv_dir<br />
<br />
def set_asset_xmlfile(self, asset_xmlfile):<br />
self.asset_xmlfile = asset_xmlfile<br />
<br />
def set_folders_xmlfile(self, folders_xmlfile):<br />
self.folders_xmlfile = folders_xmlfile<br />
<br />
def set_items_xmlfile(self, items_xmlfile):<br />
self.items_xmlfile = items_xmlfile<br />
<br />
<br />
def run(self):<br />
# Create our storage for things, and read any current<br />
# XML files if they exist<br />
<br />
self.assets = AssetSet()<br />
self.assets.readXML(os.path.join(self.asset_dir, self.asset_xmlfile))<br />
<br />
self.folders = InvFolders()<br />
self.folders.readXML(os.path.join(self.inv_dir, self.folders_xmlfile))<br />
<br />
self.items = InvItems(self.folders)<br />
self.items.readXML(os.path.join(self.inv_dir, self.items_xmlfile))<br />
<br />
<br />
# Run the recursive directory processor thingie<br />
<br />
origdir = os.getcwd()<br />
os.chdir(self.asset_dir)<br />
self.process_dir(opensim_library_root_uuid, "", "")<br />
os.chdir(origdir)<br />
<br />
# Write the XML files, saving copies of the old ones out of paranoia<br />
<br />
if os.path.exists(os.path.join(self.asset_dir, self.asset_xmlfile)):<br />
shutil.copy2(os.path.join(self.asset_dir, self.asset_xmlfile),<br />
os.path.join(self.asset_dir, "{0}-old".format(self.asset_xmlfile)))<br />
<br />
self.assets.writeXML(os.path.join(self.asset_dir, self.asset_xmlfile))<br />
<br />
if os.path.exists(os.path.join(self.inv_dir, self.folders_xmlfile)):<br />
shutil.copy2(os.path.join(self.inv_dir, self.folders_xmlfile),<br />
os.path.join(self.inv_dir, "{0}-old".format(self.folders_xmlfile)))<br />
<br />
self.folders.writeXML(os.path.join(self.inv_dir, self.folders_xmlfile))<br />
<br />
if os.path.exists(os.path.join(self.inv_dir, self.items_xmlfile)):<br />
shutil.copy2(os.path.join(self.inv_dir, self.items_xmlfile),<br />
os.path.join(self.inv_dir, "{0}-old".format(self.items_xmlfile)))<br />
<br />
self.items.writeXML(os.path.join(self.inv_dir, self.items_xmlfile))<br />
<br />
<br />
def process_dir(self, parent_uuid, my_name, path):<br />
origdir = os.getcwd()<br />
sys.stderr.write("Processing directory: {0} \n".format(os.path.join(self.asset_dir, path)))<br />
if my_name != "":<br />
os.chdir(my_name)<br />
else:<br />
my_name = self.libname<br />
<br />
# Create the folder XML blob if necessary<br />
<br />
curfolder = self.folders.ensureexists(my_name, parent_uuid)<br />
my_uuid = curfolder["folderID"]<br />
<br />
# Walk through this directory and process everything in it<br />
<br />
for fname in os.listdir("."):<br />
statinfo = os.stat(fname)<br />
<br />
doskip = False<br />
for skip in self.skips:<br />
if re.search(skip, fname):<br />
doskip = True<br />
if doskip: continue<br />
<br />
if stat.S_ISDIR(statinfo.st_mode):<br />
self.process_dir(my_uuid, fname, os.path.join(path, fname) )<br />
continue<br />
<br />
fpath = os.path.join(path, fname)<br />
<br />
if fpath == self.asset_xmlfile:<br />
# Ignore the XML file we're working on!<br />
continue<br />
<br />
elif fname == "addassets.lis":<br />
# Ignore the file specifing pre-existing assets to add<br />
# to inventory<br />
continue<br />
<br />
elif self.matchj2k.search(fname):<br />
asset_type = 0<br />
elif self.matchtxt.search(fname):<br />
asset_type = 7<br />
elif self.matchlsl.search(fname):<br />
asset_type = 10<br />
else:<br />
sys.stderr.write("WARNING: Skipping unrecognized file " +<br />
fname + "\n")<br />
continue<br />
<br />
# Strip the extension for aesthetic purposes<br />
# (Right now, that must be .txt, .lsl, or .j2k, so<br />
# we can assume it's 4 characters long.)<br />
<br />
name = fname[0:-4]<br />
<br />
# Create the asset XML blob if necessary<br />
<br />
ass = self.assets.findbyfilename(fpath)<br />
if ass == None:<br />
ass = self.assets.addasset(uuid.uuid4(), name, asset_type,<br />
asset_type, os.path.join(path, fname))<br />
<br />
# Create the inventory XML blob if necessary<br />
<br />
self.items.ensureexists(name, ass['assetID'], asset_type, asset_type, my_uuid)<br />
<br />
# Add pre-existing assets (to inventory only) from file addassets.lis<br />
<br />
if os.path.exists("addassets.lis"):<br />
asslis = open("addassets.lis")<br />
for line in asslis:<br />
line.rstrip("\r\n")<br />
if self.blankline.search(line) or self.commentline.search(line):<br />
continue<br />
match = self.assetlistline.search(line)<br />
if match == None:<br />
sys.stderr.write("WARNING : error parsing line in {0}\n".<br />
format(os.path.join(path, "addassets.lis")))<br />
sys.stderr.write("Offending line: \"{0}\"\n".format(line))<br />
continue<br />
self.items.ensureexists(match.group(4), match.group(1), match.group(2), match.group(3), my_uuid)<br />
asslis.close()<br />
<br />
# We're done; restore the CWD to where we started and return<br />
<br />
os.chdir(origdir)<br />
<br />
# **********************************************************************<br />
<br />
def main():<br />
<br />
usage = """<br />
updatelibrary.py -n "Library Name" -s ShortLibName [options]<br />
<br />
Goes through your asset set directory. (See below for how to specify<br />
it, and what the default is.) Finds all .j2k images, .txt files, and<br />
.lsl files in that directory and all subdirectories. Generates an<br />
Asset Set XML file for all of those files. Also generates library<br />
Inventory Folder and Inventory Item XML files for all of those assets,<br />
organized in a folder hierarchy that matches the directory hierarchy.<br />
<br />
Additional assets that already exist in the grid's asset store may be<br />
specified in each directory in a file named "addassets.lis".<br />
<br />
For more documentation, see http://opensimulator.org/wiki/Custom_Libraries<br />
<br />
When done, you will need to manually add your asset directory to the<br />
OpenSim AssetSets.xml file (in "assets" under the OpenSim bin<br />
directory), and your inventory XML files to the Libraries.xml file (in<br />
"inventory" under the OpenSim bin directory).<br />
<br />
Written 2011 by Rob Knop aka Prospero Frobozz. I've only used this on<br />
Linux; I have no idea how well it will function on Windows. If you're<br />
on Windows, I recommend http://www.ubuntu.com<br />
<br />
Run updatelibrary.py --help for option listings<br />
"""<br />
<br />
parser = OptionParser(usage = usage)<br />
<br />
parser.add_option("-n", "--lib-name", action="store", type="string",<br />
dest="libname", default="New Library",<br />
help="The name of your library as it appears in the viewer")<br />
<br />
parser.add_option("-s", "--short-name", action="store", type="string",<br />
dest="shortname", default="NewLibrary",<br />
help="A name without spaces of your library for filename purposes.")<br />
<br />
parser.add_option("-a", "--asset-dir", action="store",<br />
type="string", dest="asset_dir",<br />
default=None,<br />
help="Directory where your .j2k, .txt, and .lsl files are, and which will "+<br />
"serve as the Assset Set in the OpenSim library. Defaults to assets/[shortname]AssetSet")<br />
<br />
parser.add_option("-i", "--inv-dir", action="store", type="string",<br />
dest="inv_dir", default=None,<br />
help="Directory in which to put the inventory XML files. Defaults to "+<br />
"inventory/[shortname]")<br />
<br />
parser.add_option("", "--asset-xmlfile", action="store",<br />
type="string", dest="asset_xmlfile", default=None,<br />
help="Name of Asset XML file. Defaults to [shortname]AssetSet.xml")<br />
<br />
parser.add_option("", "--folders-xmlfile", action="store",<br />
type="string", dest="folders_xmlfile", default=None,<br />
help="Name of Inventory Folders XML file. Defaults to [shortname]InvFolders.xml")<br />
<br />
parser.add_option("", "--items-xmlfile", action="store",<br />
type="string", dest="items_xmlfile", default=None,<br />
help="Name of Inventory Folders XML file. Defaults to [shortname]InvItems.xml")<br />
<br />
parser.add_option("", "--skip", action="append", type="string",<br />
dest="skip_patterns",<br />
default=['^\.hg$', '^\.git$', '^\.svn$'],<br />
help="Regex for filenames to not process")<br />
<br />
if len(sys.argv) < 2:<br />
parser.print_usage()<br />
sys.exit(0)<br />
<br />
options, args = parser.parse_args()<br />
<br />
try:<br />
generator = LibraryGenerator(options.libname, options.shortname)<br />
<br />
if options.skip_patterns:<br />
generator.set_skip_patterns(options.skip_patterns)<br />
<br />
if options.asset_dir != None:<br />
generator.set_asset_dir(options.asset_dir)<br />
<br />
if options.inv_dir != None:<br />
generator.set_inv_dir(options.inv_dir)<br />
<br />
if options.asset_xmlfile != None:<br />
generator.set_asset_xmlfile(options.asset_xmlfile)<br />
<br />
if options.folders_xmlfile != None:<br />
generator.set_folders_xmlfile(options.folders_xmlfile)<br />
<br />
if options.items_xmlfile != None:<br />
generator.set_items_xmlfile(options.items_xmlfile)<br />
<br />
generator.run()<br />
<br />
except Exception:<br />
print "FAIL"<br />
traceback.print_exc()<br />
sys.exit(20)<br />
<br />
<br />
# **********************************************************************<br />
<br />
if __name__ == "__main__":<br />
sys.exit(main())<br />
</pre></div>Rknophttp://opensimulator.org/wiki/Custom_LibrariesCustom Libraries2011-07-16T02:17:51Z<p>Rknop: </p>
<hr />
<div>{{Quicklinks}}<br />
<br /><br />
<br />
=Library Overview=<br />
<br />
The library in OpenSim is described in the file <tt>bin/inventory/Libraries.xml</tt>. That file defines a number of other libraries, each of which have a file for folders and a file for items. The files described in <tt>Libraries.xml</tt> are read each time the server starts. (Note, however, that the viewer caches library information, so you may need to clear your cache viewer side to see changes you've made.)<br />
<br />
If you want to add assets to the Library on your OpenSim server, there are two fundamental steps. The first is generating the assets, the second is generating these inventory XML files. The assets have information about the objects themselves; the geometry of prims, the image of textures, the text of notecards, etc. The inventory items are entries in the folders that allow users to actually access the assets.<br />
<br />
If you want ready-to-import libraries, you could check out the [[Free Assets]] section...<br />
<br />
=Generating Assets=<br />
<br />
The server also is able to bulk import asset sets. These asset sets are described in the file <tt>bin/assets/AssetSets.xml</tt>. Each asset set has its own XML file describing the assets, coupled with another file that has the actual asset data (image or text data). You can define new asset sets and add the XML file describing them to <tt>AssetSets.xml</tt>. When Robust (in grid mode) or OpenSim (in standalone mode) starts up, it looks at the AssetSets.xml file. It figures out which of the assets in the asset sets don't exist in its asset store, and adds them.<br />
<br />
==Generating Assets With the Viewer==<br />
<br />
The easiest way to generate assets is just to create them in-world, or upload them with the viewer. If you do this, there is no need to muck about with asset sets.<br />
<br />
==In Bulk==<br />
<br />
However, if you want to create assets in bulk, then you need to define your own asset set. Look at some of the asset sets defined in <tt>AssetSets.xml</tt>, to get a sense for what the an asset set XML file looks like.<br />
<br />
Practically speaking, at the moment, you can only import lsl scripts, notecards, and textures this way. There are two steps. First, you must get the assets into the right format. Second, you must generate the XML files for the assets.<br />
<br />
===Getting Assets into the Right Formats===<br />
<br />
Notecards and lsl files are plain text files.<br />
<br />
Images have a size that is a power of two on each side. That is, both the width and height must be one of 16, 32, 64, 128, 256, 512, or 1024. They must also be in be in JPEG2000 .j2k format. You can use the [http://www.openjpeg.org/ OpenJPEG] utilities to convert from other formats to JPEG2000. Note that version 1.3 of the OpenJPEG libraries does not support greyscale images or transparency. It will fail to work on greyscale images, and will remove any alpha channel from transparent images. As of revision 824 in the OpenJPEG svn archives, it also supports transparency, and may read PNG files directly, and (at least with PNG files) handles greyscale images. It's worth compiling a more recent version [http://code.google.com/p/openjpeg/source/checkout from the svn archives], at least until a version of OpenJPEG is officially released that supports these features.<br />
<br />
Convert a single image file to OpenJPEG with<br />
<br />
<tt>image_to_j2k -i ''inputfile'' -o ''outputbase''.j2k -r 100,30,10</tt><br />
<br />
A note on compression: the values after "-r" are the compression ratios to store in the OpenJPEG file. If you upload an image with the viewer (at least with Imprudence), the list of compression ratios used is 1920,480,120,30,10. Bigger numbers mean more compression, and hence blurrier images. The advantage of storing multiple levels of compression is that when the (small amount) of data for a high level of compression is downloaded, at least that much can be rendered. This is why when you watch a texture load, it starts blurry, and (at least if you're lucky) eventually becomes sharp. A compression level of 1 is lossless... and also uses a lot of space in the asset store, and a lot of bandwidth when it's sent down. A smallest compression of 10 should be good for most purposes. However, for things like sculpt maps (or small, precise textures), you may want to add a compression ratio of 1 to the end of the arguments.<br />
<br />
Two scripts exist, a [[jp2_batch_converter|Linux script]] or [[Jp2_batch_converter_for_windows|Windows script]] in perl. They use ImageMagick and image_to_j2k to resize image files to the appropriate size and convert them to j2k files (although named with an extension of .jp2, since that's what the viewer expects for some perverse reason). However, if you want to use this, be aware of some caveats:<br />
<br />
* The script ''deletes'' your original image file.<br />
* The script ''does no error checking''. This means that if for whatever reason (and there can be several!) image_to_j2k file fails, the script will delete your image file ''anyway''. This could make you sad if, like a certain stupid wiki page editor, you didn't make backup copies first.<br />
* The script makes j2k files with compression ratios 20,10,1. While this is great for image files that are bundled with the viewer, it's not good for server-side image files. That lossless compression means gratuitous use of server asset store space and bandwidth.<br />
<br />
Maybe one day there will be an updated script....<br />
<br />
<br />
===Creating Asset Set XML Files===<br />
<br />
Once you have all your assets in the right format, you need to create the AssetSet XML file. Ultimately, you're going to want to make a new subdirectory underneath <tt>bin/assets</tt>. For example, let's suppose you're making a new asset set called <tt>MyAwesomeAssetSet</tt>. You'll need to create, in that directory, a file <tt>MyAwesomeAssetSet.xml</tt>. You can use the python script [[updatelibrary.py]] to generate this file. It will also generate the inventory XML files needed. This script is documented [[#Generating_Inventory_and_Asset_Files|below]].<br />
<br />
<br />
==Terrains==<br />
===Create a terrain heightmap===<br />
<br />
* [[Using_L3DT|Creating custom terrains with L3DT]]<br />
<br />
<br />
=Generating Inventory Items=<br />
<br />
The folders that show up in the library are defined in <tt>bin/inventory/Libraries.xml</tt>. That xml file has an entry for each library; each library is defined by two XML files. One describes the folders in the library, (i.e. subfolders underneath a top folder that shows up underneath OpenSim Library), and the other describes the items in those folders. What you probably want to do is create a new library. Make a subdirectory for that library. Generate the two XML files describing the folders and items in that library. Add an entry to <tt>Libraries.xml</tt> giving the name of the two XML files for your library. You're done! Except that it's very painful, because it will involve copying and generating a lot of UUIDs. As such, except for the most trivial of libraries, you don't want to do this by hand.<br />
<br />
==Generating Inventory and Asset Files==<br />
<br />
The python script <tt>[[updatelibrary.py]]</tt> is able to generate asset and inventory XML files at the same time. Basically, you maintain a tree of assets in an asset set directory, and run this script to sync the XML files with your tree. (Note that at the moment it can only ''add'' assets; it will not delete them if you remove them frmo yoru tree.) It is able to add both assets in your asset set, ''and'' pre-existing assets already in your grid's asset store (for which you don't have to add something to an asset set.)<br />
<br />
In order to use it, you must:<br />
* Create an asset set directory<br />
* Arrange all of your asset files (text files for scripts and notecards, properly sized j2k files for textures) in directories underneath that asset set directory that will correspond to the folders and subfolders underneath your top-level library directory.<br />
* Decide on the name of your library, and on a short version (without spaces) that will be used for filenames.<br />
<br />
For example, if you're making a library that will show up as a folder under the OpenSim Library folder as "My Awesome Library", you could build it inside the MyAwesomeAssetSet directory. Underneath that directory, make subdirectories named Textures, Clothing, Objects, and so forth. In the Textures directory, put your properlly formatted j2k files. Right now, the script only handles textures (.j2k), notecards (.txt), and scripts (.lsl).<br />
<br />
In addition, in each directory you can put a file named "addassets.lis". You can list assets that are already in your grid's asset store here to be added to the library at the folder corresponding to the directory of each adassets.lis file. ''Any'' type of asset may be added to the library this way. This file is a series of lines, each of which follows the format<br />
<br />
asset_uuid asset_type inventory_type name of object in inventory<br />
<br />
A viewer such as Imprudence is able to tell you the asset_uuid of anything in your inventory; you can just copy this to the addassets.lis file. asset_type is a number, depending on the type of asset:<br />
<br />
{|border="2" cellpadding="2" cellspacing="2"<br />
!Type of Object<br />
!asset_type<br />
!<br />
!Type of Object<br />
!asset_type<br />
|-<br />
|Texture<br />
|0<br />
|<br />
|Notecard<br />
|7<br />
|-<br />
|Sound<br />
|1<br />
|<br />
|LSL Text<br />
|10<br />
|-<br />
|Calling Card<br />
|2<br />
|<br />
|LSL Bytecode<br />
|11<br />
|-<br />
|Landmark<br />
|3<br />
|<br />
|Bodypart<br />
|13<br />
|-<br />
|Clothing<br />
|5<br />
|<br />
|Animation<br />
|20<br />
|-<br />
|Primitive<br />
|6<br />
|<br />
|Gesture<br />
|21<br />
|}<br />
<br />
<br />
inventory_type is another number, again depending on the type of inventory. (Inventory type and asset type are not the same thing, although they're often closely related. Inventory type is what tells the viewer which sort of icon to show next to the inventory item's name.)<br />
<br />
{| border="2" cellpadding="2" cellspacing="2"<br />
!Type of Object<br />
!inventory_type<br />
!<br />
!Type of Object<br />
!inventory_type<br />
|-<br />
|Texture<br />
|0<br />
|<br />
|Root Category<br />
|9<br />
|-<br />
|Sound<br />
|1<br />
|<br />
|LSL Script<br />
|10<br />
|-<br />
|Calling Card<br />
|2<br />
|<br />
|Snapshot<br />
|15<br />
|-<br />
|Landmark<br />
|3<br />
|<br />
|Attachment<br />
|17<br />
|-<br />
|Object<br />
|6<br />
|<br />
|Wearable<br />
|18<br />
|-<br />
|Notecard<br />
|7<br />
|<br />
|Animation<br />
|19<br />
|-<br />
|Category<br />
|8<br />
|<br />
|Gesture<br />
|20<br />
|}<br />
<br />
(There is also the "None" inventory type, which has number -1. Body Parts and Clothing are both wearables.)<br />
<br />
Run the script. (Run it with <tt>--help</tt> to get usage instructions.) It will go through the entire directory tree where you have put your asset files. It will read the Asset Set, Inventory Folder, and Inventory Item XML files that already exist. It will then add entries as necessary to those files for any new .j2k, .txt, or .lsl files in your directory tree, as well as for any new entries in any addassets.lis file.<br />
<br />
When the script is complete, you need only to edit <tt>inventory/Libraries.xml</tt> and <tt>assets/AssetSets.xml</tt> to tell it about your new asset set and your new library. Next time you start up OpenSim or (in grid mode) Robust, it should import your assets and add your entries to the library. Again, remember that the viewer caches the library list, so you may need to clear your cache on the viewer in order to get the current version of the library.<br />
<br />
==Caution==<br />
<br />
(I don't know if this is true, but I seem to remember reading somewhere that in grid mode, library inventory xml files must exist not only on the Robust server, but also on each and every individual region OpenSim server. I do not know if this is the case. If it is, it certainly complicates matters.)<br />
<br />
Additionally, all of this may be obsolete in the future. Rather than using this code, it's possible that OpenSim will use IAR files to define the library (or, perhaps, default items for avatars). For the time being, though, try this.<br />
<br />
Contact Rob Knop (rknop on freenode, usually hanging out in opensim-dev; Prospero Frobozz on many grids) with any questions about <tt>[[updatelibrary.py]]</tt>.</div>Rknophttp://opensimulator.org/wiki/Custom_LibrariesCustom Libraries2011-07-16T02:09:08Z<p>Rknop: /* Generating Inventory and Asset Files */</p>
<hr />
<div>{{Quicklinks}}<br />
<br /><br />
<br />
=Library Overview=<br />
<br />
The library in OpenSim is described in the file <tt>bin/inventory/Libraries.xml</tt>. That file defines a number of other libraries, each of which have a file for folders and a file for items. The files described in <tt>Libraries.xml</tt> are read each time the server starts. (Note, however, that the viewer caches library information, so you may need to clear your cache viewer side to see changes you've made.)<br />
<br />
If you want to add assets to the Library on your OpenSim server, there are two fundamental steps. The first is generating the assets, the second is generating these inventory XML files. The assets have information about the objects themselves; the geometry of prims, the image of textures, the text of notecards, etc. The inventory items are entries in the folders that allow users to actually access the assets.<br />
<br />
If you want ready-to-import libraries, you could check out the [[Free Assets]] section...<br />
<br />
=Generating Assets=<br />
<br />
The server also is able to bulk import asset sets. These asset sets are described in the file <tt>bin/assets/AssetSets.xml</tt>. Each asset set has its own XML file describing the assets, coupled with another file that has the actual asset data (image or text data). You can define new asset sets and add the XML file describing them to <tt>AssetSets.xml</tt>. When Robust (in grid mode) or OpenSim (in standalone mode) starts up, it looks at the AssetSets.xml file. It figures out which of the assets in the asset sets don't exist in its asset store, and adds them.<br />
<br />
==Generating Assets With the Viewer==<br />
<br />
The easiest way to generate assets is just to create them in-world, or upload them with the viewer. If you do this, there is no need to muck about with asset sets.<br />
<br />
==In Bulk==<br />
<br />
However, if you want to create assets in bulk, then you need to define your own asset set. Look at some of the asset sets defined in <tt>AssetSets.xml</tt>, to get a sense for what the an asset set XML file looks like.<br />
<br />
Practically speaking, at the moment, you can only import lsl scripts, notecards, and textures this way. There are two steps. First, you must get the assets into the right format. Second, you must generate the XML files for the assets.<br />
<br />
===Getting Assets into the Right Formats===<br />
<br />
Notecards and lsl files are plain text files.<br />
<br />
Images have a size that is a power of two on each side. That is, both the width and height must be one of 16, 32, 64, 128, 256, 512, or 1024. They must also be in be in JPEG2000 .j2k format. You can use the [http://www.openjpeg.org/ OpenJPEG] utilities to convert from other formats to JPEG2000. Note that version 1.3 of the OpenJPEG libraries does not support greyscale images or transparency. It will fail to work on greyscale images, and will remove any alpha channel from transparent images. As of revision 824 in the OpenJPEG svn archives, it also supports transparency, and may read PNG files directly, and (at least with PNG files) handles greyscale images. It's worth compiling a more recent version [http://code.google.com/p/openjpeg/source/checkout from the svn archives], at least until a version of OpenJPEG is officially released that supports these features.<br />
<br />
Convert a single image file to OpenJPEG with<br />
<br />
<tt>image_to_j2k -i ''inputfile'' -o ''outputbase''.j2k -r 100,30,10</tt><br />
<br />
A note on compression: the values after "-r" are the compression ratios to store in the OpenJPEG file. If you upload an image with the viewer (at least with Imprudence), the list of compression ratios used is 1920,480,120,30,10. Bigger numbers mean more compression, and hence blurrier images. The advantage of storing multiple levels of compression is that when the (small amount) of data for a high level of compression is downloaded, at least that much can be rendered. This is why when you watch a texture load, it starts blurry, and (at least if you're lucky) eventually becomes sharp. A compression level of 1 is lossless... and also uses a lot of space in the asset store, and a lot of bandwidth when it's sent down. A smallest compression of 10 should be good for most purposes. However, for things like sculpt maps (or small, precise textures), you may want to add a compression ratio of 1 to the end of the arguments.<br />
<br />
Two scripts exist, a [[jp2_batch_converter|Linux script]] or [[Jp2_batch_converter_for_windows|Windows script]] in perl. They use ImageMagick and image_to_j2k to resize image files to the appropriate size and convert them to j2k files (although named with an extension of .jp2, since that's what the viewer expects for some perverse reason). However, if you want to use this, be aware of some caveats:<br />
<br />
* The script ''deletes'' your original image file.<br />
* The script ''does no error checking''. This means that if for whatever reason (and there can be several!) image_to_j2k file fails, the script will delete your image file ''anyway''. This could make you sad if, like a certain stupid wiki page editor, you didn't make backup copies first.<br />
* The script makes j2k files with compression ratios 20,10,1. While this is great for image files that are bundled with the viewer, it's not good for server-side image files. That lossless compression means gratuitous use of server asset store space and bandwidth.<br />
<br />
Maybe one day there will be an updated script....<br />
<br />
<br />
===Creating Asset Set XML Files===<br />
<br />
Once you have all your assets in the right format, you need to create the AssetSet XML file. Ultimately, you're going to want to make a new subdirectory underneath <tt>bin/assets</tt>. For example, let's suppose you're making a new asset set called <tt>MyAwesomeAssetSet</tt>. You'll need to create, in that directory, a file <tt>MyAwesomeAssetSet.xml</tt>. You can use the python script updatelibrary.py to generate this file. It will also generate the inventory XML files needed. This script is documented [[#Generating_Inventory_and_Asset_Files|below]].<br />
<br />
<br />
==Terrains==<br />
===Create a terrain heightmap===<br />
<br />
* [[Using_L3DT|Creating custom terrains with L3DT]]<br />
<br />
<br />
=Generating Inventory Items=<br />
<br />
The folders that show up in the library are defined in <tt>bin/inventory/Libraries.xml</tt>. That xml file has an entry for each library; each library is defined by two XML files. One describes the folders in the library, (i.e. subfolders underneath a top folder that shows up underneath OpenSim Library), and the other describes the items in those folders. What you probably want to do is create a new library. Make a subdirectory for that library. Generate the two XML files describing the folders and items in that library. Add an entry to <tt>Libraries.xml</tt> giving the name of the two XML files for your library. You're done! Except that it's very painful, because it will involve copying and generating a lot of UUIDs. As such, except for the most trivial of libraries, you don't want to do this by hand.<br />
<br />
==Generating Inventory and Asset Files==<br />
<br />
The python script <tt>updatelibrary.py</tt> is able to generate asset and inventory XML files at the same time. Basically, you maintain a tree of assets in an asset set directory, and run this script to sync the XML files with your tree. (Note that at the moment it can only ''add'' assets; it will not delete them if you remove them frmo yoru tree.) It is able to add both assets in your asset set, ''and'' pre-existing assets already in your grid's asset store (for which you don't have to add something to an asset set.)<br />
<br />
In order to use it, you must:<br />
* Create an asset set directory<br />
* Arrange all of your asset files (text files for scripts and notecards, properly sized j2k files for textures) in directories underneath that asset set directory that will correspond to the folders and subfolders underneath your top-level library directory.<br />
* Decide on the name of your library, and on a short version (without spaces) that will be used for filenames.<br />
<br />
For example, if you're making a library that will show up as a folder under the OpenSim Library folder as "My Awesome Library", you could build it inside the MyAwesomeAssetSet directory. Underneath that directory, make subdirectories named Textures, Clothing, Objects, and so forth. In the Textures directory, put your properlly formatted j2k files. Right now, the script only handles textures (.j2k), notecards (.txt), and scripts (.lsl).<br />
<br />
In addition, in each directory you can put a file named "addassets.lis". You can list assets that are already in your grid's asset store here to be added to the library at the folder corresponding to the directory of each adassets.lis file. ''Any'' type of asset may be added to the library this way. This file is a series of lines, each of which follows the format<br />
<br />
asset_uuid asset_type inventory_type name of object in inventory<br />
<br />
A viewer such as Imprudence is able to tell you the asset_uuid of anything in your inventory; you can just copy this to the addassets.lis file. asset_type is a number, depending on the type of asset:<br />
<br />
{|border="2" cellpadding="2" cellspacing="2"<br />
!Type of Object<br />
!asset_type<br />
!<br />
!Type of Object<br />
!asset_type<br />
|-<br />
|Texture<br />
|0<br />
|<br />
|Notecard<br />
|7<br />
|-<br />
|Sound<br />
|1<br />
|<br />
|LSL Text<br />
|10<br />
|-<br />
|Calling Card<br />
|2<br />
|<br />
|LSL Bytecode<br />
|11<br />
|-<br />
|Landmark<br />
|3<br />
|<br />
|Bodypart<br />
|13<br />
|-<br />
|Clothing<br />
|5<br />
|<br />
|Animation<br />
|20<br />
|-<br />
|Primitive<br />
|6<br />
|<br />
|Gesture<br />
|21<br />
|}<br />
<br />
<br />
inventory_type is another number, again depending on the type of inventory. (Inventory type and asset type are not the same thing, although they're often closely related. Inventory type is what tells the viewer which sort of icon to show next to the inventory item's name.)<br />
<br />
{| border="2" cellpadding="2" cellspacing="2"<br />
!Type of Object<br />
!inventory_type<br />
!<br />
!Type of Object<br />
!inventory_type<br />
|-<br />
|Texture<br />
|0<br />
|<br />
|Root Category<br />
|9<br />
|-<br />
|Sound<br />
|1<br />
|<br />
|LSL Script<br />
|10<br />
|-<br />
|Calling Card<br />
|2<br />
|<br />
|Snapshot<br />
|15<br />
|-<br />
|Landmark<br />
|3<br />
|<br />
|Attachment<br />
|17<br />
|-<br />
|Object<br />
|6<br />
|<br />
|Wearable<br />
|18<br />
|-<br />
|Notecard<br />
|7<br />
|<br />
|Animation<br />
|19<br />
|-<br />
|Category<br />
|8<br />
|<br />
|Gesture<br />
|20<br />
|}<br />
<br />
(There is also the "None" inventory type, which has number -1. Body Parts and Clothing are both wearables.)<br />
<br />
Run the script. (Run it with <tt>--help</tt> to get usage instructions.) It will go through the entire directory tree where you have put your asset files. It will read the Asset Set, Inventory Folder, and Inventory Item XML files that already exist. It will then add entries as necessary to those files for any new .j2k, .txt, or .lsl files in your directory tree, as well as for any new entries in any addassets.lis file.<br />
<br />
When the script is complete, you need only to edit <tt>inventory/Libraries.xml</tt> and <tt>assets/AssetSets.xml</tt> to tell it about your new asset set and your new library. Next time you start up OpenSim or (in grid mode) Robust, it should import your assets and add your entries to the library. Again, remember that the viewer caches the library list, so you may need to clear your cache on the viewer in order to get the current version of the library.<br />
<br />
==Caution==<br />
<br />
(I don't know if this is true, but I seem to remember reading somewhere that in grid mode, library inventory xml files must exist not only on the Robust server, but also on each and every individual region OpenSim server. I do not know if this is the case. If it is, it certainly complicates matters.)<br />
<br />
Additionally, all of this may be obsolete in the future. Rather than using this code, it's possible that OpenSim will use IAR files to define the library (or, perhaps, default items for avatars). For the time being, though, try this.<br />
<br />
Contact Rob Knop (rknop on freenode, usually hanging out in opensim-dev; Prospero Frobozz on many grids) with any questions about <tt>updatelibrary.py</tt>.</div>Rknophttp://opensimulator.org/wiki/Custom_LibrariesCustom Libraries2011-07-16T02:08:13Z<p>Rknop: /* Generating Inventory and Asset Files */</p>
<hr />
<div>{{Quicklinks}}<br />
<br /><br />
<br />
=Library Overview=<br />
<br />
The library in OpenSim is described in the file <tt>bin/inventory/Libraries.xml</tt>. That file defines a number of other libraries, each of which have a file for folders and a file for items. The files described in <tt>Libraries.xml</tt> are read each time the server starts. (Note, however, that the viewer caches library information, so you may need to clear your cache viewer side to see changes you've made.)<br />
<br />
If you want to add assets to the Library on your OpenSim server, there are two fundamental steps. The first is generating the assets, the second is generating these inventory XML files. The assets have information about the objects themselves; the geometry of prims, the image of textures, the text of notecards, etc. The inventory items are entries in the folders that allow users to actually access the assets.<br />
<br />
If you want ready-to-import libraries, you could check out the [[Free Assets]] section...<br />
<br />
=Generating Assets=<br />
<br />
The server also is able to bulk import asset sets. These asset sets are described in the file <tt>bin/assets/AssetSets.xml</tt>. Each asset set has its own XML file describing the assets, coupled with another file that has the actual asset data (image or text data). You can define new asset sets and add the XML file describing them to <tt>AssetSets.xml</tt>. When Robust (in grid mode) or OpenSim (in standalone mode) starts up, it looks at the AssetSets.xml file. It figures out which of the assets in the asset sets don't exist in its asset store, and adds them.<br />
<br />
==Generating Assets With the Viewer==<br />
<br />
The easiest way to generate assets is just to create them in-world, or upload them with the viewer. If you do this, there is no need to muck about with asset sets.<br />
<br />
==In Bulk==<br />
<br />
However, if you want to create assets in bulk, then you need to define your own asset set. Look at some of the asset sets defined in <tt>AssetSets.xml</tt>, to get a sense for what the an asset set XML file looks like.<br />
<br />
Practically speaking, at the moment, you can only import lsl scripts, notecards, and textures this way. There are two steps. First, you must get the assets into the right format. Second, you must generate the XML files for the assets.<br />
<br />
===Getting Assets into the Right Formats===<br />
<br />
Notecards and lsl files are plain text files.<br />
<br />
Images have a size that is a power of two on each side. That is, both the width and height must be one of 16, 32, 64, 128, 256, 512, or 1024. They must also be in be in JPEG2000 .j2k format. You can use the [http://www.openjpeg.org/ OpenJPEG] utilities to convert from other formats to JPEG2000. Note that version 1.3 of the OpenJPEG libraries does not support greyscale images or transparency. It will fail to work on greyscale images, and will remove any alpha channel from transparent images. As of revision 824 in the OpenJPEG svn archives, it also supports transparency, and may read PNG files directly, and (at least with PNG files) handles greyscale images. It's worth compiling a more recent version [http://code.google.com/p/openjpeg/source/checkout from the svn archives], at least until a version of OpenJPEG is officially released that supports these features.<br />
<br />
Convert a single image file to OpenJPEG with<br />
<br />
<tt>image_to_j2k -i ''inputfile'' -o ''outputbase''.j2k -r 100,30,10</tt><br />
<br />
A note on compression: the values after "-r" are the compression ratios to store in the OpenJPEG file. If you upload an image with the viewer (at least with Imprudence), the list of compression ratios used is 1920,480,120,30,10. Bigger numbers mean more compression, and hence blurrier images. The advantage of storing multiple levels of compression is that when the (small amount) of data for a high level of compression is downloaded, at least that much can be rendered. This is why when you watch a texture load, it starts blurry, and (at least if you're lucky) eventually becomes sharp. A compression level of 1 is lossless... and also uses a lot of space in the asset store, and a lot of bandwidth when it's sent down. A smallest compression of 10 should be good for most purposes. However, for things like sculpt maps (or small, precise textures), you may want to add a compression ratio of 1 to the end of the arguments.<br />
<br />
Two scripts exist, a [[jp2_batch_converter|Linux script]] or [[Jp2_batch_converter_for_windows|Windows script]] in perl. They use ImageMagick and image_to_j2k to resize image files to the appropriate size and convert them to j2k files (although named with an extension of .jp2, since that's what the viewer expects for some perverse reason). However, if you want to use this, be aware of some caveats:<br />
<br />
* The script ''deletes'' your original image file.<br />
* The script ''does no error checking''. This means that if for whatever reason (and there can be several!) image_to_j2k file fails, the script will delete your image file ''anyway''. This could make you sad if, like a certain stupid wiki page editor, you didn't make backup copies first.<br />
* The script makes j2k files with compression ratios 20,10,1. While this is great for image files that are bundled with the viewer, it's not good for server-side image files. That lossless compression means gratuitous use of server asset store space and bandwidth.<br />
<br />
Maybe one day there will be an updated script....<br />
<br />
<br />
===Creating Asset Set XML Files===<br />
<br />
Once you have all your assets in the right format, you need to create the AssetSet XML file. Ultimately, you're going to want to make a new subdirectory underneath <tt>bin/assets</tt>. For example, let's suppose you're making a new asset set called <tt>MyAwesomeAssetSet</tt>. You'll need to create, in that directory, a file <tt>MyAwesomeAssetSet.xml</tt>. You can use the python script updatelibrary.py to generate this file. It will also generate the inventory XML files needed. This script is documented [[#Generating_Inventory_and_Asset_Files|below]].<br />
<br />
<br />
==Terrains==<br />
===Create a terrain heightmap===<br />
<br />
* [[Using_L3DT|Creating custom terrains with L3DT]]<br />
<br />
<br />
=Generating Inventory Items=<br />
<br />
The folders that show up in the library are defined in <tt>bin/inventory/Libraries.xml</tt>. That xml file has an entry for each library; each library is defined by two XML files. One describes the folders in the library, (i.e. subfolders underneath a top folder that shows up underneath OpenSim Library), and the other describes the items in those folders. What you probably want to do is create a new library. Make a subdirectory for that library. Generate the two XML files describing the folders and items in that library. Add an entry to <tt>Libraries.xml</tt> giving the name of the two XML files for your library. You're done! Except that it's very painful, because it will involve copying and generating a lot of UUIDs. As such, except for the most trivial of libraries, you don't want to do this by hand.<br />
<br />
==Generating Inventory and Asset Files==<br />
<br />
The python script <tt>updatelibrary.py</tt> is able to generate asset and inventory XML files at the same time. Basically, you maintain a tree of assets in an asset set directory, and run this script to sync the XML files with your tree. (Note that at the moment it can only ''add'' assets; it will not delete them if you remove them frmo yoru tree.) It is able to add both assets in your asset set, ''and'' pre-existing assets already in your grid's asset store (for which you don't have to add something to an asset set.)<br />
<br />
In order to use it, you must:<br />
* Create an asset set directory<br />
* Arrange all of your asset files (text files for scripts and notecards, properly sized j2k files for textures) in directories underneath that asset set directory that will correspond to the folders and subfolders underneath your top-level library directory.<br />
* Decide on the name of your library, and on a short version (without spaces) that will be used for filenames.<br />
<br />
For example, if you're making a library that will show up as a folder under the OpenSim Library folder as "My Awesome Library", you could build it inside the MyAwesomeAssetSet directory. Underneath that directory, make subdirectories named Textures, Clothing, Objects, and so forth. In the Textures directory, put your properlly formatted j2k files. Right now, the script only handles textures (.j2k), notecards (.txt), and scripts (.lsl).<br />
<br />
In addition, in each directory you can put a file named "addassets.lis". You can list assets that are already in your grid's asset store here to be added to the library at the folder corresponding to the directory of each adassets.lis file. ''Any'' type of asset may be added to the library this way. This file is a series of lines, each of which follows the format<br />
<br />
asset_uuid asset_type inventory_type name of object in inventory<br />
<br />
A viewer such as Imprudence is able to tell you the asset_uuid of anything in your inventory; you can just copy this to the addassets.lis file. asset_type is a number, depending on the type of asset:<br />
<br />
{|border="2" cellpadding="2" cellspacing="2"<br />
!Type of Object<br />
!asset_type<br />
!<br />
!Type of Object<br />
!asset_type<br />
|-<br />
|Texture<br />
|0<br />
|<br />
|Notecard<br />
|7<br />
|-<br />
|Sound<br />
|1<br />
|<br />
|LSL Text<br />
|10<br />
|-<br />
|Calling Card<br />
|2<br />
|<br />
|LSL Bytecode<br />
|11<br />
|-<br />
|Landmark<br />
|3<br />
|<br />
|Bodypart<br />
|13<br />
|-<br />
|Clothing<br />
|5<br />
|<br />
|Animation<br />
|20<br />
|-<br />
|Primitive<br />
|6<br />
|<br />
|Gesture<br />
|21<br />
|}<br />
<br />
<br />
inventory_type is another number, again depending on the type of inventory. (Inventory type and asset type are not the same thing, although they're often closely related. Inventory type is what tells the viewer which sort of icon to show next to the inventory item's name.)<br />
<br />
{| border="2" cellpadding="2" cellspacing="2"<br />
!Type of Object<br />
!inventory_type<br />
!<br />
!Type of Object<br />
!inventory_type<br />
|-<br />
|Texture<br />
|0<br />
|<br />
|Root Category<br />
|9<br />
|-<br />
|Sound<br />
|1<br />
|<br />
|LSL Script<br />
|10<br />
|-<br />
|Calling Card<br />
|2<br />
|<br />
|Snapshot<br />
|15<br />
|-<br />
|Landmark<br />
|3<br />
|<br />
|Attachment<br />
|17<br />
|-<br />
|Object<br />
|6<br />
|<br />
|Wearable<br />
|18<br />
|-<br />
|Notecard<br />
|7<br />
|<br />
|Animation<br />
|19<br />
|-<br />
|Category<br />
|8<br />
|<br />
|Gesture<br />
|20<br />
|}<br />
<br />
(There is also the "None" inventory type, which has number -1.)<br />
<br />
Run the script. (Run it with <tt>--help</tt> to get usage instructions.) It will go through the entire directory tree where you have put your asset files. It will read the Asset Set, Inventory Folder, and Inventory Item XML files that already exist. It will then add entries as necessary to those files for any new .j2k, .txt, or .lsl files in your directory tree, as well as for any new entries in any addassets.lis file.<br />
<br />
When the script is complete, you need only to edit <tt>inventory/Libraries.xml</tt> and <tt>assets/AssetSets.xml</tt> to tell it about your new asset set and your new library. Next time you start up OpenSim or (in grid mode) Robust, it should import your assets and add your entries to the library. Again, remember that the viewer caches the library list, so you may need to clear your cache on the viewer in order to get the current version of the library.<br />
<br />
==Caution==<br />
<br />
(I don't know if this is true, but I seem to remember reading somewhere that in grid mode, library inventory xml files must exist not only on the Robust server, but also on each and every individual region OpenSim server. I do not know if this is the case. If it is, it certainly complicates matters.)<br />
<br />
Additionally, all of this may be obsolete in the future. Rather than using this code, it's possible that OpenSim will use IAR files to define the library (or, perhaps, default items for avatars). For the time being, though, try this.<br />
<br />
Contact Rob Knop (rknop on freenode, usually hanging out in opensim-dev; Prospero Frobozz on many grids) with any questions about <tt>updatelibrary.py</tt>.</div>Rknophttp://opensimulator.org/wiki/Custom_LibrariesCustom Libraries2011-07-16T02:06:42Z<p>Rknop: </p>
<hr />
<div>{{Quicklinks}}<br />
<br /><br />
<br />
=Library Overview=<br />
<br />
The library in OpenSim is described in the file <tt>bin/inventory/Libraries.xml</tt>. That file defines a number of other libraries, each of which have a file for folders and a file for items. The files described in <tt>Libraries.xml</tt> are read each time the server starts. (Note, however, that the viewer caches library information, so you may need to clear your cache viewer side to see changes you've made.)<br />
<br />
If you want to add assets to the Library on your OpenSim server, there are two fundamental steps. The first is generating the assets, the second is generating these inventory XML files. The assets have information about the objects themselves; the geometry of prims, the image of textures, the text of notecards, etc. The inventory items are entries in the folders that allow users to actually access the assets.<br />
<br />
If you want ready-to-import libraries, you could check out the [[Free Assets]] section...<br />
<br />
=Generating Assets=<br />
<br />
The server also is able to bulk import asset sets. These asset sets are described in the file <tt>bin/assets/AssetSets.xml</tt>. Each asset set has its own XML file describing the assets, coupled with another file that has the actual asset data (image or text data). You can define new asset sets and add the XML file describing them to <tt>AssetSets.xml</tt>. When Robust (in grid mode) or OpenSim (in standalone mode) starts up, it looks at the AssetSets.xml file. It figures out which of the assets in the asset sets don't exist in its asset store, and adds them.<br />
<br />
==Generating Assets With the Viewer==<br />
<br />
The easiest way to generate assets is just to create them in-world, or upload them with the viewer. If you do this, there is no need to muck about with asset sets.<br />
<br />
==In Bulk==<br />
<br />
However, if you want to create assets in bulk, then you need to define your own asset set. Look at some of the asset sets defined in <tt>AssetSets.xml</tt>, to get a sense for what the an asset set XML file looks like.<br />
<br />
Practically speaking, at the moment, you can only import lsl scripts, notecards, and textures this way. There are two steps. First, you must get the assets into the right format. Second, you must generate the XML files for the assets.<br />
<br />
===Getting Assets into the Right Formats===<br />
<br />
Notecards and lsl files are plain text files.<br />
<br />
Images have a size that is a power of two on each side. That is, both the width and height must be one of 16, 32, 64, 128, 256, 512, or 1024. They must also be in be in JPEG2000 .j2k format. You can use the [http://www.openjpeg.org/ OpenJPEG] utilities to convert from other formats to JPEG2000. Note that version 1.3 of the OpenJPEG libraries does not support greyscale images or transparency. It will fail to work on greyscale images, and will remove any alpha channel from transparent images. As of revision 824 in the OpenJPEG svn archives, it also supports transparency, and may read PNG files directly, and (at least with PNG files) handles greyscale images. It's worth compiling a more recent version [http://code.google.com/p/openjpeg/source/checkout from the svn archives], at least until a version of OpenJPEG is officially released that supports these features.<br />
<br />
Convert a single image file to OpenJPEG with<br />
<br />
<tt>image_to_j2k -i ''inputfile'' -o ''outputbase''.j2k -r 100,30,10</tt><br />
<br />
A note on compression: the values after "-r" are the compression ratios to store in the OpenJPEG file. If you upload an image with the viewer (at least with Imprudence), the list of compression ratios used is 1920,480,120,30,10. Bigger numbers mean more compression, and hence blurrier images. The advantage of storing multiple levels of compression is that when the (small amount) of data for a high level of compression is downloaded, at least that much can be rendered. This is why when you watch a texture load, it starts blurry, and (at least if you're lucky) eventually becomes sharp. A compression level of 1 is lossless... and also uses a lot of space in the asset store, and a lot of bandwidth when it's sent down. A smallest compression of 10 should be good for most purposes. However, for things like sculpt maps (or small, precise textures), you may want to add a compression ratio of 1 to the end of the arguments.<br />
<br />
Two scripts exist, a [[jp2_batch_converter|Linux script]] or [[Jp2_batch_converter_for_windows|Windows script]] in perl. They use ImageMagick and image_to_j2k to resize image files to the appropriate size and convert them to j2k files (although named with an extension of .jp2, since that's what the viewer expects for some perverse reason). However, if you want to use this, be aware of some caveats:<br />
<br />
* The script ''deletes'' your original image file.<br />
* The script ''does no error checking''. This means that if for whatever reason (and there can be several!) image_to_j2k file fails, the script will delete your image file ''anyway''. This could make you sad if, like a certain stupid wiki page editor, you didn't make backup copies first.<br />
* The script makes j2k files with compression ratios 20,10,1. While this is great for image files that are bundled with the viewer, it's not good for server-side image files. That lossless compression means gratuitous use of server asset store space and bandwidth.<br />
<br />
Maybe one day there will be an updated script....<br />
<br />
<br />
===Creating Asset Set XML Files===<br />
<br />
Once you have all your assets in the right format, you need to create the AssetSet XML file. Ultimately, you're going to want to make a new subdirectory underneath <tt>bin/assets</tt>. For example, let's suppose you're making a new asset set called <tt>MyAwesomeAssetSet</tt>. You'll need to create, in that directory, a file <tt>MyAwesomeAssetSet.xml</tt>. You can use the python script updatelibrary.py to generate this file. It will also generate the inventory XML files needed. This script is documented [[#Generating_Inventory_and_Asset_Files|below]].<br />
<br />
<br />
==Terrains==<br />
===Create a terrain heightmap===<br />
<br />
* [[Using_L3DT|Creating custom terrains with L3DT]]<br />
<br />
<br />
=Generating Inventory Items=<br />
<br />
The folders that show up in the library are defined in <tt>bin/inventory/Libraries.xml</tt>. That xml file has an entry for each library; each library is defined by two XML files. One describes the folders in the library, (i.e. subfolders underneath a top folder that shows up underneath OpenSim Library), and the other describes the items in those folders. What you probably want to do is create a new library. Make a subdirectory for that library. Generate the two XML files describing the folders and items in that library. Add an entry to <tt>Libraries.xml</tt> giving the name of the two XML files for your library. You're done! Except that it's very painful, because it will involve copying and generating a lot of UUIDs. As such, except for the most trivial of libraries, you don't want to do this by hand.<br />
<br />
==Generating Inventory and Asset Files==<br />
<br />
The python script <tt>updatelibrary.py</tt> is able to generate asset and inventory XML files at the same time. Basically, you maintain a tree of assets in an asset set directory, and run this script to sync the XML files with your tree. (Note that at the moment it can only ''add'' assets; it will not delete them if you remove them frmo yoru tree.) It is able to add both assets in your asset set, ''and'' pre-existing assets already in your grid's asset store (for which you don't have to add something to an asset set.)<br />
<br />
In order to use it, you must:<br />
* Create an asset set directory<br />
* Arrange all of your asset files (text files for scripts and notecards, properly sized j2k files for textures) in directories underneath that asset set directory that will correspond to the folders and subfolders underneath your top-level library directory.<br />
* Decide on the name of your library, and on a short version (without spaces) that will be used for filenames.<br />
<br />
For example, if you're making a library that will show up as a folder under the OpenSim Library folder as "My Awesome Library", you could build it inside the MyAwesomeAssetSet directory. Underneath that directory, make subdirectories named Textures, Clothing, Objects, and so forth. In the Textures directory, put your properlly formatted j2k files. Right now, the script only handles textures (.j2k), notecards (.txt), and scripts (.lsl).<br />
<br />
In addition, in each directory you can put a file named "addassets.lis". You can list assets that are already in your grid's asset store here to be added to the library at the folder corresponding to the directory of each adassets.lis file. ''Any'' type of asset may be added to the library this way. This file is a series of lines, each of which follows the format<br />
<br />
asset_uuid asset_type inventory_type name of object in inventory<br />
<br />
A viewer such as Imprudence is able to tell you the asset_uuid of anything in your inventory; you can just copy this to the addassets.lis file. asset_type is a number, depending on the type of asset:<br />
<br />
{|border="2" cellpadding="2" cellspacing="2"<br />
!Type of Object<br />
!asset_type<br />
!<br />
!Type of Object<br />
!asset_type<br />
|-<br />
|Texture<br />
|0<br />
|<br />
|Notecard<br />
|7<br />
|-<br />
|Sound<br />
|1<br />
|<br />
|LSL Text<br />
|10<br />
|-<br />
|Calling Card<br />
|2<br />
|<br />
|LSL Bytecode<br />
|11<br />
|-<br />
|Landmark<br />
|3<br />
|<br />
|Bodypart<br />
|13<br />
|-<br />
|Clothing<br />
|5<br />
|<br />
|Animation<br />
|20<br />
|-<br />
|Primitive<br />
|6<br />
|<br />
|Gesture<br />
|21<br />
|}<br />
<br />
<br />
inventory_type is another number, again depending on the type of inventory. (Inventory type and asset type are not the same thing, although they're often closely related. Inventory type is what tells the viewer which sort of icon to show next to the inventory item's name.)<br />
<br />
{| border="2" cellpadding="2" cellspacing="2"<br />
!Type of Object<br />
!inventory_type<br />
!<br />
!Type of Object<br />
!inventory_type<br />
|-<br />
|Texture<br />
|0<br />
|<br />
|Root Category<br />
|9<br />
|-<br />
|Sound<br />
|1<br />
|<br />
|LSL Script<br />
|10<br />
|-<br />
|Calling Card<br />
|2<br />
|<br />
|Snapshot<br />
|15<br />
|-<br />
|Landmark<br />
|3<br />
|<br />
|Attachment<br />
|17<br />
|-<br />
|Object<br />
|6<br />
|<br />
|Wearable<br />
|18<br />
|-<br />
|Notecard<br />
|7<br />
|<br />
|Animation<br />
|19<br />
|-<br />
|Category<br />
|8<br />
|<br />
|Gesture<br />
|20<br />
|}<br />
<br />
(There is also the "None" inventory type, which has number -1.)<br />
<br />
Run the script. It will go through the entire directory tree where you have put your asset files. It will read the Asset Set, Inventory Folder, and Inventory Item XML files that already exist. It will then add entries as necessary to those files for any new .j2k, .txt, or .lsl files in your directory tree, as well as for any new entries in any addassets.lis file.<br />
<br />
When the script is complete, you need only to edit <tt>inventory/Libraries.xml</tt> and <tt>assets/AssetSets.xml</tt> to tell it about your new asset set and your new library. Next time you start up OpenSim or (in grid mode) Robust, it should import your assets and add your entries to the library. Again, remember that the viewer caches the library list, so you may need to clear your cache on the viewer in order to get the current version of the library.<br />
<br />
<br />
==Caution==<br />
<br />
(I don't know if this is true, but I seem to remember reading somewhere that in grid mode, library inventory xml files must exist not only on the Robust server, but also on each and every individual region OpenSim server. I do not know if this is the case. If it is, it certainly complicates matters.)<br />
<br />
Additionally, all of this may be obsolete in the future. Rather than using this code, it's possible that OpenSim will use IAR files to define the library (or, perhaps, default items for avatars). For the time being, though, try this.<br />
<br />
Contact Rob Knop (rknop on freenode, usually hanging out in opensim-dev; Prospero Frobozz on many grids) with any questions about <tt>updatelibrary.py</tt>.</div>Rknophttp://opensimulator.org/wiki/Custom_LibrariesCustom Libraries2011-07-15T05:24:19Z<p>Rknop: /* Generating Assets */</p>
<hr />
<div>__NOTOC__<br />
{{Quicklinks}}<br />
<br /><br />
<br />
If you want to add assets to the Library on your OpenSim server, there are two fundamental steps. The first is generating the assets, the second is generating the inventory items. The assets have information about the objects themselves; the geometry of prims, the image of textures, the text of notecards, etc. The inventory items are entries in the folders that allow users to actually access the assets.<br />
<br />
If you want ready-to-import libraries, you could check out the [[Free Assets]] section...<br />
<br />
=Generating Assets=<br />
<br />
==With the Viewer==<br />
<br />
The easiest way to generate assets is just to create them in-world, or upload them with the viewer.<br />
<br />
==In Bulk==<br />
<br />
However, if you want to create assets in bulk, for instance from a directory of image files, you can create images and add them into the default asset sets. These are found in the <tt>bin/assets</tt> directory. The file <tt>AssetSets.xml</tt> has a list of "asset sets", directories that contain the actual data for the assets and an XML file that has the metadata. Look at the XML file for the example; the format is not too complicated.<br />
<br />
Practically speaking, at the moment, you can only import lsl scripts, notecards, and textures this way. There are two steps. First, you must get the assets into the right format. Second, you must generate the XML files for the assets.<br />
<br />
===Getting Assets into the Right Formats===<br />
<br />
Notecards and lsl files are plain text files.<br />
<br />
Images have a size that is a power of two on each side. That is, both the width and height must be one of 16, 32, 64, 128, 256, 512, or 1024. They must also be in be in JPEG2000 .j2k format. You can use the [http://www.openjpeg.org/ OpenJPEG] utilities to convert from other formats to JPEG2000. Note that version 1.3 of the OpenJPEG libraries does not support greyscale images or transparency. It will fail to work on greyscale images, and will remove any alpha channel from transparent images. As of revision 824 in the OpenJPEG svn archives, it also supports transparency, and may read PNG files directly, and (at least with PNG files) handles greyscale images. It's worth compiling a more recent version [http://code.google.com/p/openjpeg/source/checkout from the svn archives], at least until a version of OpenJPEG is officially released that supports these features.<br />
<br />
Convert a single image file to OpenJPEG with<br />
<br />
<tt>image_to_j2k -i ''inputfile'' -o ''outputbase''.j2k -r 100,30,10</tt><br />
<br />
A note on compression: the values after "-r" are the compression ratios to store in the OpenJPEG file. If you upload an image with the viewer (at least with Imprudence), the list of compression ratios used is 1920,480,120,30,10. Bigger numbers mean more compression, and hence blurrier images. The advantage of storing multiple levels of compression is that when the (small amount) of data for a high level of compression is downloaded, at least that much can be rendered. This is why when you watch a texture load, it starts blurry, and (at least if you're lucky) eventually becomes sharp. A compression level of 1 is lossless... and also uses a lot of space in the asset store, and a lot of bandwidth when it's sent down. A smallest compression of 10 should be good for most purposes. However, for things like sculpt maps (or small, precise textures), you may want to add a compression ratio of 1 to the end of the arguments.<br />
<br />
Two scripts exist, a [[jp2_batch_converter|Linux script]] or [[Jp2_batch_converter_for_windows|Windows script]] in perl. They use ImageMagick and image_to_j2k to resize image files to the appropriate size and convert them to j2k files (although named with an extension of .jp2, since that's what the viewer expects for some perverse reason). However, if you want to use this, be aware of some caveats:<br />
<br />
* The script ''deletes'' your original image file.<br />
* The script ''does no error checking''. This means that if for whatever reason (and there can be several!) image_to_j2k file fails, the script will delete your image file ''anyway''. This could make you sad if, like a certain stupid wiki page editor, you didn't make backup copies first.<br />
* The script makes j2k files with compression ratios 20,10,1. While this is great for image files that are bundled with the viewer, it's not good for server-side image files. That lossless compression means gratuitous use of server asset store space and bandwidth.<br />
<br />
Maybe one day there will be an updated script....<br />
<br />
<br />
===Creating Asset Set XML Files===<br />
<br />
Once you have all your assets in the right format, you need to create the AssetSet XML file. Ultimately, you're going to want to make a new subdirectory underneath <tt>bin/assets</tt>. For example, let's suppose you're making a new asset set called <tt>MyAwesomeAssetSet</tt>. You'll need to create, in that directory, a file <tt>MyAwesomeAssetSet.xml</tt>. You can use the python script genassets.py to generate this file. It will also generate the inventory XML files needeed. This script is documented [[#Generating_Inventory_and_Asset_Files|below]].<br />
<br />
<br />
==Terrains==<br />
===Create a terrain heightmap===<br />
<br />
* [[Using_L3DT|Creating custom terrains with L3DT]]<br />
<br />
=Generating Inventory Items=<br />
<br />
The folders that show up in the library are defined in <tt>bin/inventory/Libraries.xml</tt>. That xml file has an entry for each library. What you probably want to do is create a new library. Make a subdirectory for that library. Generate the XML files describing the folders and items in that library. Add an entry to <tt>Libraries.xml</tt> giving the name of the two XML files for your library.<br />
<br />
==Generating Inventory and Asset Files==<br />
<br />
The python script <tt>genassets.py</tt> is able to generate asset and inventory XML files at the same time. In order to use it, you must:<br />
* Arrange all of your asset files (text files for scripts and notecards, properly sized j2k files for textures) in a directory tree that corresponds to the folders you want to see in your new library.<br />
* Decide on the name of your library, and on a short version (without spaces) that will be used for filenames.<br />
<br />
Run the script. It will go through the entire directory tree where you have put your asset files. It will copy all of those asset files to an asset directory, and generate the AssetSet XML file there. (Thus, you tell the script the asset directory is your new directory underneath <tt>bin/assets</tt>, which is where you want the files to end up eventually.) It will also generate two inventory XML files, one for folders and one for items, that put all of your new assets into the library. You can make the inventory directory (to which only those two XML files are written) your new directory underneath <tt>bin/inventory</tt>.<br />
<br />
When the script is complete, you need only to edit <tt>inventory/Libraries.xml</tt> and <tt>assets/AssetSets.xml</tt> to tell it about your new library. Next time you start up OpenSim or (in grid mode) Robust, it should import your assets.<br />
<br />
'''NOTE''': the generator script replaces the XML files it finds. This means that it's not really useful for adding files to an existing library but for creating the library from whole cloth. Each time you run it, it generates new UUIDs for all of the assets. That means if you run it on a set of assets you've already imported, they will get re-imported into the asset store; the old ones ''will not'' be deleted. (They may also be used in-world already!) To avoid redundancy and cruft, you don't want to re-import things. If you want to add things to a library, just generate XML files as if they were all new. Then, merge the XML files by hand in a text editor.<br />
<br />
==Generating Inventory Files for Existing Assets==<br />
<br />
If you have assets that you've already uploaded, and you just want to have them appear in the library folders, then... there is more to be written.<br />
<br />
==Caution==<br />
<br />
(I don't know if this is true, but I seem to remember reading somewhere that in grid mode, library assets have to exist not only on the Robust server, but also on each and every individual region OpenSim server. I do not know if this is the case. If it is, it certainly complicates matters.)</div>Rknophttp://opensimulator.org/wiki/Custom_LibrariesCustom Libraries2011-07-15T05:17:26Z<p>Rknop: Massive rewriting</p>
<hr />
<div>__NOTOC__<br />
{{Quicklinks}}<br />
<br /><br />
<br />
If you want to add assets to the Library on your OpenSim server, there are two fundamental steps. The first is generating the assets, the second is generating the inventory items. The assets have information about the objects themselves; the geometry of prims, the image of textures, the text of notecards, etc. The inventory items are entries in the folders that allow users to actually access the assets.<br />
<br />
If you want ready-to-import libraries, you could check out the [[Free Assets]] section...<br />
<br />
=Generating Assets=<br />
<br />
==With the Viewer==<br />
<br />
The easiest way to generate assets is just to create them in-world, or upload them with the viewer.<br />
<br />
==In Bulk==<br />
<br />
However, if you want to create assets in bulk, for instance from a directory of image files, you can create images and add them into the default asset sets. These are found in the <tt>bin/assets</tt> directory. The file <tt>AssetSets.xml</tt> has a list of "asset sets", directories that contain the actual data for the assets and an XML file that has the metadata. Look at the XML file for the example; the format is not too complicated.<br />
<br />
Practically speaking, at the moment, you can only import lsl scripts, notecards, and textures this way. There are two steps. First, you must get the assets into the right format. Second, you must generate the XML files for the assets.<br />
<br />
===Getting Assets into the Right Formats===<br />
<br />
Notecards and lsl files are plain text files.<br />
<br />
Images have a size that is a power of two on each side. That is, both the width and height must be one of 16, 32, 64, 128, 256, 512, or 1024. They must also be in be in JPEG2000 .j2k format. You can use the [http://www.openjpeg.org/ OpenJPEG] utilities to convert from other formats to JPEG2000. Note that version 1.3 of the OpenJPEG libraries does not support greyscale images or transparency. It will fail to work on greyscale images, and will remove any alpha channel from transparent images. As of revision 824 in the OpenJPEG svn archives, it also supports transparency, and may read PNG files directly, and (at least with PNG files) handles greyscale images. It's worth compiling a more recent version [http://code.google.com/p/openjpeg/source/checkout from the svn archives], at least until a version of OpenJPEG is officially released that supports these features.<br />
<br />
Convert a single image file to OpenJPEG with<br />
<br />
<tt>image_to_j2k -i ''inputfile'' -o ''outputbase''.j2k -r 100,30,10</tt><br />
<br />
A note on compression: the values after "-r" are the compression ratios to store in the OpenJPEG file. If you upload an image with the viewer (at least with Imprudence), the list of compression ratios used is 1920,480,120,30,10. Bigger numbers mean more compression, and hence blurrier images. The advantage of storing multiple levels of compression is that when the (small amount) of data for a high level of compression is downloaded, at least that much can be rendered. This is why when you watch a texture load, it starts blurry, and (at least if you're lucky) eventually becomes sharp. A compression level of 1 is lossless... and also uses a lot of space in the asset store, and a lot of bandwidth when it's sent down. A smallest compression of 10 should be good for most purposes. However, for things like sculpt maps (or small, precise textures), you may want to add a compression ratio of 1 to the end of the arguments.<br />
<br />
Two scripts exist, a [[jp2_batch_converter|Linux script]] or [[Jp2_batch_converter_for_windows|Windows script]] in perl. They use ImageMagick and image_to_j2k to resize image files to the appropriate size and convert them to j2k files (although named with an extension of .jp2, since that's what the viewer expects for some perverse reason). However, if you want to use this, be aware of some caveats:<br />
<br />
* The script ''deletes'' your original image file.<br />
* The script ''does no error checking''. This means that if for whatever reason (and there can be several!) image_to_j2k file fails, the script will delete your image file ''anyway''. This could make you sad if, like a certain stupid wiki page editor, you didn't make backup copies first.<br />
* The script makes j2k files with compression ratios 20,10,1. While this is great for image files that are bundled with the viewer, it's not good for server-side image files. That lossless compression means gratuitous use of server asset store space and bandwidth.<br />
<br />
Maybe one day there will be an updated script....<br />
<br />
<br />
==Creating Asset Set XML Files==<br />
<br />
Once you have all your assets in the right format, you need to create the AssetSet XML file. Ultimately, you're going to want to make a new subdirectory underneath <tt>bin/assets</tt>. For example, let's suppose you're making a new asset set called <tt>MyAwesomeAssetSet</tt>. You'll need to create, in that directory, a file <tt>MyAwesomeAssetSet.xml</tt>. You can use the python script genassets.py to generate this file. It will also generate the inventory XML files needeed. This script is documented [[#Generating_Inventory_and_Asset_Files|below]].<br />
<br />
<br />
==Terrains==<br />
===Create a terrain heightmap===<br />
<br />
* [[Using_L3DT|Creating custom terrains with L3DT]]<br />
<br />
=Generating Inventory Items=<br />
<br />
The folders that show up in the library are defined in <tt>bin/inventory/Libraries.xml</tt>. That xml file has an entry for each library. What you probably want to do is create a new library. Make a subdirectory for that library. Generate the XML files describing the folders and items in that library. Add an entry to <tt>Libraries.xml</tt> giving the name of the two XML files for your library.<br />
<br />
==Generating Inventory and Asset Files==<br />
<br />
The python script <tt>genassets.py</tt> is able to generate asset and inventory XML files at the same time. In order to use it, you must:<br />
* Arrange all of your asset files (text files for scripts and notecards, properly sized j2k files for textures) in a directory tree that corresponds to the folders you want to see in your new library.<br />
* Decide on the name of your library, and on a short version (without spaces) that will be used for filenames.<br />
<br />
Run the script. It will go through the entire directory tree where you have put your asset files. It will copy all of those asset files to an asset directory, and generate the AssetSet XML file there. (Thus, you tell the script the asset directory is your new directory underneath <tt>bin/assets</tt>, which is where you want the files to end up eventually.) It will also generate two inventory XML files, one for folders and one for items, that put all of your new assets into the library. You can make the inventory directory (to which only those two XML files are written) your new directory underneath <tt>bin/inventory</tt>.<br />
<br />
When the script is complete, you need only to edit <tt>inventory/Libraries.xml</tt> and <tt>assets/AssetSets.xml</tt> to tell it about your new library. Next time you start up OpenSim or (in grid mode) Robust, it should import your assets.<br />
<br />
'''NOTE''': the generator script replaces the XML files it finds. This means that it's not really useful for adding files to an existing library but for creating the library from whole cloth. Each time you run it, it generates new UUIDs for all of the assets. That means if you run it on a set of assets you've already imported, they will get re-imported into the asset store; the old ones ''will not'' be deleted. (They may also be used in-world already!) To avoid redundancy and cruft, you don't want to re-import things. If you want to add things to a library, just generate XML files as if they were all new. Then, merge the XML files by hand in a text editor.<br />
<br />
==Generating Inventory Files for Existing Assets==<br />
<br />
If you have assets that you've already uploaded, and you just want to have them appear in the library folders, then... there is more to be written.<br />
<br />
==Caution==<br />
<br />
(I don't know if this is true, but I seem to remember reading somewhere that in grid mode, library assets have to exist not only on the Robust server, but also on each and every individual region OpenSim server. I do not know if this is the case. If it is, it certainly complicates matters.)</div>Rknophttp://opensimulator.org/wiki/Custom_LibrariesCustom Libraries2011-07-14T05:03:30Z<p>Rknop: /* Textures */</p>
<hr />
<div>__NOTOC__<br />
{{Quicklinks}}<br />
<br /><br />
Adding new content(scripts,textures,notecards,objects,etc.) to your OpenSim server isn't that hard to do. The two ways to do it are:<br />
* Using the viewer <br />
* Preparing your content, and directly importing it to the server (preferred for large amounts of content)<br />
<br />
The second method can be divided into two parts:<br />
* [[#Preparing Library]] - how to create extra items for the default inventory<br />
* [[#Importing Library]] - how to import extra items into the default inventory<br />
<br />
<br />
<br />
=Preparing Library=<br />
<br />
If you want ready-to-import libraries, you could check out the [[Free Assets]] section...<br />
<br />
==Textures==<br />
===Converting Textures===<br />
The jp2 files used by the Secondlife client, are actually j2k files. These can be encoded by image_to_j2k from openjpeg. There is a [[jp2_batch_converter|Linux script]] or [[Jp2_batch_converter_for_windows|Windows script]] in perl, that does all the work for you. It uses imageMagick and image_to_j2k to make valid input files and converts them to j2k fileformat. It then renames the j2k file to jp2 extension, so these can be used within the viewer. <br />
* Download the [http://www.tellim.com/texture_cd.tar.gz blender texture cd] (as an example)<br />
* Prepare your imagefiles (jp2 files with 16,32,64,128,256,512,1024 resolution and aspect ratios 1:1,1:2,1:4,1:8,1:16,1:32,etc. are supported)<br />
* Copy the jp2 files(including directory-structures) into the /opt/opensim/library directory<br />
<br />
'''WARNING''': this script merrily deletes the original image, without checking to make sure everything worked. If something goes wrong and the jp2 image isn't created, your image may be ''gone''. Make backup copies of the images before you try to run the script on the conversion!<br />
<br />
Version 1.3 of the OpenJPEG libraries does not support greyscale images. If you have a greyscale image, that will trigger the condition above where your image gets deleted. Version 1.3 of the OpenJPEG libraries also does not support transparency.<br />
<br />
As of revision 824 of the OpenJPEG SVN library, image_to_j2k is able to write out jp2 files directly. (The script assumes that only j2k files may be written, and does a rename. It also supports transparency, and may read PNG files directly, and (at least with PNG files) handles greyscale images. It's worth compiling one of those versions. "Somebody should" update the conversion script to be safer. (Yeah, yeah, I know.)<br />
<br />
==Terrains==<br />
===Create a terrain heightmap===<br />
<br />
* [[Using_L3DT|Creating custom terrains with L3DT]]<br />
<br />
<br />
<br />
=Importing Library=<br />
<br />
==Creating a custom library==<br />
* Create the appropriate xml storage files using the [[assets_generator|Asset Generator]] script<br />
* Edit the opensim inventory library reference file<br />
nano /opt/opensim/production/bin/inventory/Libraries.xml<br />
* Add the inventory reference<br />
<Section Name="OpenSim Custom Library"><br />
<Key Name="foldersFile" Value="MyCoolOpenSimLibrary/3DDCInventoryFolders.xml"/><br />
<Key Name="itemsFile" Value="MyCoolOpenSimLibrary/3DDCInventoryItems.xml"/><br />
</Section> <br />
* Edit the opensim assets library reference file<br />
nano /opt/opensim/production/bin/assets/AssetSets.xml<br />
* Add the asset reference<br />
<Section Name="OpenSim Custom Asset Set"><br />
<Key Name="file" Value="MyCoolOpenSimAssetSet/3DDCAssetSet.xml"/><br />
</Section><br />
* Restart OpenSim<br />
* Check out if the textures are rendered correctly in the viewer<br />
<br />
==Load Terrain==<br />
Assume your file is called "terrain.r32".At the region console, type:<br><br />
script terrain load terrain.r32<br />
You now have your new terrain! You can at this point use the terrain add, terrain scale, or terrain multiply to rescale it to your liking.</div>Rknophttp://opensimulator.org/wiki/External_FilesExternal Files2011-07-12T23:51:50Z<p>Rknop: /* External Files */</p>
<hr />
<div>__NOTOC__<br />
{{Quicklinks}}<br />
<br /><br />
<br />
{{content}}<br />
<br />
== External Files ==<br />
In the bin directory of the OpenSim distribution are three example html files.<br />
* http_404.html.example<br />
* http_500.html.example<br />
* http_loginform.html.example<br />
<br />
For account management from the web on OpenSimulator 0.7 and later, take a look at the [[Wifi]] module created by Diva Canto</div>Rknophttp://opensimulator.org/wiki/ConfigurationConfiguration2011-07-12T22:48:38Z<p>Rknop: /* Note About Mono */</p>
<hr />
<div>{{Quicklinks}}<br />
<br /><br />
==OpenSim simulator configuration file==<br />
The region simulator configuration is managed using a file called OpenSim.ini. This file is used regardless of whether the sim is running in standalone or grid mode. This file references some additional configuration information from the config-include/ directory. Information about the various settings is contained in the OpenSim.ini file itself (or OpenSim.ini.example for reference).<br />
<br />
Please note, that the name OpenSim.ini can be changed via [[OpenSim.exe Command Line Options|command line arguments]].<br />
<br />
It is also possible to distribute the inifile settings over two files. This is useful if you want to run several OpenSim processes where most of your settings are identical except for a few. The master file is read first, then the inifile is read. Settings given in the inifile overrule settings given in the master file. The master file has the same format and the same keywords as the inifile, so the same documentation applies.<br />
<br />
== Database ==<br />
<br />
Opensim supports the following database-engines. Information about setting these up can be found in the OpenSim.ini.example file and the other various example files in bin/config-include. See [[Database Settings]] to know the detailed settings for each database.<br />
<br />
*'''SQLite''' (default) - a lightweight database that comes bundled with OpenSim and can be used without requiring any extra configuration. It is mostly intended to get you up and running quickly, not for production use. It is significantly slower than MySQL. A few features here (such as attachment persistence) have not yet been fully implemented. <br />
<br />
*'''MySQL 5.1''' (fully supported) - This is the recommended database for any use beyond experimentation or small standalone applications. <br />
::*'''OpenSim 0.7.1:''' It supports MySQL 5.5 out of the box.<br />
::*'''Windows x64 systems:''' &nbsp;There is currently an unresolved [http://opensimulator.org/mantis/bug_view_advanced_page.php?bug_id=5294 bug_id=5294] found when running OpenSim with MySQL 5.5 on Windows x64 systems.<br />
::*'''Opensim 0.7.0.2:''' &nbsp;Some users have reported problems with MySQL 5.1.55 and up with Opensim 0.7.0.2, see [http://opensim-users.2152040.n2.nabble.com/OpenSim-1-7-0-2-and-MySQL-Versions-td6155064.html this thread] for more information. The issue can be resolved by using an updated version of MySql.Data.dll OR installing an older version of MySQL such as [http://downloads.mysql.com/archives.php?p=mysql-5.1&v=5.1.52 MySQL 5.1.52] with Opensim version 0.7.0.2. &nbsp;<br />
<br />
*'''MSSQL''' (partially supported) - some recent OpenSim features may not yet be implemented.<br />
<br />
==Standalone vs. Grid==<br />
We recommend that you first get OpenSim running in standalone mode before you attempt to connect it to a grid or run your own grid. OpenSim will start up in standalone mode out-of-the-box on the binary distributions.<br />
<br />
An OpenSim configuration consists of regions (run by region simulators) and backend data services (such as user, assets and inventory management).<br />
<br />
A system running in '''standalone mode''' runs both the region simulator and all the data services in a single process when you run OpenSim.exe. In this mode you can run as many regions as you like but only on a single machine.<br />
<br />
[[image:Opensim-standalone.png|frame|center|OpenSim running in standalone mode. Both simulator and services run in the same process (OpenSim.exe).]]<br />
<br />
In '''grid mode''', the data services are not part of the region server process. Instead, they are run in a separate executable called Robust.exe. A Robust shell can run all the services or they can be split amongst any number of Robust instances. This allows them to be run on entirely separate machines if necessary. In this mode, the OpenSim.exe acts solely as the region server, serving one or more regions that communicate with the separate data services. At this point you can run multiple OpenSim.exe region simulators on different machines.<br />
<br />
[[image:Opensim-grid-simple.png|frame|center|OpenSim running in grid mode. In this case, all the services are being run within a Robust.exe process. Multiple copies of OpenSim.exe (usually running on different machines) all use the same set of common services.]]<br />
<br />
Running in grid mode is more complicated than running in standalone mode. It requires an understanding of UUID, X,Y location, server handshake passwords, estates and estate owners, and a couple of other settings. These require more care and patience to set up. We strongly recommend that you don't attempt this unless you are extremely patient and very technically proficient.<br />
<br />
= Running OpenSim in Standalone mode =<br />
Getting a binary distribution of OpenSim running in standalone configuration is relatively straightforward since it's configured this way by default. On the other hand, if you build OpenSim from the source distribution or from the git repository then you will need to:<br />
<br />
# Copy the bin/OpenSim.ini.example file to bin/OpenSim.ini. This configures the 3D simulator itself.<br />
# Copy the bin/config-include/StandaloneCommon.ini.example file to bin/config-include/StandaloneCommon.ini. This configures the in-process data services used by the standalone configuration.<br />
# In the [Architecture] section of OpenSim.ini at the bottom of the file, uncomment the Standalone.ini line. To uncomment a line of code, remove the semi-colon (;) comment symbols preceding the line so that it says:<br />
<br />
Include-Architecture = "config-include/Standalone.ini"<br />
<br />
<br />
Running OpenSim is then a matter of launching OpenSim.exe. However, you need to have installed all dependencies before that. See [[Dependencies]] for details. After that, open a command prompt (for Windows users, Start menu > Run > cmd) and navigate to the Opensim /bin directory.<br />
<br />
On a '''Windows 32-bit''' command prompt:<br />
OpenSim.exe<br />
Under '''Windows 64-bit''', ODE cannot yet be compiled for 64 bit mode, so if using the default ODE physics plugin run:<br />
OpenSim.32BitLaunch.exe<br />
On '''Linux''' run:<br />
mono OpenSim.exe<br />
This can be done under both 32 and 64 bit modes with the ODE physics engine.<br />
<br />
== Running OpenSim for the first time ==<br />
<br />
If you're running OpenSim for the first time, it will ask you several questions at the console that will set up a single region for you. The configuration options you enter will be written to the bin/Regions/Regions.ini file, which you can then edit at a later date if you need to make changes.<br />
<br />
Many of the questions have defaults. Here are some explanations of the questions asked:<br />
<br />
* '''New region name'''<br />
::The name for your region. Don't leave this blank!<br />
* '''Region UUID'''<br />
::The unique ID of your region. In pretty much all cases you will want to accept the randomly generated default in the square brackets. The only time when you wouldn't is if you were trying to set up a configuration to point to pre-existing region data. But in this case you are probably better off editing the Regions.ini file directly anyway<br />
* '''Region Location'''<br />
::This is the location of the region on the grid. In standalone mode you can safely leave these as the default (1000,1000). If you were to set up additional regions later on in Regions.ini then they would need different grid co-ordinates (e.g. 1000,1001). OpenSim regions can be placed anywhere on a 65536 by 65536 grid, but [[Hypergrid]] enabled regions may need special consideration for region location. See [[Installing_and_Running_Hypergrid#The_4096_Regions_Limit]] for more information.<br />
* '''Internal IP address'''<br />
::In virtually all cases this can be left as 0.0.0.0 (this is a wildcard that allows OpenSim to listen for UDP connections on any of the server's network interfaces). If you want to restrict UDP connections to only one network interface then you can specify an explicit IP address. This address is only used internally - the '''External host name''' is the one that is actually passed to the viewer (and hence is the important one).<br />
* '''Internal port'''<br />
::This is the IP port for all incoming client connections. The name is a bit misleading since it will be used externally (by a Second Life viewer, for instance) as well as internally. You can make this any port you want, but it is safe to leave at the default 9000. Each region on your server must have a unique port.<br />
* '''Allow alternate ports'''<br />
::This is currently experimental. Please leave it at the default of False.<br />
* '''External host name'''<br />
::If you leave this at the default 'SYSTEMIP' then this will become the LAN network address of the machine (e.g. 192.168.1.2). This is fine if you are connecting only from within your LAN. If you want to connect to it from a client on the internet, this should be the External IP Address of your router. Fully Qualified Domain Names (FQDNs) can also be used though they will be converted to a numeric IP address before being sent to the viewer.<br />
<br />
The following details are also asked in OpenSim 0.6.9 and earlier.<br />
<br />
* '''Master Avatar UUID'''<br />
::This is a legacy OpenSim feature and can be left at the default of 00000000-0000-0000-0000-000000000000. Later on, you may want to change this to your own avatar's UUID in Regions.ini if you have problems editing terrain.<br />
* '''Master Avatar first name'''<br />
::This is an alternative way of specifying the master avatar by avatar name rather than UUID. If you press enter here then both this field and the last name field will be left blank. Accepting the blank default is fine - this can always be changed later in Regions.ini file.<br />
* '''Master Avatar last name'''<br />
::The last name of the master avatar.<br />
* '''Master Avatar sandbox password'''<br />
::The password of the master avatar.<br />
<br />
In OpenSim 0.7 and later, OpenSim will ask you to assign each region to an estate during the setup process. If an estate needs to be created then it will also ask you to assign an estate manager. In standalone mode, an estate manager can also be created during the setup process.<br />
<br />
Don't forget the account details you use to set up the master avatar (in 0.6.9) or the estate manager (in 0.7 and later). Only this user will initially be able to configure the in-world settings for your region. This is also a user account that you can use to perform your initial login test.<br />
<br />
See [[Configuring Regions]] for more information about the Regions.ini file that these questions generate.<br />
<br />
If you want to create a user other than the estate manager, then in the server console type:<br />
<br />
create user<br />
<br />
This will ask you a series of questions for creating a user (such as first name, last name and password).<br />
<br />
== Connecting to OpenSim ==<br />
<br />
To connect to your new sim with your user, start up a Second Life viewer with the following command line switches:<br />
<br />
'''Client on same machine as OpenSim:'''<br />
-loginuri http://127.0.0.1:9000<br />
<br />
'''Client on same LAN as OpenSim:'''<br />
-loginuri http://lan_ip:9000<br />
<br />
'''Client on different machine or internet:'''<br />
-loginuri http://external_ip:9000<br />
<br />
Then enter the user name and password you set up in the previous step and your new user should login.<br />
<br />
Be aware of [http://osgrid.org/forums/viewtopic.php?f=5&t=400&start=0&st=0&sk=t&sd=a loopback] problems when Running viewer &amp; server(s) on the same machine (LAN) by using the "external" configuration. (<u>'''You might notice endless waiting for region handshake'''</u>.) See also [[Troubleshooting|troubleshoot hints]]. If you're having Connectivity problems, [[Network_Settings|be sure to read the Network Configuration Page]]. This is important if you see Region handshake issues<br />
<br />
= Running OpenSim in Grid mode =<br />
{|<br />
| style="background:LavenderBlush; color:black" |<br />
[[Image:Exclamation.png|left]]<br />
NOTE: 0.7 is the first OpenSim release that fully migrates all services to the ROBUST server shell. OpenSim.Grid.UserServer.exe and MessageServer.exe from OpenSim 0.6.9 are no longer necessary. Please see the [[0.7_Release|0.7 release notes]] for more details. For details on how to set up grid services in OpenSim 0.6.9 and earlier please see [[OpenSim 0.6.9 Grid Mode Configuration]]<br />
|}<br />
<br />
Running OpenSim in grid mode is considerably more complicated than running a standalone instance. Instead of running everything in the same process, backend data services (asset, inventory, etc.) run in one or more separate processes, often on a different machine. This allows multiple OpenSim.exe simulator instances to use the same asset and inventory data.<br />
<br />
== Step 1: Set up a ROBUST services instance ==<br />
<br />
1. In the bin directory, copy Robust.ini.example to Robust.ini. The example file is configured to run all the services in a single ROBUST instance.<br />
<br />
2. Configure the [DatabaseService] section of Robust.ini to use your MySQL database. Only MySQL is supported for running grid services.<br />
<br />
3. Start up Robust.exe. <br />
<br />
mono Robust.exe (Linux, BSD, Mac OS X)<br />
<br />
or<br />
<br />
Robust.exe (Windows)<br />
<br />
If you don't see any errors (in red) on the console then you can move on to the next step.<br />
<br />
4. Every region must belong to an estate, and every estate must have an owner which is a valid user account in OpenSim's user account service. Create a user on the ROBUST command console with the following command.<br />
<br />
create user<br />
<br />
This will ask you for the user's name, password and an optional e-mail. Remember this name since you will need it when you start up the simulator for the first time.<br />
<br />
== Step 2: Configure an OpenSim.exe to use the ROBUST services == <br />
<br />
In grid mode, as in standalone mode, you need to configure OpenSim.ini which controls the 3D simulator itself.<br />
<br />
However, instead of using and configuring the file config-include/StandaloneCommon.ini, a simulator connecting to a grid needs to use and configure the config-include/GridCommon.ini file, in order to connect to the ROBUST hosted remote data services rather than in-process local ones.<br />
<br />
The steps for both these operations are as follows.<br />
<br />
1. Copy bin/OpenSim.ini.example to OpenSim.ini<br />
<br />
2. Find the [Architecture] section at the very bottom of OpenSim.ini. Make sure that one of the following lines is uncommented:<br />
<br />
Include-Architecture = "config-include/Grid.ini" (in OpenSim 0.7.1 and later)<br />
<br />
or<br />
<br />
Include-Grid = "config-include/Grid.ini" (in OpenSim 0.7.0.2 and earlier)<br />
<br />
The others should remain commented.<br />
<br />
3. Go to bin/config-include and copy GridCommon.ini.example to GridCommon.ini.<br />
<br />
4. Open GridCommon.ini in a text editor. You will see lots of URL entries, each of which have dummy defaults of http://myassetserver.com:8003, http://myinventoryserver.com:8003, etc. You will need to change each of these to point towards the address of your ROBUST instance. For instance, if you're running ROBUST on a machine with a local IP address of 192.168.1.2, you will need to change AssetServerURI to the setting<br />
<br />
AssetServerURI = "http://192.168.1.2:8003"<br />
<br />
5. Run OpenSim.exe. If you're running OpenSim.exe for the first time you will get the same questions about setting up the region that occur on a first-run in standalone mode. Please see the standalone section for instructions on how to answer these, or read more information about the Regions.ini file on the [[Configuring Regions]] page.<br />
<br />
If everything is set up correctly, when starting up OpenSim.exe you shouldn't see any errors. You should also see the ROBUST console display log lines saying that the region has registered with the grid service. For example,<br />
<br />
21:43:45 - [GRID SERVICE]: Region t1 (176cc95e-f693-4b02-8e08-af86e2372faa) registered successfully at 256000-256000<br />
21:43:47 - [GRID SERVICE]: region t1 has 0 neighbours<br />
<br />
6. Login with a client. Your client startup line will look something like<br />
<br />
-loginuri http://192.168.1.2:8002<br />
<br />
The loginuri needs to be the address to the login service. In standalone mode, this was the same address as the region simulator and the port was 9000 by default. However, in grid mode it will be the address to login service hosted on the ROBUST instance. In this case, the address will be 192.168.1.2. The port number of 8002 is the traditional one for the grid login service and is the default in Robust.ini.example.<br />
<br />
7. If the login is successful, you will see log lines on the ROBUST console (for the login itself) and then log lines on the region simulator console (as the login process tells the simulator to expect the avatar, tells the viewer the address of the region simulator and then when the viewer starts talking to the simulator directly).<br />
<br />
==Attaching your sim to someone else's grid==<br />
<br />
To set up the region server (i.e., <tt>OpenSim.exe</tt>) to connect to an external grid, follow the [[Configuration#Step_2:_Configure_an_OpenSim.exe_to_use_the_ROBUST_services]] instructions above.<br />
<br />
The grid will have already provided with the required services. In step 2 you will need to use the provided URLs for their services.<br />
<br />
In your bin/Regions.ini file (or other region config file) you will also need to set the grid co-ordinates to your regions provided from the grid operator. See [[Configuring Regions]] for more information.<br />
<br />
=Running an OpenSim standalone or grid installation with Hypergrid enabled=<br />
[[Hypergrid]] is an emerging architecture supported by OpenSimulator that allows a user with an account on one standalone or grid to visit other Hypergrid-enabled standalones or grids, and for users from those grids to visit the home grid. This does not require the two installations to share a central set of data services (assets, inventory, etc.). Please see [[Installing and Running Hypergrid]] for more details.<br />
<br />
=Further notes=<br />
<br />
==Troubleshooting==<br />
<br />
See [[Troubleshooting]] <br />
<br />
==Running OpenSim 0.6.7 and onwards in 64 bit Windows==<br />
[[Image:Exclamation.png|left]]<br />
As of OpenSim 0.6.7, the default physics engine for OpenSim was changed to the ODE engine. This is because ODE is by far the most advanced physics engine plugin currently in OpenSim. Unfortunately, it has the drawback in that its library is not compilable under 64-bit in Windows. <br />
<br />
Therefore, in order to launch the region simulator, 64-bit Windows users may need to run: <br />
<br />
OpenSim.32BitLaunch.exe<br />
<br />
instead of:<br />
<br />
OpenSim.exe<br />
<br />
An alternative is to use the basicphysics engine instead or one of the other alternative physics engines bundled with OpenSim, though all these are far less functional than the ODE plugin.<br />
<br />
==Note About Mono==<br />
<br />
''This only applies for Mono before 2.6. More recent versions of Mono have better thread handling. For more information, see [http://www.mono-project.com/ThreadPool_DeadLocks ThreadPool_Deadlocks at the mono-project website].''<br />
<br />
If you're using mono, you should increase the value of the mono environment variable MONO_THREADS_PER_CPU from its default of 5 to some number that works for your sim. The exact number depends on many factors including: the number of CPUs in your machine, what else you use that machine for, how many regions you have in your sim, how many of them are adjacent, how many scripts you have, and how many avatars you expect to serve at the same time. As a reference, Wright Plaza in OSGrid, which is running as a single region on a sim and routinely hosts meetings with 20 avatars, uses the value 125. <br />
<br />
If this number is too low, the operation of your sim will start to break in all sorts of different ways. A common symptom is the freezing of all activity upon login of a new avatar. Other symptoms are a lot more subtle.<br />
<br />
For example: $ export MONO_THREADS_PER_CPU=125<br />
<br />
==Increasing the stack reserve level when using OpenDynamicsEngine on *nix==<br />
<br />
If you have problems using the OpenDynamicsEngine on *nix, try setting your stack reserve level higher than the default with the following command;<br />
<tt>ulimit -s 262144</tt> Or, run the opensim-ode.sh to start up OpenSimulator.<br />
<br />
== Firewalls ==<br />
Some operation systems or distributions run their own firewall by default. If you can't access to OpenSimulator from remote client, you'll need to check their settings. See [[Firewall Settings]] for details.<br />
<br />
== Legacy Configuration Information ==<br />
These are some pages containing some legacy configuration information of unknown accuracy.<br />
<br />
[[OpenSim 0.6.6 legacy configuration information]]<br />
<br />
<br />
== Additional Optional Configuration Tasks ==<br />
<br />
===Futher configuring OpenSim===<br />
<br />
If you've looked through OpenSim.ini.example or any other of the config files, you'll see that there's a very large number of configurable parameters. See [[Configuring Simulator Parameters]] for more details.<br />
<br />
===OpenSim.exe command line options===<br />
OpenSim.exe has command line options which allow you to perform actions such as reading configuration files from a different directory. See [[OpenSim.exe Command Line Options]] for more details.<br />
<br />
===Script engine===<br />
OpenSim supports multiple script engines. See [[ScriptEngines]] for details. If you don't know what this means then the default script engine will be fine. In fact, recent versions of OpenSim only ship with one script engine, the XEngine.<br />
<br />
===Permissions Configuration===<br />
OpenSim has a quite elaborate set of permissions. See [[Permissions (Server)]] for details. By default, permissions are not active on region simulators.<br />
<br />
=== Logging ===<br />
By default, OpenSim logs information to a file called OpenSim.log in the bin directory. See [[Logging]] for details on how to further configure this if required.<br />
<br />
=== Configuration of region modules ===<br />
* [[IRCBridgeModule]]<br />
* [[Freeswitch_Module]]<br />
* [[Offline Messaging]]<br />
<br />
=== Configuration of Metaverse Exchange Protocol (MXP) ===<br />
* [[Metaverse Exchange Protocol]]<br />
<br />
=== Configuration of Web Server and Pages===<br />
OpenSim contains a web server that can serve up a variety of pages. Some which come from external files and some are generated internally.<br />
* [[External Files]]<br />
* [[Internally Generated]]<br />
<br />
=== Configuration of Multiple Standalone Regions on the Same Server ===<br />
For the second region, change 'http_listener_port' in OpenSim.ini to the value excluding 9000, and 'InternalPort' in Regions.ini to the value excluding 9000.<br />
<br />
= Where to go from here =<br />
<br />
*[[Upgrading]] to mySQL from SQLite.<br />
<br />
*[[Server Commands]] for creating users and controlling the system.<br />
<br />
*Fix the bent knees bug: [[FAQ#Why_are_my_knees_bent_when_I_stand_idle.3F]]<br />
<br />
<br />
=References=<br />
<br />
* [http://dist.opensimulator.org/wiki/opensim-standalone.odg OpenOffice draw file for OpenSim standalone diagram]<br />
* [http://dist.opensimulator.org/wiki/opensim-grid-simple.odg OpenOffice draw file for OpenSim grid diagram]<br />
<br />
[[Category:Configuration]]</div>Rknophttp://opensimulator.org/wiki/Physics_Engine_InterfacePhysics Engine Interface2009-09-18T20:24:48Z<p>Rknop: /* PhysicsActor */</p>
<hr />
<div>== Base Classes ==<br />
<br />
''Note: I ([[User:Rknop]]) am trying to figure this out by looking at some of the code; my main interest is the NewtonPlugin. AS such, there are whole swaths of the physics engine, such as joints, that I have no clue about at the moment''<br />
<br />
The base classes for a physics module can be found in OpenSim.Region.Physics.Manager. The physics module itself should be a subclass of Physics, e.g. OpenSim.Region.Physics.OdePlugin.<br />
<br />
* '''<tt>PhysicsActor</tt>''' is the base class for both prims and avatars.<br />
* '''<tt>PhysicsScene</tt>''' is the main base class that interfaces with the region's Scene.<br />
* (others)<br />
<br />
The Physics Scene doesn't access the Region Scene. The region scene will tell the physics engine about prims and avatars, and will send updates to the physics engine. It will then pull positions and velocities of objects and avatars out of the physics engine.<br />
<br />
For the most part, the things that will be interfacing with the physics engine are the classes <tt>OpenSim.Region.Framework.Scenes.Scene</tt>, <tt>OpenSim.Region.Framework.Scenes.SceneObjectGroup</tt>, and <tt>OpenSim.Region.Framework.Scenes.SceneObjectPart</tt><br />
<br />
== The Plugin Class ==<br />
<br />
If you're writing a Physics engine named Foo, you need to write a class OpenSim.Region.Physics.FooPlugin with the following methods:<br />
<br />
* '''FooPlugin()''' &mdash; constructor<br />
* '''bool Init()''' &mdash; (not sure exactly when this is called. return true)<br />
* '''PhysicsScene GetScene(String sceneIdentifier)''' &mdash; return a FooScene, which is derived from PhysicsScene<br />
* '''string GetName()''' &mdash; return the name that folks can use in OpenSim.ini to select this physics engine<br />
* '''Dispose()''' &mdash; destructor<br />
<br />
== PhysicsScene ==<br />
<br />
Your class OpenSim.Region.Physics.FooScene must derive from OpenSim.Region.Physics.PhysicsScene. Members include:<br />
<br />
<dl><br />
<dt>'''public override void Initialize(IMesher meshmerizer, IConfigSource config)'''<br />
<br />
<dt>'''public override PhysicsActor AddAvatar(string avName, PhysicsVector position, PhysicsVector size, bool isFlying)'''<br />
<br />
<dt>'''public override void SetWaterLevel(float baseheight)'''<br />
<br />
<dt>'''public override void RemovePrim(PhysicsActor prim)'''<br />
<dd> This gets called when a prim is made into something the physics engine no longer needs to know about. The physics engine should remove it from any internal lists of prims it is keeping track of.<br />
<br />
<dt>'''public override void RemoveAvatar(PhysicsActor character)'''<br />
<dd> Like RemovePrim, but for avatars.<br />
<br />
<dt>'''public override PhysicsActor AddPrimShape(string primName, PrimitiveBaseShape pbs, PhysicsVector position, PhysicsVector size, Quarternion rotation)'''<br />
<dd> Tells the physics engine to add a new prim it needs to keep track of. This prim is ''not'' a physical prim, but as long as it's not phantom, physical objects may collide with it, and thus the physics engine (may) need to know about it. (Unless the physics engine punts on collisions, as, for instance, NewtonPlugin does.) Comments in the code indicate that this method is slated to be removed....<br />
<br />
<dt>'''public override PhysicsActor AddPrimShape(string primName, PrimitiveBaseShape pbs, PhysicsVector position, PhysicsVector size, Quarternion rotation, bool isPhysical)'''<br />
<dd>Like the previous one, but you've got the flag that tells you if it's physical or not.<br />
<br />
<dt>'''public override void AddPhysicsActorTaint(PhysicsActor prim)'''<br />
<dd>(I don't know what taints are, so I can't document them yet....)<br />
<br />
<dt>'''public override void GetResults()'''<br />
<br />
<dt>'''public override bol IsThreaded'''<br />
<dd>A member that needs a get method.<br />
<br />
<dt>'''public override void SetTerrain(float[] heightMap)'''<br />
<br />
<dt>'''public override void DeleteTerrain()'''<br />
<br />
<dt>'''public overrid Dictionary<unit, float> GetTopColliders()<br />
<br />
<dt>'''public override float Simulate(float timestep)'''<br />
<dd>This is the core function. This gets called by the main loop when it wants the Physics engine to do its magic and propagate forward the positions and velocities of all the stuff it knows about. The physics engine should update the Position and Velocity members of the PhysicsActor class it knows about (those things that have been added to it by the methods above). '''Important:''' when the physics engine thinks that things have changed enough for any given prims that the surrounding scene should updates it's own idea about the positions and velocities of those prims, it should call the RequestPhysicsterseUpdate() method of the changed PhysicsActors(). (The safest, but slowest, way to do this is for Simulate() to call this for every physical prim it knows about every time it is called.)<br />
<br />
</dl><br />
<br />
== PhysicsActor ==<br />
<br />
PhysicsActor represents both prims and characters. You may want to make separate classes for the two. You can get away with this because PhysicsActors are actually created by PhysicsScene. Your subclass of PhysicsScene has different methods called when an avatar or a prim is added to the scene, returning a PhysicsActor. You can return the appropriate subclass in each case.<br />
<br />
Members:<br />
<br />
<dl><br />
<dt>'''int PhysicsActorType'''<br />
<dd>Needs get and set methods. Return ActorTypes.Prim or ActorTypes.Agent if it's a prim or an avatar.<br />
<br />
<dt>'''bool IsPhysical'''<br />
<dd>Needs get and set<br />
<br />
<dt>'''PhysicsVector Position'''<br />
<dd>Needs get and set. If an object is physical, the physics engine keeps the "real" position for that object. However, it's the surrounding scene's impression of the position that gets rendered and sent to the client. It will pull the position out of the physics engine by looking at this member, and tell the physics engine about any external changes in its position through this member. Note that the scene doesn't automatically pull out the position, but only when it thinks it needs to. You can call the RequestPhysicsterseUpdate() method of PhysicsActor to ask the Scene to update its position for any given PhysicsActor. (See PhysicsScene.Simulate() above.)<br />
<br />
<dt>'''PhysicsVector Velocity'''<br />
<dd>Need get and set. Similar considerations to Position<br />
<br />
<dt>'''PhysicsVector RotationalVelocity'''<br />
<dd>Needs get and set<br />
<br />
<dt>'''PhysicsVector Acceleration'''<br />
<dd>Needs get; there's no set method.<br />
<br />
<dt>'''void SetAcceleration(PhysicsVector accel)'''<br />
<dd>Do what you'd think Acceleration.set would do<br />
<br />
<dt>'''PhysicsVector Size'''<br />
<dd>Needs get and set<br />
<br />
<dt>'''float Mass'''<br />
<dd>Needs get; there is no set method at the moment<br />
<br />
<dt>'''void SetMass(float mass)'''<br />
<dd>Instead of Mass.set<br />
<br />
<dt>'''void SetMomentum(PhysicsVector momentum)'''<br />
<dd>I am disturbed that this exists in addition to Velocity.set and SetMass....<br />
<br />
<dt>'''Quarternion Orientation'''<br />
<dd>Needs get and set<br />
<br />
<dt>'''bool ThrottleUpdates'''<br />
<dd>Needs get and set. I'm not sure what this means, exactly.<br />
<br />
<dt>'''bool IsColliding'''<br />
<dd>Needs get and set.<br />
<br />
<dt>'''bool CollidingGround'''<br />
<dd>Needs get and set<br />
<br />
<dt>'''bool CollidingObj'''<br />
<dd>Needs get and set<br />
<br />
<dt>'''bool Stopped'''<br />
<dd>Just needs get<br />
<br />
<dt>'''PhysicsVector CenterOfMass'''<br />
<dd>Just needs get<br />
<br />
<dt>'''PhysicsVector GeometricCenter'''<br />
<dd>Just needs get<br />
<br />
<dt>'''PrimitiveBaseShape Shape'''<br />
<dd>Just needs set<br />
<br />
<dt>'''PhysicsVector Force'''<br />
<dd>Needs get and set. I ''think'' this is a steady force (in N) always acting on the object.<br />
<br />
<dt>'''PhysicsVector Torque'''<br />
<dd>Needs get and set. Like Force, I think this is a steady torque operating on the object.<br />
<br />
<dt>'''void AddForce(PhysicsVector force, bool pushforce)'''<br />
<dd>This should apply a one-time impulse to the object of magnitude "force" Newton-seconds. I am not sure what "pushforce" means....<br />
<br />
<dt>'''void AddAngularForce(PhsyicsVector force, bool pushforce)'''<br />
<dd>A one-time angular impulse. I'm not sure the units, nor what pushforce means.<br />
<br />
<dt>'''int VehicleType'''<br />
<dd>(I don't know anything about the vehicle code requirements)<br />
<br />
<dt>'''void VehicleFloatParam(int param, float value)'''<br />
<br />
<dt>'''void VehicleVectorParam(int param, PhysicsVector value)'''<br />
<br />
<dt>'''void VehicleRotationParam(int param, Quarternion rotation)'''<br />
<br />
<dt>'''void SetVoulumeDetect(int param)'''<br />
<dd>This is some weird mode that can be set via a LSL function<br />
<br />
<dt>'''float Buoyancy'''<br />
<dd>Needs get and set<br />
<br />
<dt>'''bool FloatOnWater'''<br />
<dd>Just needs set<br />
<br />
<dt>'''float CollisionScore'''<br />
<dd>Needs get and set. I don't know what this is.<br />
<br />
<dt>'''bool Flying'''<br />
<dd>Needs get and set<br />
<br />
<dt>'''bool SetAlwaysRun'''<br />
<dd>Needs get and set<br />
<br />
<dt>'''unit LocalID'''<br />
<dd>Needs set. I don't know what this is<br />
<br />
<dt>'''bool Grabbed'''<br />
<dd>Needs set. I'm not sure what this is, but I'm guessing it's when you control-click on an object?<br />
<br />
<dt>'''void link(PhysicsActor obj)'''<br />
<dd>I haven't delved into how linking works in the physics engine. I'm ''guessing'' that this says "link yourself to obj with obj as the root", but I could be wrong.<br />
<br />
<dt>'''void delink()'''<br />
<br />
<dt>'''void LockAngularMomentum(PhysicsVector axis)'''<br />
<br />
<dt>'''bool Selected'''<br />
<dd>Just needs set<br />
<br />
<dt>'''void CrossingFailure()'''<br />
<br />
<dt>'''PhysicsVector PIDTarget'''<br />
<dd>Just needs set. I don't know what this is, but I'm guessing it's a place to which an object is supposed to move.<br />
<br />
<dt>'''bool PIDActive'''<br />
<dd>Just needs set.<br />
<br />
<dt>'''float PIDTau'''<br />
<dd>Just needs set. I'm guessing that this is the timescale (in seconds) in which the object should move to PIDTarget when it is set to be PID Active.<br />
<br />
<dt>'''float PIDHoverHeight'''<br />
<br />
<dt>'''float PIDHoverActive'''<br />
<br />
<dt>'''PIDHoverType PIDHoverType'''<br />
<br />
<dt>'''float PIDHoverTau'''<br />
<br />
<dt>'''void SubscribeEvents(int ms)'''<br />
<dd>I do not know what sorts of events the PhysicsActor sends... hopefully I'll update this if/when I figure that out! It looks like you can ask for OnPositionUpdate, OnVelocityUpdate, OnOrientationUpdate, OnRequestTerseUpdate, OnCollisionUpdate, and OnOutOfBounds... but I have yet to fully understand the OpenSim event system, so I may be speaking out of the side of my mouth here.<br />
<br />
<dt>'''bool SubscribedEvents()'''</div>Rknophttp://opensimulator.org/wiki/Physics_Engine_InterfacePhysics Engine Interface2009-09-18T20:24:03Z<p>Rknop: /* PhysicsScene */</p>
<hr />
<div>== Base Classes ==<br />
<br />
''Note: I ([[User:Rknop]]) am trying to figure this out by looking at some of the code; my main interest is the NewtonPlugin. AS such, there are whole swaths of the physics engine, such as joints, that I have no clue about at the moment''<br />
<br />
The base classes for a physics module can be found in OpenSim.Region.Physics.Manager. The physics module itself should be a subclass of Physics, e.g. OpenSim.Region.Physics.OdePlugin.<br />
<br />
* '''<tt>PhysicsActor</tt>''' is the base class for both prims and avatars.<br />
* '''<tt>PhysicsScene</tt>''' is the main base class that interfaces with the region's Scene.<br />
* (others)<br />
<br />
The Physics Scene doesn't access the Region Scene. The region scene will tell the physics engine about prims and avatars, and will send updates to the physics engine. It will then pull positions and velocities of objects and avatars out of the physics engine.<br />
<br />
For the most part, the things that will be interfacing with the physics engine are the classes <tt>OpenSim.Region.Framework.Scenes.Scene</tt>, <tt>OpenSim.Region.Framework.Scenes.SceneObjectGroup</tt>, and <tt>OpenSim.Region.Framework.Scenes.SceneObjectPart</tt><br />
<br />
== The Plugin Class ==<br />
<br />
If you're writing a Physics engine named Foo, you need to write a class OpenSim.Region.Physics.FooPlugin with the following methods:<br />
<br />
* '''FooPlugin()''' &mdash; constructor<br />
* '''bool Init()''' &mdash; (not sure exactly when this is called. return true)<br />
* '''PhysicsScene GetScene(String sceneIdentifier)''' &mdash; return a FooScene, which is derived from PhysicsScene<br />
* '''string GetName()''' &mdash; return the name that folks can use in OpenSim.ini to select this physics engine<br />
* '''Dispose()''' &mdash; destructor<br />
<br />
== PhysicsScene ==<br />
<br />
Your class OpenSim.Region.Physics.FooScene must derive from OpenSim.Region.Physics.PhysicsScene. Members include:<br />
<br />
<dl><br />
<dt>'''public override void Initialize(IMesher meshmerizer, IConfigSource config)'''<br />
<br />
<dt>'''public override PhysicsActor AddAvatar(string avName, PhysicsVector position, PhysicsVector size, bool isFlying)'''<br />
<br />
<dt>'''public override void SetWaterLevel(float baseheight)'''<br />
<br />
<dt>'''public override void RemovePrim(PhysicsActor prim)'''<br />
<dd> This gets called when a prim is made into something the physics engine no longer needs to know about. The physics engine should remove it from any internal lists of prims it is keeping track of.<br />
<br />
<dt>'''public override void RemoveAvatar(PhysicsActor character)'''<br />
<dd> Like RemovePrim, but for avatars.<br />
<br />
<dt>'''public override PhysicsActor AddPrimShape(string primName, PrimitiveBaseShape pbs, PhysicsVector position, PhysicsVector size, Quarternion rotation)'''<br />
<dd> Tells the physics engine to add a new prim it needs to keep track of. This prim is ''not'' a physical prim, but as long as it's not phantom, physical objects may collide with it, and thus the physics engine (may) need to know about it. (Unless the physics engine punts on collisions, as, for instance, NewtonPlugin does.) Comments in the code indicate that this method is slated to be removed....<br />
<br />
<dt>'''public override PhysicsActor AddPrimShape(string primName, PrimitiveBaseShape pbs, PhysicsVector position, PhysicsVector size, Quarternion rotation, bool isPhysical)'''<br />
<dd>Like the previous one, but you've got the flag that tells you if it's physical or not.<br />
<br />
<dt>'''public override void AddPhysicsActorTaint(PhysicsActor prim)'''<br />
<dd>(I don't know what taints are, so I can't document them yet....)<br />
<br />
<dt>'''public override void GetResults()'''<br />
<br />
<dt>'''public override bol IsThreaded'''<br />
<dd>A member that needs a get method.<br />
<br />
<dt>'''public override void SetTerrain(float[] heightMap)'''<br />
<br />
<dt>'''public override void DeleteTerrain()'''<br />
<br />
<dt>'''public overrid Dictionary<unit, float> GetTopColliders()<br />
<br />
<dt>'''public override float Simulate(float timestep)'''<br />
<dd>This is the core function. This gets called by the main loop when it wants the Physics engine to do its magic and propagate forward the positions and velocities of all the stuff it knows about. The physics engine should update the Position and Velocity members of the PhysicsActor class it knows about (those things that have been added to it by the methods above). '''Important:''' when the physics engine thinks that things have changed enough for any given prims that the surrounding scene should updates it's own idea about the positions and velocities of those prims, it should call the RequestPhysicsterseUpdate() method of the changed PhysicsActors(). (The safest, but slowest, way to do this is for Simulate() to call this for every physical prim it knows about every time it is called.)<br />
<br />
</dl><br />
<br />
== PhysicsActor ==<br />
<br />
PhysicsActor represents both prims and characters. You may want to make separate classes for the two.<br />
<br />
Members:<br />
<br />
<dl><br />
<dt>'''int PhysicsActorType'''<br />
<dd>Needs get and set methods. Return ActorTypes.Prim or ActorTypes.Agent if it's a prim or an avatar.<br />
<br />
<dt>'''bool IsPhysical'''<br />
<dd>Needs get and set<br />
<br />
<dt>'''PhysicsVector Position'''<br />
<dd>Needs get and set. If an object is physical, the physics engine keeps the "real" position for that object. However, it's the surrounding scene's impression of the position that gets rendered and sent to the client. It will pull the position out of the physics engine by looking at this member, and tell the physics engine about any external changes in its position through this member. Note that the scene doesn't automatically pull out the position, but only when it thinks it needs to. You can call the RequestPhysicsterseUpdate() method of PhysicsActor to ask the Scene to update its position for any given PhysicsActor. (See PhysicsScene.Simulate() above.)<br />
<br />
<dt>'''PhysicsVector Velocity'''<br />
<dd>Need get and set. Similar considerations to Position<br />
<br />
<dt>'''PhysicsVector RotationalVelocity'''<br />
<dd>Needs get and set<br />
<br />
<dt>'''PhysicsVector Acceleration'''<br />
<dd>Needs get; there's no set method.<br />
<br />
<dt>'''void SetAcceleration(PhysicsVector accel)'''<br />
<dd>Do what you'd think Acceleration.set would do<br />
<br />
<dt>'''PhysicsVector Size'''<br />
<dd>Needs get and set<br />
<br />
<dt>'''float Mass'''<br />
<dd>Needs get; there is no set method at the moment<br />
<br />
<dt>'''void SetMass(float mass)'''<br />
<dd>Instead of Mass.set<br />
<br />
<dt>'''void SetMomentum(PhysicsVector momentum)'''<br />
<dd>I am disturbed that this exists in addition to Velocity.set and SetMass....<br />
<br />
<dt>'''Quarternion Orientation'''<br />
<dd>Needs get and set<br />
<br />
<dt>'''bool ThrottleUpdates'''<br />
<dd>Needs get and set. I'm not sure what this means, exactly.<br />
<br />
<dt>'''bool IsColliding'''<br />
<dd>Needs get and set.<br />
<br />
<dt>'''bool CollidingGround'''<br />
<dd>Needs get and set<br />
<br />
<dt>'''bool CollidingObj'''<br />
<dd>Needs get and set<br />
<br />
<dt>'''bool Stopped'''<br />
<dd>Just needs get<br />
<br />
<dt>'''PhysicsVector CenterOfMass'''<br />
<dd>Just needs get<br />
<br />
<dt>'''PhysicsVector GeometricCenter'''<br />
<dd>Just needs get<br />
<br />
<dt>'''PrimitiveBaseShape Shape'''<br />
<dd>Just needs set<br />
<br />
<dt>'''PhysicsVector Force'''<br />
<dd>Needs get and set. I ''think'' this is a steady force (in N) always acting on the object.<br />
<br />
<dt>'''PhysicsVector Torque'''<br />
<dd>Needs get and set. Like Force, I think this is a steady torque operating on the object.<br />
<br />
<dt>'''void AddForce(PhysicsVector force, bool pushforce)'''<br />
<dd>This should apply a one-time impulse to the object of magnitude "force" Newton-seconds. I am not sure what "pushforce" means....<br />
<br />
<dt>'''void AddAngularForce(PhsyicsVector force, bool pushforce)'''<br />
<dd>A one-time angular impulse. I'm not sure the units, nor what pushforce means.<br />
<br />
<dt>'''int VehicleType'''<br />
<dd>(I don't know anything about the vehicle code requirements)<br />
<br />
<dt>'''void VehicleFloatParam(int param, float value)'''<br />
<br />
<dt>'''void VehicleVectorParam(int param, PhysicsVector value)'''<br />
<br />
<dt>'''void VehicleRotationParam(int param, Quarternion rotation)'''<br />
<br />
<dt>'''void SetVoulumeDetect(int param)'''<br />
<dd>This is some weird mode that can be set via a LSL function<br />
<br />
<dt>'''float Buoyancy'''<br />
<dd>Needs get and set<br />
<br />
<dt>'''bool FloatOnWater'''<br />
<dd>Just needs set<br />
<br />
<dt>'''float CollisionScore'''<br />
<dd>Needs get and set. I don't know what this is.<br />
<br />
<dt>'''bool Flying'''<br />
<dd>Needs get and set<br />
<br />
<dt>'''bool SetAlwaysRun'''<br />
<dd>Needs get and set<br />
<br />
<dt>'''unit LocalID'''<br />
<dd>Needs set. I don't know what this is<br />
<br />
<dt>'''bool Grabbed'''<br />
<dd>Needs set. I'm not sure what this is, but I'm guessing it's when you control-click on an object?<br />
<br />
<dt>'''void link(PhysicsActor obj)'''<br />
<dd>I haven't delved into how linking works in the physics engine. I'm ''guessing'' that this says "link yourself to obj with obj as the root", but I could be wrong.<br />
<br />
<dt>'''void delink()'''<br />
<br />
<dt>'''void LockAngularMomentum(PhysicsVector axis)'''<br />
<br />
<dt>'''bool Selected'''<br />
<dd>Just needs set<br />
<br />
<dt>'''void CrossingFailure()'''<br />
<br />
<dt>'''PhysicsVector PIDTarget'''<br />
<dd>Just needs set. I don't know what this is, but I'm guessing it's a place to which an object is supposed to move.<br />
<br />
<dt>'''bool PIDActive'''<br />
<dd>Just needs set.<br />
<br />
<dt>'''float PIDTau'''<br />
<dd>Just needs set. I'm guessing that this is the timescale (in seconds) in which the object should move to PIDTarget when it is set to be PID Active.<br />
<br />
<dt>'''float PIDHoverHeight'''<br />
<br />
<dt>'''float PIDHoverActive'''<br />
<br />
<dt>'''PIDHoverType PIDHoverType'''<br />
<br />
<dt>'''float PIDHoverTau'''<br />
<br />
<dt>'''void SubscribeEvents(int ms)'''<br />
<dd>I do not know what sorts of events the PhysicsActor sends... hopefully I'll update this if/when I figure that out! It looks like you can ask for OnPositionUpdate, OnVelocityUpdate, OnOrientationUpdate, OnRequestTerseUpdate, OnCollisionUpdate, and OnOutOfBounds... but I have yet to fully understand the OpenSim event system, so I may be speaking out of the side of my mouth here.<br />
<br />
<dt>'''bool SubscribedEvents()'''</div>Rknophttp://opensimulator.org/wiki/Physics_Engine_InterfacePhysics Engine Interface2009-09-18T20:21:47Z<p>Rknop: </p>
<hr />
<div>== Base Classes ==<br />
<br />
''Note: I ([[User:Rknop]]) am trying to figure this out by looking at some of the code; my main interest is the NewtonPlugin. AS such, there are whole swaths of the physics engine, such as joints, that I have no clue about at the moment''<br />
<br />
The base classes for a physics module can be found in OpenSim.Region.Physics.Manager. The physics module itself should be a subclass of Physics, e.g. OpenSim.Region.Physics.OdePlugin.<br />
<br />
* '''<tt>PhysicsActor</tt>''' is the base class for both prims and avatars.<br />
* '''<tt>PhysicsScene</tt>''' is the main base class that interfaces with the region's Scene.<br />
* (others)<br />
<br />
The Physics Scene doesn't access the Region Scene. The region scene will tell the physics engine about prims and avatars, and will send updates to the physics engine. It will then pull positions and velocities of objects and avatars out of the physics engine.<br />
<br />
For the most part, the things that will be interfacing with the physics engine are the classes <tt>OpenSim.Region.Framework.Scenes.Scene</tt>, <tt>OpenSim.Region.Framework.Scenes.SceneObjectGroup</tt>, and <tt>OpenSim.Region.Framework.Scenes.SceneObjectPart</tt><br />
<br />
== The Plugin Class ==<br />
<br />
If you're writing a Physics engine named Foo, you need to write a class OpenSim.Region.Physics.FooPlugin with the following methods:<br />
<br />
* '''FooPlugin()''' &mdash; constructor<br />
* '''bool Init()''' &mdash; (not sure exactly when this is called. return true)<br />
* '''PhysicsScene GetScene(String sceneIdentifier)''' &mdash; return a FooScene, which is derived from PhysicsScene<br />
* '''string GetName()''' &mdash; return the name that folks can use in OpenSim.ini to select this physics engine<br />
* '''Dispose()''' &mdash; destructor<br />
<br />
== PhysicsScene ==<br />
<br />
Your class OpenSim.Region.Physics.FooScene must derive from OpenSim.Region.Physics.PhysicsScene. Members include:<br />
<br />
<dl><br />
<dt>'''public override void Initialize(IMesher meshmerizer, IConfigSource config)'''<br />
<br />
<dt>'''public override PhysicsActor AddAvatar(string avName, PhysicsVector position, PhysicsVector size, bool isFlying)'''<br />
<br />
<dt>'''public override void SetWaterLevel(float baseheight)'''<br />
<br />
<dt>'''public override void RemovePrim(PhysicsActor prim)'''<br />
<dd> This gets called when a prim is made into something the physics engine no longer needs to know about. The physics engine should remove it from any internal lists of prims it is keeping track of.<br />
<br />
<dt>'''public override void RemoveAvatar(PhysicsActor character)'''<br />
<dd> Like RemovePrim, but for avatars.<br />
<br />
<dt>'''public override void AddPrimShape(string primName, PrimitiveBaseShape pbs, PhysicsVector position, PhysicsVector size, Quarternion rotation)'''<br />
<dd> Tells the physics engine to add a new prim it needs to keep track of. This prim is ''not'' a physical prim, but as long as it's not phantom, physical objects may collide with it, and thus the physics engine (may) need to know about it. (Unless the physics engine punts on collisions, as, for instance, NewtonPlugin does.)<br />
<br />
<dt>'''public override void AddPrimShape(string primName, PrimitiveBaseShape pbs, PhysicsVector position, PhysicsVector size, Quarternion rotation, bool isPhysical)'''<br />
<dd>Like the previous one, but you've got the flag that tells you if it's physical or not.<br />
<br />
<dt>'''public override void AddPhysicsActorTaint(PhysicsActor prim)'''<br />
<dd>(I don't know what taints are, so I can't document them yet....)<br />
<br />
<dt>'''public override void GetResults()'''<br />
<br />
<dt>'''public override bol IsThreaded'''<br />
<dd>A member that needs a get method.<br />
<br />
<dt>'''public override void SetTerrain(float[] heightMap)'''<br />
<br />
<dt>'''public override void DeleteTerrain()'''<br />
<br />
<dt>'''public overrid Dictionary<unit, float> GetTopColliders()<br />
<br />
<dt>'''public override float Simulate(float timestep)'''<br />
<dd>This is the core function. This gets called by the main loop when it wants the Physics engine to do its magic and propagate forward the positions and velocities of all the stuff it knows about. The physics engine should update the Position and Velocity members of the PhysicsActor class it knows about (those things that have been added to it by the methods above). '''Important:''' when the physics engine thinks that things have changed enough for any given prims that the surrounding scene should updates it's own idea about the positions and velocities of those prims, it should call the RequestPhysicsterseUpdate() method of the changed PhysicsActors(). (The safest, but slowest, way to do this is for Simulate() to call this for every physical prim it knows about every time it is called.)<br />
<br />
</dl><br />
<br />
== PhysicsActor ==<br />
<br />
PhysicsActor represents both prims and characters. You may want to make separate classes for the two.<br />
<br />
Members:<br />
<br />
<dl><br />
<dt>'''int PhysicsActorType'''<br />
<dd>Needs get and set methods. Return ActorTypes.Prim or ActorTypes.Agent if it's a prim or an avatar.<br />
<br />
<dt>'''bool IsPhysical'''<br />
<dd>Needs get and set<br />
<br />
<dt>'''PhysicsVector Position'''<br />
<dd>Needs get and set. If an object is physical, the physics engine keeps the "real" position for that object. However, it's the surrounding scene's impression of the position that gets rendered and sent to the client. It will pull the position out of the physics engine by looking at this member, and tell the physics engine about any external changes in its position through this member. Note that the scene doesn't automatically pull out the position, but only when it thinks it needs to. You can call the RequestPhysicsterseUpdate() method of PhysicsActor to ask the Scene to update its position for any given PhysicsActor. (See PhysicsScene.Simulate() above.)<br />
<br />
<dt>'''PhysicsVector Velocity'''<br />
<dd>Need get and set. Similar considerations to Position<br />
<br />
<dt>'''PhysicsVector RotationalVelocity'''<br />
<dd>Needs get and set<br />
<br />
<dt>'''PhysicsVector Acceleration'''<br />
<dd>Needs get; there's no set method.<br />
<br />
<dt>'''void SetAcceleration(PhysicsVector accel)'''<br />
<dd>Do what you'd think Acceleration.set would do<br />
<br />
<dt>'''PhysicsVector Size'''<br />
<dd>Needs get and set<br />
<br />
<dt>'''float Mass'''<br />
<dd>Needs get; there is no set method at the moment<br />
<br />
<dt>'''void SetMass(float mass)'''<br />
<dd>Instead of Mass.set<br />
<br />
<dt>'''void SetMomentum(PhysicsVector momentum)'''<br />
<dd>I am disturbed that this exists in addition to Velocity.set and SetMass....<br />
<br />
<dt>'''Quarternion Orientation'''<br />
<dd>Needs get and set<br />
<br />
<dt>'''bool ThrottleUpdates'''<br />
<dd>Needs get and set. I'm not sure what this means, exactly.<br />
<br />
<dt>'''bool IsColliding'''<br />
<dd>Needs get and set.<br />
<br />
<dt>'''bool CollidingGround'''<br />
<dd>Needs get and set<br />
<br />
<dt>'''bool CollidingObj'''<br />
<dd>Needs get and set<br />
<br />
<dt>'''bool Stopped'''<br />
<dd>Just needs get<br />
<br />
<dt>'''PhysicsVector CenterOfMass'''<br />
<dd>Just needs get<br />
<br />
<dt>'''PhysicsVector GeometricCenter'''<br />
<dd>Just needs get<br />
<br />
<dt>'''PrimitiveBaseShape Shape'''<br />
<dd>Just needs set<br />
<br />
<dt>'''PhysicsVector Force'''<br />
<dd>Needs get and set. I ''think'' this is a steady force (in N) always acting on the object.<br />
<br />
<dt>'''PhysicsVector Torque'''<br />
<dd>Needs get and set. Like Force, I think this is a steady torque operating on the object.<br />
<br />
<dt>'''void AddForce(PhysicsVector force, bool pushforce)'''<br />
<dd>This should apply a one-time impulse to the object of magnitude "force" Newton-seconds. I am not sure what "pushforce" means....<br />
<br />
<dt>'''void AddAngularForce(PhsyicsVector force, bool pushforce)'''<br />
<dd>A one-time angular impulse. I'm not sure the units, nor what pushforce means.<br />
<br />
<dt>'''int VehicleType'''<br />
<dd>(I don't know anything about the vehicle code requirements)<br />
<br />
<dt>'''void VehicleFloatParam(int param, float value)'''<br />
<br />
<dt>'''void VehicleVectorParam(int param, PhysicsVector value)'''<br />
<br />
<dt>'''void VehicleRotationParam(int param, Quarternion rotation)'''<br />
<br />
<dt>'''void SetVoulumeDetect(int param)'''<br />
<dd>This is some weird mode that can be set via a LSL function<br />
<br />
<dt>'''float Buoyancy'''<br />
<dd>Needs get and set<br />
<br />
<dt>'''bool FloatOnWater'''<br />
<dd>Just needs set<br />
<br />
<dt>'''float CollisionScore'''<br />
<dd>Needs get and set. I don't know what this is.<br />
<br />
<dt>'''bool Flying'''<br />
<dd>Needs get and set<br />
<br />
<dt>'''bool SetAlwaysRun'''<br />
<dd>Needs get and set<br />
<br />
<dt>'''unit LocalID'''<br />
<dd>Needs set. I don't know what this is<br />
<br />
<dt>'''bool Grabbed'''<br />
<dd>Needs set. I'm not sure what this is, but I'm guessing it's when you control-click on an object?<br />
<br />
<dt>'''void link(PhysicsActor obj)'''<br />
<dd>I haven't delved into how linking works in the physics engine. I'm ''guessing'' that this says "link yourself to obj with obj as the root", but I could be wrong.<br />
<br />
<dt>'''void delink()'''<br />
<br />
<dt>'''void LockAngularMomentum(PhysicsVector axis)'''<br />
<br />
<dt>'''bool Selected'''<br />
<dd>Just needs set<br />
<br />
<dt>'''void CrossingFailure()'''<br />
<br />
<dt>'''PhysicsVector PIDTarget'''<br />
<dd>Just needs set. I don't know what this is, but I'm guessing it's a place to which an object is supposed to move.<br />
<br />
<dt>'''bool PIDActive'''<br />
<dd>Just needs set.<br />
<br />
<dt>'''float PIDTau'''<br />
<dd>Just needs set. I'm guessing that this is the timescale (in seconds) in which the object should move to PIDTarget when it is set to be PID Active.<br />
<br />
<dt>'''float PIDHoverHeight'''<br />
<br />
<dt>'''float PIDHoverActive'''<br />
<br />
<dt>'''PIDHoverType PIDHoverType'''<br />
<br />
<dt>'''float PIDHoverTau'''<br />
<br />
<dt>'''void SubscribeEvents(int ms)'''<br />
<dd>I do not know what sorts of events the PhysicsActor sends... hopefully I'll update this if/when I figure that out! It looks like you can ask for OnPositionUpdate, OnVelocityUpdate, OnOrientationUpdate, OnRequestTerseUpdate, OnCollisionUpdate, and OnOutOfBounds... but I have yet to fully understand the OpenSim event system, so I may be speaking out of the side of my mouth here.<br />
<br />
<dt>'''bool SubscribedEvents()'''</div>Rknophttp://opensimulator.org/wiki/Physics_Engine_InterfacePhysics Engine Interface2009-09-18T20:20:02Z<p>Rknop: </p>
<hr />
<div>== Base Classes ==<br />
<br />
''Note: I ([[User:Rknop]]) am trying to figure this out by looking at some of the code; my main interest is the NewtonPlugin. AS such, there are whole swaths of the physics engine, such as joints, that I have no clue about at the moment''<br />
<br />
The base classes for a physics module can be found in OpenSim.Region.Physics.Manager. The physics module itself should be a subclass of Physics, e.g. OpenSim.Region.Physics.OdePlugin.<br />
<br />
* '''<tt>PhysicsActor</tt>''' is the base class for both prims and avatars.<br />
* '''<tt>PhysicsScene</tt>''' is the main base class that interfaces with the region's Scene.<br />
* (others)<br />
<br />
The Physics Scene doesn't access the Region Scene. The region scene will tell the physics engine about prims and avatars, and will send updates to the physics engine. It will then pull positions and velocities of objects and avatars out of the physics engine.<br />
<br />
== The Plugin Class ==<br />
<br />
If you're writing a Physics engine named Foo, you need to write a class OpenSim.Region.Physics.FooPlugin with the following methods:<br />
<br />
* '''FooPlugin()''' &mdash; constructor<br />
* '''bool Init()''' &mdash; (not sure exactly when this is called. return true)<br />
* '''PhysicsScene GetScene(String sceneIdentifier)''' &mdash; return a FooScene, which is derived from PhysicsScene<br />
* '''string GetName()''' &mdash; return the name that folks can use in OpenSim.ini to select this physics engine<br />
* '''Dispose()''' &mdash; destructor<br />
<br />
== PhysicsScene ==<br />
<br />
Your class OpenSim.Region.Physics.FooScene must derive from OpenSim.Region.Physics.PhysicsScene. Members include:<br />
<br />
<dl><br />
<dt>'''public override void Initialize(IMesher meshmerizer, IConfigSource config)'''<br />
<br />
<dt>'''public override PhysicsActor AddAvatar(string avName, PhysicsVector position, PhysicsVector size, bool isFlying)'''<br />
<br />
<dt>'''public override void SetWaterLevel(float baseheight)'''<br />
<br />
<dt>'''public override void RemovePrim(PhysicsActor prim)'''<br />
<dd> This gets called when a prim is made into something the physics engine no longer needs to know about. The physics engine should remove it from any internal lists of prims it is keeping track of.<br />
<br />
<dt>'''public override void RemoveAvatar(PhysicsActor character)'''<br />
<dd> Like RemovePrim, but for avatars.<br />
<br />
<dt>'''public override void AddPrimShape(string primName, PrimitiveBaseShape pbs, PhysicsVector position, PhysicsVector size, Quarternion rotation)'''<br />
<dd> Tells the physics engine to add a new prim it needs to keep track of. This prim is ''not'' a physical prim, but as long as it's not phantom, physical objects may collide with it, and thus the physics engine (may) need to know about it. (Unless the physics engine punts on collisions, as, for instance, NewtonPlugin does.)<br />
<br />
<dt>'''public override void AddPrimShape(string primName, PrimitiveBaseShape pbs, PhysicsVector position, PhysicsVector size, Quarternion rotation, bool isPhysical)'''<br />
<dd>Like the previous one, but you've got the flag that tells you if it's physical or not.<br />
<br />
<dt>'''public override void AddPhysicsActorTaint(PhysicsActor prim)'''<br />
<dd>(I don't know what taints are, so I can't document them yet....)<br />
<br />
<dt>'''public override void GetResults()'''<br />
<br />
<dt>'''public override bol IsThreaded'''<br />
<dd>A member that needs a get method.<br />
<br />
<dt>'''public override void SetTerrain(float[] heightMap)'''<br />
<br />
<dt>'''public override void DeleteTerrain()'''<br />
<br />
<dt>'''public overrid Dictionary<unit, float> GetTopColliders()<br />
<br />
<dt>'''public override float Simulate(float timestep)'''<br />
<dd>This is the core function. This gets called by the main loop when it wants the Physics engine to do its magic and propagate forward the positions and velocities of all the stuff it knows about. The physics engine should update the Position and Velocity members of the PhysicsActor class it knows about (those things that have been added to it by the methods above). '''Important:''' when the physics engine thinks that things have changed enough for any given prims that the surrounding scene should updates it's own idea about the positions and velocities of those prims, it should call the RequestPhysicsterseUpdate() method of the changed PhysicsActors(). (The safest, but slowest, way to do this is for Simulate() to call this for every physical prim it knows about every time it is called.)<br />
<br />
</dl><br />
<br />
== PhysicsActor ==<br />
<br />
PhysicsActor represents both prims and characters. You may want to make separate classes for the two.<br />
<br />
Members:<br />
<br />
<dl><br />
<dt>'''int PhysicsActorType'''<br />
<dd>Needs get and set methods. Return ActorTypes.Prim or ActorTypes.Agent if it's a prim or an avatar.<br />
<br />
<dt>'''bool IsPhysical'''<br />
<dd>Needs get and set<br />
<br />
<dt>'''PhysicsVector Position'''<br />
<dd>Needs get and set. If an object is physical, the physics engine keeps the "real" position for that object. However, it's the surrounding scene's impression of the position that gets rendered and sent to the client. It will pull the position out of the physics engine by looking at this member, and tell the physics engine about any external changes in its position through this member. Note that the scene doesn't automatically pull out the position, but only when it thinks it needs to. You can call the RequestPhysicsterseUpdate() method of PhysicsActor to ask the Scene to update its position for any given PhysicsActor. (See PhysicsScene.Simulate() above.)<br />
<br />
<dt>'''PhysicsVector Velocity'''<br />
<dd>Need get and set. Similar considerations to Position<br />
<br />
<dt>'''PhysicsVector RotationalVelocity'''<br />
<dd>Needs get and set<br />
<br />
<dt>'''PhysicsVector Acceleration'''<br />
<dd>Needs get; there's no set method.<br />
<br />
<dt>'''void SetAcceleration(PhysicsVector accel)'''<br />
<dd>Do what you'd think Acceleration.set would do<br />
<br />
<dt>'''PhysicsVector Size'''<br />
<dd>Needs get and set<br />
<br />
<dt>'''float Mass'''<br />
<dd>Needs get; there is no set method at the moment<br />
<br />
<dt>'''void SetMass(float mass)'''<br />
<dd>Instead of Mass.set<br />
<br />
<dt>'''void SetMomentum(PhysicsVector momentum)'''<br />
<dd>I am disturbed that this exists in addition to Velocity.set and SetMass....<br />
<br />
<dt>'''Quarternion Orientation'''<br />
<dd>Needs get and set<br />
<br />
<dt>'''bool ThrottleUpdates'''<br />
<dd>Needs get and set. I'm not sure what this means, exactly.<br />
<br />
<dt>'''bool IsColliding'''<br />
<dd>Needs get and set.<br />
<br />
<dt>'''bool CollidingGround'''<br />
<dd>Needs get and set<br />
<br />
<dt>'''bool CollidingObj'''<br />
<dd>Needs get and set<br />
<br />
<dt>'''bool Stopped'''<br />
<dd>Just needs get<br />
<br />
<dt>'''PhysicsVector CenterOfMass'''<br />
<dd>Just needs get<br />
<br />
<dt>'''PhysicsVector GeometricCenter'''<br />
<dd>Just needs get<br />
<br />
<dt>'''PrimitiveBaseShape Shape'''<br />
<dd>Just needs set<br />
<br />
<dt>'''PhysicsVector Force'''<br />
<dd>Needs get and set. I ''think'' this is a steady force (in N) always acting on the object.<br />
<br />
<dt>'''PhysicsVector Torque'''<br />
<dd>Needs get and set. Like Force, I think this is a steady torque operating on the object.<br />
<br />
<dt>'''void AddForce(PhysicsVector force, bool pushforce)'''<br />
<dd>This should apply a one-time impulse to the object of magnitude "force" Newton-seconds. I am not sure what "pushforce" means....<br />
<br />
<dt>'''void AddAngularForce(PhsyicsVector force, bool pushforce)'''<br />
<dd>A one-time angular impulse. I'm not sure the units, nor what pushforce means.<br />
<br />
<dt>'''int VehicleType'''<br />
<dd>(I don't know anything about the vehicle code requirements)<br />
<br />
<dt>'''void VehicleFloatParam(int param, float value)'''<br />
<br />
<dt>'''void VehicleVectorParam(int param, PhysicsVector value)'''<br />
<br />
<dt>'''void VehicleRotationParam(int param, Quarternion rotation)'''<br />
<br />
<dt>'''void SetVoulumeDetect(int param)'''<br />
<dd>This is some weird mode that can be set via a LSL function<br />
<br />
<dt>'''float Buoyancy'''<br />
<dd>Needs get and set<br />
<br />
<dt>'''bool FloatOnWater'''<br />
<dd>Just needs set<br />
<br />
<dt>'''float CollisionScore'''<br />
<dd>Needs get and set. I don't know what this is.<br />
<br />
<dt>'''bool Flying'''<br />
<dd>Needs get and set<br />
<br />
<dt>'''bool SetAlwaysRun'''<br />
<dd>Needs get and set<br />
<br />
<dt>'''unit LocalID'''<br />
<dd>Needs set. I don't know what this is<br />
<br />
<dt>'''bool Grabbed'''<br />
<dd>Needs set. I'm not sure what this is, but I'm guessing it's when you control-click on an object?<br />
<br />
<dt>'''void link(PhysicsActor obj)'''<br />
<dd>I haven't delved into how linking works in the physics engine. I'm ''guessing'' that this says "link yourself to obj with obj as the root", but I could be wrong.<br />
<br />
<dt>'''void delink()'''<br />
<br />
<dt>'''void LockAngularMomentum(PhysicsVector axis)'''<br />
<br />
<dt>'''bool Selected'''<br />
<dd>Just needs set<br />
<br />
<dt>'''void CrossingFailure()'''<br />
<br />
<dt>'''PhysicsVector PIDTarget'''<br />
<dd>Just needs set. I don't know what this is, but I'm guessing it's a place to which an object is supposed to move.<br />
<br />
<dt>'''bool PIDActive'''<br />
<dd>Just needs set.<br />
<br />
<dt>'''float PIDTau'''<br />
<dd>Just needs set. I'm guessing that this is the timescale (in seconds) in which the object should move to PIDTarget when it is set to be PID Active.<br />
<br />
<dt>'''float PIDHoverHeight'''<br />
<br />
<dt>'''float PIDHoverActive'''<br />
<br />
<dt>'''PIDHoverType PIDHoverType'''<br />
<br />
<dt>'''float PIDHoverTau'''<br />
<br />
<dt>'''void SubscribeEvents(int ms)'''<br />
<dd>I do not know what sorts of events the PhysicsActor sends... hopefully I'll update this if/when I figure that out! It looks like you can ask for OnPositionUpdate, OnVelocityUpdate, OnOrientationUpdate, OnRequestTerseUpdate, OnCollisionUpdate, and OnOutOfBounds... but I have yet to fully understand the OpenSim event system, so I may be speaking out of the side of my mouth here.<br />
<br />
<dt>'''bool SubscribedEvents()'''</div>Rknophttp://opensimulator.org/wiki/User:RknopUser:Rknop2009-09-18T19:48:47Z<p>Rknop: New page: Rob Knop, aka Prospero Frobozz in Second Life. Itinerant astrophysicist and computer engineer. Home page : http://www.sonic.net/~rknop Blog : http://www.sonic.net/~rknop/blog E-mail : ...</p>
<hr />
<div>Rob Knop, aka Prospero Frobozz in Second Life.<br />
<br />
Itinerant astrophysicist and computer engineer.<br />
<br />
Home page : http://www.sonic.net/~rknop<br />
<br />
Blog : http://www.sonic.net/~rknop/blog<br />
<br />
E-mail : rknop@pobox.com<br />
<br />
rknop on #opensim and #opensim-dev</div>Rknophttp://opensimulator.org/wiki/Physics_Engine_InterfacePhysics Engine Interface2009-09-18T19:47:03Z<p>Rknop: /* PhysicsScene */</p>
<hr />
<div>== Base Classes ==<br />
<br />
''Note: I ([[User:Rknop]]) am trying to figure this out by looking at some of the code; my main interest is the NewtonPlugin. AS such, there are whole swaths of the physics engine, such as joints, that I have no clue about at the moment''<br />
<br />
The base classes for a physics module can be found in OpenSim.Region.Physics.Manager. The physics module itself should be a subclass of Physics, e.g. OpenSim.Region.Physics.OdePlugin.<br />
<br />
* '''<tt>PhysicsActor</tt>''' is the base class for both prims and avatars.<br />
* '''<tt>PhysicsScene</tt>''' is the main base class that interfaces with the region's Scene.<br />
* (others)<br />
<br />
The Physics Scene doesn't access the Region Scene. The region scene will tell the physics engine about prims and avatars, and will send updates to the physics engine. It will then pull positions and velocities of objects and avatars out of the physics engine.<br />
<br />
== The Plugin Class ==<br />
<br />
If you're writing a Physics engine named Foo, you need to write a class OpenSim.Region.Physics.FooPlugin with the following methods:<br />
<br />
* '''FooPlugin()''' &mdash; constructor<br />
* '''bool Init()''' &mdash; (not sure exactly when this is called. return true)<br />
* '''PhysicsScene GetScene(String sceneIdentifier)''' &mdash; return a FooScene, which is derived from PhysicsScene<br />
* '''string GetName()''' &mdash; return the name that folks can use in OpenSim.ini to select this physics engine<br />
* '''Dispose()''' &mdash; destructor<br />
<br />
== PhysicsScene ==<br />
<br />
Your class OpenSim.Region.Physics.FooScene must derive from OpenSim.Region.Physics.PhysicsScene. Members include:<br />
<br />
<dl><br />
<dt>'''public override void Initialize(IMesher meshmerizer, IConfigSource config)'''<br />
<br />
<dt>'''public override PhysicsActor AddAvatar(string avName, PhysicsVector position, PhysicsVector size, bool isFlying)'''<br />
<br />
<dt>'''public override void SetWaterLevel(float baseheight)'''<br />
<br />
<dt>'''public override void RemovePrim(PhysicsActor prim)'''<br />
<dd> This gets called when a prim is made into something the physics engine no longer needs to know about. The physics engine should remove it from any internal lists of prims it is keeping track of.<br />
<br />
<dt>'''public override void RemoveAvatar(PhysicsActor character)'''<br />
<dd> Like RemovePrim, but for avatars.<br />
<br />
<dt>'''public override void AddPrimShape(string primName, PrimitiveBaseShape pbs, PhysicsVector position, PhysicsVector size, Quarternion rotation)'''<br />
<dd> Tells the physics engine to add a new prim it needs to keep track of. This prim is ''not'' a physical prim, but as long as it's not phantom, physical objects may collide with it, and thus the physics engine (may) need to know about it. (Unless the physics engine punts on collisions, as, for instance, NewtonPlugin does.)<br />
<br />
<dt>'''public override void AddPrimShape(string primName, PrimitiveBaseShape pbs, PhysicsVector position, PhysicsVector size, Quarternion rotation, bool isPhysical)'''<br />
<dd>Like the previous one, but you've got the flag that tells you if it's physical or not.<br />
<br />
<dt>'''public override void AddPhysicsActorTaint(PhysicsActor prim)'''<br />
<dd>(I don't know what taints are, so I can't document them yet....)<br />
<br />
<dt>'''public override void GetResults()'''<br />
<br />
<dt>'''public override bol IsThreaded'''<br />
<dd>A member that needs a get method.<br />
<br />
<dt>'''public override void SetTerrain(float[] heightMap)'''<br />
<br />
<dt>'''public override void DeleteTerrain()'''<br />
<br />
<dt>'''public overrid Dictionary<unit, float> GetTopColliders()<br />
<br />
<dt>'''public override float Simulate(float timestep)'''<br />
<dd>This is the core function. This gets called by the main loop when it wants the Physics engine to do its magic and propagate forward the positions and velocities of all the stuff it knows about. The physics engine should update the Position and Velocity members of the PhysicsActor class it knows about (those things that have been added to it by the methods above). '''Important:''' when the physics engine thinks that things have changed enough for any given prims that the surrounding scene should updates it's own idea about the positions and velocities of those prims, it should call the RequestPhysicsterseUpdate() method of the changed PhysicsActors(). (The safest, but slowest, way to do this is for Simulate() to call this for every physical prim it knows about every time it is called.)</div>Rknophttp://opensimulator.org/wiki/Physics_Engine_InterfacePhysics Engine Interface2009-09-18T19:44:57Z<p>Rknop: /* PhysicsScene */</p>
<hr />
<div>== Base Classes ==<br />
<br />
''Note: I ([[User:Rknop]]) am trying to figure this out by looking at some of the code; my main interest is the NewtonPlugin. AS such, there are whole swaths of the physics engine, such as joints, that I have no clue about at the moment''<br />
<br />
The base classes for a physics module can be found in OpenSim.Region.Physics.Manager. The physics module itself should be a subclass of Physics, e.g. OpenSim.Region.Physics.OdePlugin.<br />
<br />
* '''<tt>PhysicsActor</tt>''' is the base class for both prims and avatars.<br />
* '''<tt>PhysicsScene</tt>''' is the main base class that interfaces with the region's Scene.<br />
* (others)<br />
<br />
The Physics Scene doesn't access the Region Scene. The region scene will tell the physics engine about prims and avatars, and will send updates to the physics engine. It will then pull positions and velocities of objects and avatars out of the physics engine.<br />
<br />
== The Plugin Class ==<br />
<br />
If you're writing a Physics engine named Foo, you need to write a class OpenSim.Region.Physics.FooPlugin with the following methods:<br />
<br />
* '''FooPlugin()''' &mdash; constructor<br />
* '''bool Init()''' &mdash; (not sure exactly when this is called. return true)<br />
* '''PhysicsScene GetScene(String sceneIdentifier)''' &mdash; return a FooScene, which is derived from PhysicsScene<br />
* '''string GetName()''' &mdash; return the name that folks can use in OpenSim.ini to select this physics engine<br />
* '''Dispose()''' &mdash; destructor<br />
<br />
== PhysicsScene ==<br />
<br />
Your class OpenSim.Region.Physics.FooScene must derive from OpenSim.Region.Physics.PhysicsScene. Methods include:<br />
<br />
<dl><br />
<dt>'''public override void Initialize(IMesher meshmerizer, IConfigSource config)'''<br />
<br />
<dt>'''public override PhysicsActor AddAvatar(string avName, PhysicsVector position, PhysicsVector size, bool isFlying)'''<br />
<br />
<dt>'''public override void SetWaterLevel(float baseheight)'''<br />
<br />
<dt>'''public override void RemovePrim(PhysicsActor prim)'''<br />
<dd> This gets called when a prim is made into something the physics engine no longer needs to know about. The physics engine should remove it from any internal lists of prims it is keeping track of.<br />
<br />
<dt>'''public override void RemoveAvatar(PhysicsActor character)'''<br />
<dd> Like RemovePrim, but for avatars.<br />
<br />
<dt>'''public override void AddPrimShape(string primName, PrimitiveBaseShape pbs, PhysicsVector position, PhysicsVector size, Quarternion rotation)'''<br />
<dd> Tells the physics engine to add a new prim it needs to keep track of. This prim is ''not'' a physical prim, but as long as it's not phantom, physical objects may collide with it, and thus the physics engine (may) need to know about it. (Unless the physics engine punts on collisions, as, for instance, NewtonPlugin does.)<br />
<br />
<dt>'''public override void AddPrimShape(string primName, PrimitiveBaseShape pbs, PhysicsVector position, PhysicsVector size, Quarternion rotation, bool isPhysical)'''<br />
<dd>Like the previous one, but you've got the flag that tells you if it's physical or not.<br />
<br />
<dt>'''public override void AddPhysicsActorTaint(PhysicsActor prim)'''<br />
<dd>(I don't know what taints are, so I can't document them yet....)<br />
<br />
<dt>'''public override void GetResults()'''<br />
<br />
<dt>'''public override bol IsThreaded'''<br />
<dd>A member that needs a get method.<br />
<br />
<dt>'''public override void SetTerrain(float[] heightMap)'''<br />
<br />
<dt>'''public override void DeleteTerrain()'''<br />
<br />
<dt>'''public overrid Dictionary<unit, float> GetTopColliders()<br />
<br />
<dt>'''public override float Simulate(float timestep)'''<br />
<dd>This is the core function. This gets called by the main loop when it wants the Physics engine to do its magic and propagate forward the positions and velocities of all the stuff it knows about. The physics engine should update the Position and Velocity members of the PhysicsActor class it knows about (those things that have been added to it by the methods above). '''Important:''' when the physics engine thinks that things have changed enough for any given prims that the surrounding scene should updates it's own idea about the positions and velocities of those prims, it should call the RequestPhysicsterseUpdate() method of the changed PhysicsActors(). (The safest, but slowest, way to do this is for Simulate() to call this for every physical prim it knows about every time it is called.)</div>Rknophttp://opensimulator.org/wiki/Physics_Engine_InterfacePhysics Engine Interface2009-09-18T19:42:08Z<p>Rknop: New page: == Base Classes == ''Note: I (User:Rknop) am trying to figure this out by looking at some of the code; my main interest is the NewtonPlugin. AS such, there are whole swaths of the ph...</p>
<hr />
<div>== Base Classes ==<br />
<br />
''Note: I ([[User:Rknop]]) am trying to figure this out by looking at some of the code; my main interest is the NewtonPlugin. AS such, there are whole swaths of the physics engine, such as joints, that I have no clue about at the moment''<br />
<br />
The base classes for a physics module can be found in OpenSim.Region.Physics.Manager. The physics module itself should be a subclass of Physics, e.g. OpenSim.Region.Physics.OdePlugin.<br />
<br />
* '''<tt>PhysicsActor</tt>''' is the base class for both prims and avatars.<br />
* '''<tt>PhysicsScene</tt>''' is the main base class that interfaces with the region's Scene.<br />
* (others)<br />
<br />
The Physics Scene doesn't access the Region Scene. The region scene will tell the physics engine about prims and avatars, and will send updates to the physics engine. It will then pull positions and velocities of objects and avatars out of the physics engine.<br />
<br />
== The Plugin Class ==<br />
<br />
If you're writing a Physics engine named Foo, you need to write a class OpenSim.Region.Physics.FooPlugin with the following methods:<br />
<br />
* '''FooPlugin()''' &mdash; constructor<br />
* '''bool Init()''' &mdash; (not sure exactly when this is called. return true)<br />
* '''PhysicsScene GetScene(String sceneIdentifier)''' &mdash; return a FooScene, which is derived from PhysicsScene<br />
* '''string GetName()''' &mdash; return the name that folks can use in OpenSim.ini to select this physics engine<br />
* '''Dispose()''' &mdash; destructor<br />
<br />
== PhysicsScene ==<br />
<br />
Your class OpenSim.Region.Physics.FooScene must derive from OpenSim.Region.Physics.PhysicsScene. Methods include:<br />
<br />
<dl><br />
<dt>'''public override void Initialize(IMesher meshmerizer, IConfigSource config)'''</dt><br />
<br />
<dt>'''public override PhysicsActor AddAvatar(string avName, PhysicsVector position, PhysicsVector size, bool isFlying)'''</dt><br />
<br />
<dt>'''public override void SetWaterLevel(float baseheight)'''</dt><br />
<br />
<dt>'''public override void RemovePrim(PhysicsActor prim)'''</dt><br />
<dd> This gets called when a prim is made into something the physics engine no longer needs to know about. The physics engine should remove it from any internal lists of prims it is keeping track of.</dd><br />
<br />
<dt>'''public override void RemoveAvatar(PhysicsActor character)'''</dt><br />
<dd> Like RemovePrim, but for avatars.</dd><br />
<br />
<dt>'''public override void AddPrimShape(string primName, PrimitiveBaseShape pbs, PhysicsVector position, PhysicsVector size, Quarternion rotation)'''</dt><br />
<dd> Tells the physics engine to add a new prim it needs to keep track of. This prim is ''not'' a physical prim, but as long as it's not phantom, physical objects may collide with it, and thus the physics engine (may) need to know about it. (Unless the physics engine punts on collisions, as, for instance, NewtonPlugin does.)</dd><br />
<br />
<dt>'''public override void AddPrimShape(string primName, PrimitiveBaseShape pbs, PhysicsVector position, PhysicsVector size, Quarternion rotation, bool isPhysical)'''</dt><br />
<dd>Like the previous one, but you've got the flag that tells you if it's physical or not.</dd><br />
<br />
<dt>'''public override void AddPhysicsActorTaint(PhysicsActor prim)'''</dt><br />
<dd>(I don't know what taints are, so I can't document them yet....)</dd><br />
<br />
<dt>'''public override void GetResults()'''</dt><br />
<br />
<dt>'''public override bol IsThreaded'''</dt><br />
<br />
<dt>'''public override void SetTerrain(float[] heightMap)'''</dt><br />
<br />
<dt>'''public override void DeleteTerrain()'''</dt><br />
<br />
<dt>'''public overrid Dictionary<unit, float> GetTopColliders()</dt><br />
<br />
<dt>'''public override float Simulate(float timestep)'''</dt><br />
<dd>This is the core function. This gets called by the main loop when it wants the Physics engine to do its magic and propagate forward the positions and velocities of all the stuff it knows about. The physics engine should update the Position and Velocity members of the PhysicsActor class it knows about (those things that have been added to it by the methods above). '''Important:''' when the physics engine thinks that things have changed enough for any given prims that the surrounding scene should updates it's own idea about the positions and velocities of those prims, it should call the RequestPhysicsterseUpdate() method of the changed PhysicsActors(). (The safest, but slowest, way to do this is for Simulate() to call this for every physical prim it knows about every time it is called.)</dd></div>Rknophttp://opensimulator.org/wiki/Developer_DocumentationDeveloper Documentation2009-09-18T19:19:26Z<p>Rknop: /* Physics */</p>
<hr />
<div>{{Template:Quicklinks}}<br />
<br />
[[Technical Reference | Technical Reference]] -> [[Technical Reference/terms | Terms]] -> [[Developer_Documentation | Developer Documentation]]<br />
<br />
== Developer Documentation ==<br />
<br />
==== General ====<br />
* [[Development Team]] &mdash; OpenSim is brought to you by...<br />
* [[OpenSim:Introduction_and_Definitions | OpenSim: Introduction and Definitions]] &mdash; A work in progress describing the high level components of OpenSim<br />
* [[Technical Reference | OpenSim: Technical Reference]] &mdash; A technical description of the simulator operation.<br />
* [[Grid Architecture Diagram]]<br />
* [[OpenSim: Screenshots]] &mdash; Various OpenSim screenshots.<br />
* [http://docs.opensimulator.org/index.html The OpenSim API]<br />
<br />
==== Development ====<br />
* [[Release Cycle]]<br />
* [[On revisions, tags and branches]]<br />
* [[Hacking OpenSim for fun and profit]] &mdash; A starters guide for programming OpenSim.<br />
* [[Coding standards]] &mdash; Coding conventions for developers.<br />
* [[Automated Testing]] &mdash; How to write tests for OpenSim.<br />
* [[Debugging Unit Tests]] &mdash; How to debug the automated tests.<br />
* [[Branches]] &mdash; An overview of the repository branches and what they are for.<br />
* [[Monodevelop]] &mdash; How to use the [[monodevelop]] IDE for editing C# solutions.<br />
* [[Creating New Solution]] &mdash; How to create new solution according to OpenSim conventions.<br />
* [[Improving Performance]] &mdash; Efforts to increase OpenSim's performance.<br />
<br />
==== Services ====<br />
<br />
* [http://opensimulator.org/mantis Mantis Bug Tracking] &mdash; Mantis is the issue tracking tool of OpenSimulator.<br />
* [http://www.opensimulator.org:8085/browse/OPENSIM-TRUNK Bamboo Continuous Integration] &mdash; Bamboo builds the source base continuously and runs unit tests.<br />
* [http://forge.opensimulator.org/gf/ OpenSimulator GForge] &mdash; Project hosting for OpenSimulator related projects.<br />
<br />
==== Client Stacks ====<br />
* [[Sim Throttles]] &mdash; Information on how OpenSim handles throttling of packets to the client.<br />
<br />
==== Database ====<br />
* [[Database Documentation]] &mdash; A map of grid and region instances used in OpenSim<br />
* [[MonoSqlite]] &mdash; How the database model currently works.<br />
* [[LSL:PrimitiveParams]] &mdash; Notes on converting SL Edit GUI values and LSL PrimitiveParams to OpenSim PrimitiveBaseShape fields<br />
* [[NHibernate Performance Testing]] &mdash; SQLite and MySQL performance tests with NHibernate.<br />
<br />
==== File formats ====<br />
* [[Technical_Reference/OpenSim_Archive_Region_Format]] - Opensim ARchive (OAR) region archive file format.<br />
<br />
==== Grid ====<br />
* [[Asset Server problems]] - list of known problems with the asset server<br />
* [[Teleports]] - some diagrams about OGP and Hypergrid teleport sequences<br />
* [[Agent Domain / Service]] - Details about the GridForge hosted Agent Domain/Service code<br />
<br />
==== Web Integration ====<br />
* [[Webinterface]] &mdash; How to mashup with the web.<br />
* [[RemoteAdmin]] &mdash; How to use the remote admin plug-in.<br />
* [[RestConsole]] - Description how to use the REST remote console <br />
* [[REST]] &mdash; Information about the REST interface to assets, inventory, etc.<br />
* [[Known Web Interfaces within OpenSim]] &mdash; The set of CAPS, XMLRPC, or REST entry points in the project.<br />
<br />
==== Modules ====<br />
* [[RegionModules]] &mdash; The various modules that are used in the RegionServer and how to write new ones.<br />
* [[How to create a dynamic plugin]] - A tutorial for using PluginLoader<br />
* [[Getting Started with Region Modules]] - This brief tutorial is intended to get people started with developing applications with/for opensim using region modules and the opensim API.<br />
* [[Web Statistics Module]] - The web statistics module documentation and counter wish list.<br />
<br />
==== Permissions ====<br />
* [[OpenSim:Permissions(Server)]] &mdash; Permissions system as implemented on the region server.<br />
* [[OpenSim: Permissions]] &mdash; Notes on how object permissions are handled on the client.<br />
<br />
==== Physics ====<br />
* [[PhysicsEngines]] &mdash; Options for physics engines in OpenSim.<br />
* [[Physics Engine Interface]] &mdash; what methods and such exist in a Physics module<br />
<br />
==== Protocols ====<br />
* [[Metaverse Exchange Protocol]] &mdash; MXP is alternative protocol for secondlife protocol.<br />
<br />
==== Regions ====<br />
* [[Overview of How Regions Work]] - notes from ter_afk to rknop in #opensim-dev, cleaned up a bit<br />
* [[OpenSim: Permissions]] &mdash; Notes on object permissions & definition of the ObjectFlags variable.<br />
* [[OpenSim Load Balancing and Region Splitting]] - Instructions for using load balancing and region splitting features.<br />
<br />
==== Threading ====<br />
* [[OpenSim: Threading strategy]] &mdash; How threading is implemented and handled.<br />
<br />
==== Scripting ====<br />
* [[Scripting_Documentation]] &mdash; How to use scripts and what limitations apply.<br />
* [[LSL_Status/Functions|LSL Implemented]] &mdash; A list of LSL-functions that are available in OpenSim.<br />
* [[OSSL]] &mdash; Some information about the OpenSimulator Scripting Language, and how to implement an OSSL function<br />
* [[OpenSim.Region.ScriptEngine]] &mdash; How the ScriptEngine looks internally.<br />
<br />
==== Search ====<br />
* [[OpenSim.Region.DataSnapshot]] - Shiny new data gathering/search system<br />
* [[ImageService]] - Shiny new region module for serving search-related images<br />
<br />
==== Testing ====<br />
* [[Automated_Testing]] &mdash; Writing Automated tests for OpenSim.<br />
* [[Debugging Unit Tests]] &mdash; Debugging unit tests.<br />
* [[OpenSim: Debugging - profiler dumps]] &mdash; Dumps of OpenSim profiles to aid in tracking memory leaks.<br />
* [[Prim_Linking_Testing]] &mdash; Test cases for in world link/unlinking of prims.<br />
<br />
==Proposals==<br />
<br />
* [[Opensim: 0.5 Release Target Discussion]]<br />
* [[Opensim: 0.6 Release Target Discussion]]<br />
* [[Opensim: Future Release Discussion]]<br />
<br />
* [[A better SimCrossing]] - A work in progress about implementing a smooth simcrossing<br />
* [[OpenID]] - Proposal for using OpenID in OpenSim<br />
* [[AssetServerProposal]] - Proposal for a distributed asset server<br />
* [[Creating profiles not used for login]] - RFC for alternative ways of creating profiles that will never be used for login<br />
* [[OpenSim_Services_and_Service_Connectors]] - new infrastructure for connecting region simulators to backend services<br />
* [[OpenSim Profile Anchors]] - a mechanism for retaining creator information for offline item transfers<br />
* [[Explicit Object Serialization]] - a proposal to explicitly serialize scene objects rather than using automatic .NET XML serialization<br />
<br />
==== Proposed projects ====<br />
<br />
* [[OpenWiredux: Taking the next step]]<br />
* [[Using SNMP in OpenSim]]<br />
<br />
==Communication==<br />
<br />
A good first point of contact is the OpenSim IRC, on irc.freenode.net channels #opensim / #opensim-dev. The OpenSim developers hold [[office hours]] once a week in-world on Tuesdays at "Wright Plaza" on OSGrid. There is a "Test Hour" on Saturdays, also generally on "Wright Plaza". Both these weekly events are held at 1900UTC. Check on the #opensim IRC channel on Freenode just before each of these events if there is any confusion.<br />
<br />
There is also a mailman email distribution list available at https://lists.berlios.de/mailman/listinfo/opensim-dev<br />
<br />
==Interest Groups==<br />
* [[OpenSim Quality Focus Group]] - A proposed group for developers interested in improving the quality of OpenSim as we head towards beta status.<br />
<br />
==Git Access==<br />
You can browse the source code for OpenSim [http://opensimulator.org/viewgit using a web browser] or via git.<br />
* Anonymous Checkout - see [[Download]]<br />
* Developer Checkout<br />
git clone ssh://USERNAME@opensimulator.org/var/git/opensim<br />
<br />
==Submitting Patches==<br />
<br />
Please review [[Submitting_code_to_OpenSim]]<br />
<br />
==Recent Git Commits==<br />
<rss>http://opensimulator.org/viewgit?a=rss-log&p=opensim|max=5|title=none</rss><br />
<br />
[[Category:Main]]<br />
[[Category:Support]]<br />
[[Category:Tech Reference]] <br />
[[Category:Help]]<br />
[[Category:Configuration]]<br />
[[Category:Getting_Started]]<br />
[[Category:Development]]<br />
<cleanpage title=hide cats=hide /></div>Rknophttp://opensimulator.org/wiki/Overview_of_How_Regions_WorkOverview of How Regions Work2009-09-18T19:16:48Z<p>Rknop: New page: The following is based on a brief discussion between ter_afk and rknop on #opensim-dev. It's archived here so that hopefully others can benefit from it. == Scene: the Core of the Region ...</p>
<hr />
<div>The following is based on a brief discussion between ter_afk and rknop on #opensim-dev. It's archived here so that hopefully others can benefit from it.<br />
<br />
== Scene: the Core of the Region ==<br />
<br />
OpenSim.Region.Framework.Scenes.Scene is the "heart" of OpenSimulator's functionality. The method Scene.Heartbeat() starts the heartbeat going; it does this by calling the Update() method. That method is the "main loop" of the region:<br />
<br />
<pre><br />
public override void Update()<br />
{<br />
int maintc = 0;<br />
while (!shuttingdown)<br />
{<br />
</pre><br />
<br />
That loop is run over and over again. At the bottom of the loop is:<br />
<br />
<pre><br />
maintc = Environment.TickCount - maintc;<br />
maintc = (int)(m_timespan * 1000) - maintc;<br />
<br />
if ((maintc < (m_timespan * 1000)) && maintc > 0)<br />
Thread.Sleep(maintc);<br />
}<br />
}<br />
</pre><br />
<br />
In other words, if everything else didn't take as long as one heartbeat is supposed to take, the thread goes to sleep until it's time to service the next heartbeat. This heartbeat runs about 10 times a second.<br />
<br />
Other modules of all sorts can register heartbeat events that get called each pass through the main loop, and there are other events that modules can register for as well. (Details forthcoming....)<br />
<br />
== Which regions run? ==<br />
<br />
The <tt>bin/Regions/Regions.ini</tt> file determines which regions run. Here's an example:<br />
<br />
<pre><br />
[Test]<br />
RegionUUID = 4b516a07-aa32-47e4-b4d9-52116255b4d2<br />
Location = 1000,1000<br />
InternalAddress = 127.0.0.1<br />
InternalPort = 9000<br />
AllowAlternatePorts = False<br />
ExternalHostName = SYSTEMIP<br />
MasterAvatarFirstName = Master<br />
MasterAvatarLastName = Avatar<br />
MasterAvatarSandboxPassword = master_avatar_password<br />
</pre></div>Rknophttp://opensimulator.org/wiki/Developer_DocumentationDeveloper Documentation2009-09-18T19:09:57Z<p>Rknop: /* Regions */</p>
<hr />
<div>{{Template:Quicklinks}}<br />
<br />
[[Technical Reference | Technical Reference]] -> [[Technical Reference/terms | Terms]] -> [[Developer_Documentation | Developer Documentation]]<br />
<br />
== Developer Documentation ==<br />
<br />
==== General ====<br />
* [[Development Team]] &mdash; OpenSim is brought to you by...<br />
* [[OpenSim:Introduction_and_Definitions | OpenSim: Introduction and Definitions]] &mdash; A work in progress describing the high level components of OpenSim<br />
* [[Technical Reference | OpenSim: Technical Reference]] &mdash; A technical description of the simulator operation.<br />
* [[Grid Architecture Diagram]]<br />
* [[OpenSim: Screenshots]] &mdash; Various OpenSim screenshots.<br />
* [http://docs.opensimulator.org/index.html The OpenSim API]<br />
<br />
==== Development ====<br />
* [[Release Cycle]]<br />
* [[On revisions, tags and branches]]<br />
* [[Hacking OpenSim for fun and profit]] &mdash; A starters guide for programming OpenSim.<br />
* [[Coding standards]] &mdash; Coding conventions for developers.<br />
* [[Automated Testing]] &mdash; How to write tests for OpenSim.<br />
* [[Debugging Unit Tests]] &mdash; How to debug the automated tests.<br />
* [[Branches]] &mdash; An overview of the repository branches and what they are for.<br />
* [[Monodevelop]] &mdash; How to use the [[monodevelop]] IDE for editing C# solutions.<br />
* [[Creating New Solution]] &mdash; How to create new solution according to OpenSim conventions.<br />
* [[Improving Performance]] &mdash; Efforts to increase OpenSim's performance.<br />
<br />
==== Services ====<br />
<br />
* [http://opensimulator.org/mantis Mantis Bug Tracking] &mdash; Mantis is the issue tracking tool of OpenSimulator.<br />
* [http://www.opensimulator.org:8085/browse/OPENSIM-TRUNK Bamboo Continuous Integration] &mdash; Bamboo builds the source base continuously and runs unit tests.<br />
* [http://forge.opensimulator.org/gf/ OpenSimulator GForge] &mdash; Project hosting for OpenSimulator related projects.<br />
<br />
==== Client Stacks ====<br />
* [[Sim Throttles]] &mdash; Information on how OpenSim handles throttling of packets to the client.<br />
<br />
==== Database ====<br />
* [[Database Documentation]] &mdash; A map of grid and region instances used in OpenSim<br />
* [[MonoSqlite]] &mdash; How the database model currently works.<br />
* [[LSL:PrimitiveParams]] &mdash; Notes on converting SL Edit GUI values and LSL PrimitiveParams to OpenSim PrimitiveBaseShape fields<br />
* [[NHibernate Performance Testing]] &mdash; SQLite and MySQL performance tests with NHibernate.<br />
<br />
==== File formats ====<br />
* [[Technical_Reference/OpenSim_Archive_Region_Format]] - Opensim ARchive (OAR) region archive file format.<br />
<br />
==== Grid ====<br />
* [[Asset Server problems]] - list of known problems with the asset server<br />
* [[Teleports]] - some diagrams about OGP and Hypergrid teleport sequences<br />
* [[Agent Domain / Service]] - Details about the GridForge hosted Agent Domain/Service code<br />
<br />
==== Web Integration ====<br />
* [[Webinterface]] &mdash; How to mashup with the web.<br />
* [[RemoteAdmin]] &mdash; How to use the remote admin plug-in.<br />
* [[RestConsole]] - Description how to use the REST remote console <br />
* [[REST]] &mdash; Information about the REST interface to assets, inventory, etc.<br />
* [[Known Web Interfaces within OpenSim]] &mdash; The set of CAPS, XMLRPC, or REST entry points in the project.<br />
<br />
==== Modules ====<br />
* [[RegionModules]] &mdash; The various modules that are used in the RegionServer and how to write new ones.<br />
* [[How to create a dynamic plugin]] - A tutorial for using PluginLoader<br />
* [[Getting Started with Region Modules]] - This brief tutorial is intended to get people started with developing applications with/for opensim using region modules and the opensim API.<br />
* [[Web Statistics Module]] - The web statistics module documentation and counter wish list.<br />
<br />
==== Permissions ====<br />
* [[OpenSim:Permissions(Server)]] &mdash; Permissions system as implemented on the region server.<br />
* [[OpenSim: Permissions]] &mdash; Notes on how object permissions are handled on the client.<br />
<br />
==== Physics ====<br />
* [[PhysicsEngines]] &mdash; Options for physics engines in OpenSim.<br />
<br />
==== Protocols ====<br />
* [[Metaverse Exchange Protocol]] &mdash; MXP is alternative protocol for secondlife protocol.<br />
<br />
==== Regions ====<br />
* [[Overview of How Regions Work]] - notes from ter_afk to rknop in #opensim-dev, cleaned up a bit<br />
* [[OpenSim: Permissions]] &mdash; Notes on object permissions & definition of the ObjectFlags variable.<br />
* [[OpenSim Load Balancing and Region Splitting]] - Instructions for using load balancing and region splitting features.<br />
<br />
==== Threading ====<br />
* [[OpenSim: Threading strategy]] &mdash; How threading is implemented and handled.<br />
<br />
==== Scripting ====<br />
* [[Scripting_Documentation]] &mdash; How to use scripts and what limitations apply.<br />
* [[LSL_Status/Functions|LSL Implemented]] &mdash; A list of LSL-functions that are available in OpenSim.<br />
* [[OSSL]] &mdash; Some information about the OpenSimulator Scripting Language, and how to implement an OSSL function<br />
* [[OpenSim.Region.ScriptEngine]] &mdash; How the ScriptEngine looks internally.<br />
<br />
==== Search ====<br />
* [[OpenSim.Region.DataSnapshot]] - Shiny new data gathering/search system<br />
* [[ImageService]] - Shiny new region module for serving search-related images<br />
<br />
==== Testing ====<br />
* [[Automated_Testing]] &mdash; Writing Automated tests for OpenSim.<br />
* [[Debugging Unit Tests]] &mdash; Debugging unit tests.<br />
* [[OpenSim: Debugging - profiler dumps]] &mdash; Dumps of OpenSim profiles to aid in tracking memory leaks.<br />
* [[Prim_Linking_Testing]] &mdash; Test cases for in world link/unlinking of prims.<br />
<br />
==Proposals==<br />
<br />
* [[Opensim: 0.5 Release Target Discussion]]<br />
* [[Opensim: 0.6 Release Target Discussion]]<br />
* [[Opensim: Future Release Discussion]]<br />
<br />
* [[A better SimCrossing]] - A work in progress about implementing a smooth simcrossing<br />
* [[OpenID]] - Proposal for using OpenID in OpenSim<br />
* [[AssetServerProposal]] - Proposal for a distributed asset server<br />
* [[Creating profiles not used for login]] - RFC for alternative ways of creating profiles that will never be used for login<br />
* [[OpenSim_Services_and_Service_Connectors]] - new infrastructure for connecting region simulators to backend services<br />
* [[OpenSim Profile Anchors]] - a mechanism for retaining creator information for offline item transfers<br />
* [[Explicit Object Serialization]] - a proposal to explicitly serialize scene objects rather than using automatic .NET XML serialization<br />
<br />
==== Proposed projects ====<br />
<br />
* [[OpenWiredux: Taking the next step]]<br />
* [[Using SNMP in OpenSim]]<br />
<br />
==Communication==<br />
<br />
A good first point of contact is the OpenSim IRC, on irc.freenode.net channels #opensim / #opensim-dev. The OpenSim developers hold [[office hours]] once a week in-world on Tuesdays at "Wright Plaza" on OSGrid. There is a "Test Hour" on Saturdays, also generally on "Wright Plaza". Both these weekly events are held at 1900UTC. Check on the #opensim IRC channel on Freenode just before each of these events if there is any confusion.<br />
<br />
There is also a mailman email distribution list available at https://lists.berlios.de/mailman/listinfo/opensim-dev<br />
<br />
==Interest Groups==<br />
* [[OpenSim Quality Focus Group]] - A proposed group for developers interested in improving the quality of OpenSim as we head towards beta status.<br />
<br />
==Git Access==<br />
You can browse the source code for OpenSim [http://opensimulator.org/viewgit using a web browser] or via git.<br />
* Anonymous Checkout - see [[Download]]<br />
* Developer Checkout<br />
git clone ssh://USERNAME@opensimulator.org/var/git/opensim<br />
<br />
==Submitting Patches==<br />
<br />
Please review [[Submitting_code_to_OpenSim]]<br />
<br />
==Recent Git Commits==<br />
<rss>http://opensimulator.org/viewgit?a=rss-log&p=opensim|max=5|title=none</rss><br />
<br />
[[Category:Main]]<br />
[[Category:Support]]<br />
[[Category:Tech Reference]] <br />
[[Category:Help]]<br />
[[Category:Configuration]]<br />
[[Category:Getting_Started]]<br />
[[Category:Development]]<br />
<cleanpage title=hide cats=hide /></div>Rknop