OpenSimulator - User contributions [en]

User:KMeist Hax

2008-05-30T21:44:11Z

KMeist Hax: /* Contact info */

soup /opensim/ KMeist Hax, part time opensim developer and /b/tard here. Makes region modules and doesn't afraid of anything.

== Projects ==

I am currently responsible for the following projects:

* [[OpenSim.Region.DataSnapshot|Data Snapshot Module and Format]] - Search the open metaverse -- and beyond!
* That's pretty much it

== Contact info ==

If I accidentally broke your sims with my code, you have a feature request, or just want to talk, you can contact me via the following ways:

=== MAIN CONTACT METHODS ===
* Freenode IRC - '''kmeisthax''' / '''kmeisthax_afk''' has been known to lurk #opensim and #opensim-dev from time to time.
: Please private-message any questions as I often have the IRC window on my secondary machine and I might miss chat lines.
* AIM - '''lotsostuff1''' - I've had this username since my underage b& days!
* MSN - '''km767 YOUKNOWWHATGOESHERE hotmail EARTHBOUND com''' - Replace "YOUKNOWWHATGOESHERE" with that little A in a circle symbol. Replace "EARTHBOUND" with a dot.
* (in korea, only old people use) E-mail - '''dcrkid YOUKNOWWHATGOESHERE yahoo EARTHBOUND com''' - Same as the MSN account, let's hope the spambots don't just grab stuff with yahoo in it nowadays.

=== GAMES (and things that pretend to not be games) ===
* Linden Lab's grid - username '''KMeist Hax'''.
* OSGrid - Again, '''KMeist Hax'''.
* Steam - I know it's against RMS's wishes to play proprietary games, but [http://steamcommunity.com/id/kmeisthax '''Little Strawberry'''] just can't get enough Team Fortress 2.

=== ETC ===
* Blog - [http://jadestern.blogspot.com Track my life with unending detail!] --- whenever I update it

Developer Documentation

2008-04-14T23:49:21Z

KMeist Hax: /* Developer Documentation */ added link to OS.R.DS

{{Template:Quicklinks}}
== Communication ==

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.

== Developer Documentation ==
You can view the current [[Top 10 Bugs|top 10 bugs]] blocking forward development.

* [[OpenSim: Debugging - profiler dumps]] — Dumps of OpenSim profiles to aid in tracking memory leaks.
* [[OpenSim: Testing]] — What is tested.
* [[OpenSim: TechRef]] — A technical description of the simulator operation.
* [[OpenSim: Grids]] — Known Public grids currently available.
* [[Opensim: 0.5 Release Target Discussion]]
* [[Opensim: 0.6 Release Target Discussion]]
* [[Opensim: Future Release Discussion]]
* [[OpenSim: Class Diagrams]]
* [[Grid Architecture Diagram]]
* [[OpenSim: Scripting]] — How to use scripts and what limitations apply.
* [[Webinterface]] — How to mashup with the web.
* [[RemoteAdmin]] — How to use the remote admin plug-in.
* [[OpenSim: Prim Inventory Persistence]] — Information on the current state of prim inventory persistence.
* [[PhysicsEngines]] — Options for physics engines in OpenSim.
* [[MonoSqlite]] — How the database model currently works.
* [[Monodevelop]] — How to use the [[monodevelop]] IDE for editing C# solutions.
* [[LSL Status]] — LSL implementation progress.
* [[LSL:PrimitiveParams]] Notes on converting SL Edit GUI values and LSL PrimitiveParams to OpenSim PrimitiveBaseShape fields
* [[OpenSim.Region.ScriptEngine]] — How the ScriptEngine looks internally.
* [[RegionModules]] — The various modules that are used in the RegionServer and how to write new ones.
* [[OpenSim: Screenshots]] — Various OpenSim screenshots.
* [[OpenSim: Threading strategy]] — How threading is implemented and handled.
* [[OpenSim: Permissions]] — Notes on object permissions & definition of the ObjectFlags variable.
* [[: Installation|Installing OpenSim]] - Instructions for compiling and running OpenSim on various platforms.
* [[Special Building]] — Special building instructions.
* [[OpenSim Load Balancing and Region Splitting]] - Instructions for using load balancing and region splitting features.
* [[Asset Server problems]] - list of known problems with the asset server
* [[OpenID]] - Proposal for using OpenID in OpenSim
* [[OpenSim.Region.DataSnapshot]] - Shiny new data gathering/search system

== SVN Access ==
You can browse the source code for OpenSim [http://opensimulator.org/cgi-bin/viewcvs.cgi using a web browser] or via SVN.

=== Anonymous Checkout ===
svn co http://opensimulator.org/svn/opensim/trunk

=== Developer Checkout ===
svn co svn+ssh://USERNAME@opensimulator.org/var/svn/opensim/trunk

== Recent SVN Commits ==
<rss>http://cia.vc/stats/project/opensim/.rss|max=5|title=none</rss>

[[Category:Main]]
[[Category:Getting Started]]
[[Category:Development]]
<cleanpage title=hide cats=hide />

OpenSim.Region.DataSnapshot

2008-04-14T23:48:18Z

KMeist Hax: initial dox for datasnapshot

The DataSnapshot module is an [[RegionModules|IRegionModule]] that takes data from various parts of the OpenSim Scene and spits out a custom-format XML file. From this you can have web services mashup with the output data. Consider it analogous to a "Search API", although it's not limited to simple Search. It was birthed after a discussion on the mailing list several months ago about search when Diva contacted me and gave me her ideas. Throughout the course of about a month off and on we worked on this proof-of-concept module. I'm calling it a proof-of-concept for now

== Module inner workings ==
The module is implemented as any other Region Module. The IRegionModule class itself is DataSnapshotManager.

=== DataSnapshotManager ===
This is the 'main' class for the module - it handles registering the IDataSnapshotProvider objects, creates the DataRequestHandler, and contains functions for generating snapshots. Notable functions:

* Initialise - Obtained from IRegionModule. Checks if the config is loaded, and adds each scene being simulated to it's internal list of regions to scrape for data.
* PostInitialise - The second most important function. Registers the timer callback, and searches the containing Assembly for IDataSnapshotProvider objects. Creates an IDataSnapshotProvider for each Scene and IDataSnapshotProvider combination. When the format and interface stabilises, we can then let this start checking other Assemblies for IDataSnapshotProviders. Then it makes the DataRequestHandler object and hands it the first scene. Finally, it checks to see if it needs to ping any external servers (as determined by configuration).
* Snapshot (private) - Spits out an XmlDocument from a Scene. Each XmlDocument can be sent directly as a response to a data request, but GetSnapshot can also merge them into a single response for every Scene being simulated by the host.
* GetSnapshot - Called from DataSnapshotManager. Should really be a part of DataRequestHandler.
* MakeRegionNode - Creates some of the XML in the format, would be in a IDataSnapshotProvider but currently the way their output goes into the format doesn't mesh with the interface well. Might want to rework the format later or something.
* NotifyDataServices - Responsible for pinging an external server defined in our configuration options.
* SnapshotTimerCallback - Notable for being useless. All it does is call MakeNewSnapshot. If you want anything else to happen when the snapshot timer elapses, add it here. I really should have just added MakeNewSnapshot to the timer directly.
* GetErrorMessage - Makes an error for GetSnapshot in case of an exception (missing file, etc)
* GetGridSnapshotData - Takes key-value pairs from GridData and makes it into XML, populated during the first Initialise call.
* GetRegionCategory - Helper function, only notable because originally when the Scene had no Mature or PG flag set it would return "PN Testing Sandbox", aka griefer heaven. Now returns a completely boring "Unknown", hence the comment.

...I think that's everything worth mentioning.

=== DataRequestHandler ===
A very small class that makes responses to requests for data.... All it does is register a callback to Scene.AddHTTPHandler - a function we added to Scene just for this module. Yes you can register handlers to BaseHTTPServer from a RegionModule now.

Really deserves to have the GetSnapshot function instead of DataSnapshotManager.

=== IDataSnapshotProvider ===
You'll find it in the interfaces folder. This nice little class provides most of the data for our module. The Interface exposed is analogous to IRegionModule, and is loaded in the same way except that we currently only load from the same Assembly.

public interface IDataSnapshotHandler {
XmlNode RequestSnapshotData (XmlDocument document);
void Initialize (Scene scene, DataSnapshotManager parent);
Scene GetParentScene { get; }
}

* Initialize - Gives you a scene and parent object. Also you can establish some callbacks if you want.
* RequestSnapshotData - Gives you an XmlDocument to use as a node factory. Return an XmlNode here, one made from the factory. (Otherwise exceptions will result)
* GetParentScene - Return the parent scene here.

== XML Format ==
Write this later (should be evident from code)

== Config options ==
You need to have a <nowiki>[DataSnapshot]</nowiki> section in your OpenSim.ini configuration and index_sims set to true before DataSnapshot will do anything.
Other interesting options:

* snapshot_cache_directory - Folder to save snapshots to. Default is "DataSnapshot".
* data_services - Server to ping to alert of snapshots.
* disable_modules - Option to disable a module by name. Not actually working yet.

== Todos ==
* Script-provided Snapshot data. Would require adding a function to the common builtin commands _OR_ reworking the script engine to allow RegionModules to register their own functions to ScriptEngines. The first one is easy but WRONG, the second one is right but HARD.
* Regression test with 3Di's [[OpenSim Load Balancing and Region Splitting]] work. Theoretically, this shouldn't create any problems since we don't make any permenant data that needs to be transferred with a simulator. MAYBE the data services option, since that would probably be the choice of the region owner and should float with the region.
* Make disable_modules work
* Etc

User:KMeist Hax

2008-04-14T22:42:24Z

KMeist Hax: imma chargin mah userpage

soup /opensim/ KMeist Hax, part time opensim developer and /b/tard here. Makes region modules and doesn't afraid of anything.

== Projects ==

I am currently responsible for the following projects:

* [[OpenSim.Region.DataSnapshot|Data Snapshot Module and Format]] - Search the open metaverse -- and beyond!
* That's pretty much it

== Contact info ==

If I accidentally broke your sims with my code, you have a feature request, or just want to talk, you can contact me via the following ways:

* Linden Lab's grid - username '''KMeist Hax'''.
* OSGrid - Again, '''KMeist Hax'''.
* Steam - Play a game of Team Fortress 2 with '''KMeist_Hax''' sometime.
* Freenode IRC - '''kmeisthax''' / '''kmeisthax_afk''' has been known to lurk #opensim and #opensim-dev from time to time
* AIM - '''lotsostuff1''' - I've had this username since my underage b& days!
* MSN - '''km767 YOUKNOWWHATGOESHERE hotmail EARTHBOUND com''' - Replace "YOUKNOWWHATGOESHERE" with that little A in a circle symbol. Replace "EARTHBOUND" with a dot.
* (in korea, only old people use) E-mail - '''dcrkid YOUKNOWWHATGOESHERE yahoo EARTHBOUND com''' - Same as the MSN account, let's hope the spambots don't just grab stuff with yahoo in it nowadays.

IRegionModule

2008-02-12T23:19:48Z

KMeist Hax:

== Introduction ==
A key design principle of OpenSim is the heavy use of plug-ins. All the key components of OpenSim are designed to be replaceable or extensible at runtime.

* Database engines can be replaced (currently OpenSim has full support for)
** SQLite
** MySQL
** db4o is partially implemented
** MS-SQL Server is fairly complete but largely untested.
* Backend servers can be replaced by changing a url, currently there are servers for:
** User authentication
** Grid registration
** Asset storage
** Script execution
* Script languages can be replaced
* ''Region modules can be added''

Region modules are .net/mono dlls. During initialization of the simulator, the current directory (/bin) and the scriptengines (/ScriptEngines) directory are scanned for dlls, in an attempt to load region modules stored there.

Region modules execute within the heart of the simulator. Typically region modules register for a number of events, e.g. chat messages, user logins, texture transfers, and take what ever steps are appropriate for the purposes of the module.

== Interface ==
All region modules must implement this interface:

public interface IRegionModule
{
void Initialise(Scene scene);
void PostInitialise();
void Close();
string Name { get; }
bool IsSharedModule { get; }
}

<table>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
<tr>
<td>Initialize</td>
<td>This method is called immediately after the region module has been loaded by the sim. At this time the module is passed a reference to the scene contained within the sim. The region module should store this reference for later use. Care should be taken, not to depend on the scene and/or sim being fully loaded and running at this time.
</td>
</tr>
<tr>
<td>PostInitialize</td>
<td>Once the sim is fully initialized and all region modules have been loaded, the sim will invoke PostInitialize on all loaded region modules. At this point the sim will be fully operational, and it should be safe to invoke any method on the scene.</td>
</tr>
<tr>
<td>Close</td>
<td>This method will be invoked when the sim is closing down.</td>
</tr>
<tr>
<td>Name</td>
<td>This name is shown when the console command "show modules" is ran. It's should be a nice name like "Sim Chat Module" or "The Best Region Module Ever".</td>
</tr>
<tr>
<td>IsSharedModule</td>
<td>The simulator process (OpenSim.exe) supports running multiple regions (internally, a Scene object) on a single simulator process. If this returns True, the module will only be loaded once and Initialize will be called for each Scene being simulated. If false, a separate copy of your RegionModule will be created for each Scene.</td>
</tr>
</table>

== How to write a new region module ==
=== Walk through on Windows ===
On Windows, using Visual studio, this is what you need to do, to create a new region module:

#Create a new project
##File, New, Project
##Select "Visual C#", "Class Library"
##Give the region module some good name, like: "MyRegionModule"
#Reference the required OpenSim assemblies
##Right click on "References" and choose "Add Reference..."
##Choose the browse tab
##Navigate to the bin folder of OpenSim
##Select "OpenSim.Framework.dll"
##Click Ok
##Right click once more on "References" and choose "Add Reference..."
##Select "OpenSim.Region.Environment.dll"
##Click Ok
#Change default class, to a meaningfull name
##Right click on "Class1.cs" and rename the file to "MyRegionModuleMain.cs

Now the code should look something like this:

using System;
using System.Collections.Generic;
using System.Text;

namespace MyRegionModule
{
public class MyRegionModuleMain
{
}
}

delete the unwanted <tt>using</tt> lines:

using System.Collections.Generic;
using System.Text;

now, the program should contain:

using System;

namespace MyRegionModule
{
public class MyRegionModuleMain
{
}
}

add references to the main OpenSim modules:

using OpenSim.Region.Environment.Interfaces;
using OpenSim.Region.Environment.Scenes;

specify that <tt>MyRegionModuleMain</tt> should inherit from the <tt>IRegionModule</tt> interface:

using System;
using OpenSim.Region.Environment.Interfaces;
using OpenSim.Region.Environment.Scenes;

namespace MyRegionModule
{
public class MyRegionModuleMain : IRegionModule
{
}
}

Right click on the "IRegionModule" name, and select "Implement interface", "Implement Interface"; this will add an empty implementation of the interface required for a region module. If you compile the module, and ensure that the resulting .dll file is stored in the /bin directory of OpenSim, the region module will be loaded and exected the next time you start the sim.

The close observer will have noticed that this region module will not do anything worthwhile; in fact it will cause OpenSim to log a warning about exceptions in a loaded module.
[[Category:Development]]