Developer Documentation

From OpenSimulator

Revision as of 12:39, 21 March 2013 by Justincc (Talk | contribs)

Jump to: navigation, search


Source Code Repository Access

OpenSimulator uses git as its source code repository. Checkout

git clone git://

See Source Code Repository for more details.

See Using Git for more Details on installing and using GIT with

You can also browse the source code for OpenSimulator using a web browser.

We have Ohloh page, which takes various statistics of the OpenSimulator code base.

This is also an opensim-libs git repository which contains the source code to some of the 3rd party libraries built and included in OpenSimulator.


Submitting Patches

Please review Submitting code to OpenSim

Feature Proposals

Larger changes may require feature proposals depending on whether they introduce or significantly change existing functionality. Please use your judgement to determine whether this is required.

For more details please see the Feature Proposals page.

Developer Documentation

Please be aware that some of this documentation may be out of date. If this appears to be the case then please ask for more information on the mailing lists or IRC channels (details are on the Main Page). If you can't find what you want here you might want to try looking in the User Documentation.






  • Connectors — A description of OpenSimulator's connector architecture, used for linking region code with services (asset, inventory, etc.) in both local (standalone) and distributed (grid) configurations.
  • Services - A description of the grid and simulator services used by OpenSimulator.

Client Stacks

  • Sim Throttles — Information on how OpenSimulator handles throttling of packets to the client.

Communication Protocols

  • Communication Protocols - Introduction to the various communication protocols used by OpenSimulator. This includes viewer to OpenSimulator protocols, inter-region protocols and grid service protocols.
  • Agent Domain / Service - Details about the GridForge hosted Agent Domain/Service code (legacy doc since this LL inspired work has long been abandoned).


  • Database Documentation — Information on the database schemas used in OpenSimulator
  • MonoSqlite — How the database model currently works.
  • LSL:PrimitiveParams — Notes on converting SL Edit GUI values and LSL PrimitiveParams to OpenSimulator PrimitiveBaseShape fields


  • OpenSim Archives - Opensim Region Archive (OAR) file format.
  • Inventory Archives - OpenSimulator Inventory Archive (IAR) file format
  • Asset Formats - OpenSimulator asset formats. This includes serialized object formats and appearance formats.

Entity Transfer

  • Teleports - documentation on how user teleports are handled in different scenarios (within region, within simulator, between simulators, etc.).


  • AuthIntegration - How to integrate external authentication systems (such as web frontends) with OpenSimulator's authentication system.
  • ClothingManipulation - How to set clothing on avatars using external ROBUST service calls.
  • UserManipulation - How to create users in OpenSimulator via external calls through ROBUST (only available when running in grid configuration).
  • RemoteAdmin - How to use the remote admin plug-in. Some functions (e.g. user creation) are only available when running in standalone configuration.
  • RegionIntegration - Integrating a region and the things within it (scene objects, etc.) with external sources of data and webpages.
  • RestConsole - Description how to use the REST remote console
  • REST - Information about the REST interface to assets, inventory, etc.
  • Webinterface - Integrating the external face of OpenSimulator with the web.
  • Services - Contains general information on the default OpenSimulator services (asset, inventory, etc.) and more detailed information of HTTP interfaces for some services.
  • Known Web Interfaces within OpenSim - The set of CAPS, XMLRPC, or REST entry points in the project.






  • Scripting Documentation — How to use scripts and what limitations apply.
  • LSL Status — A list of LSL-functions that are available in OpenSimulator.
  • OSSL — Some information about the OpenSimulator Scripting Language, and how to implement an OSSL function
  • OpenSim.Region.ScriptEngine — How the ScriptEngine looks internally.




  • Threading — Information on the way that threads are used in OpenSimulator.


  • Appearance Troubleshooting - Also contains useful information about avatar behave and the relevant message exchanges between the viewer and the simulator.
  • Userlevel — Explanation of permissions granted via "God Mode"/Admin Status.


A good first point of contact is the OpenSimulator IRC, on channels #opensim / #opensim-dev / #osgrid / #opensim-scripting. The OpenSimulator 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 in summer time and 2000UTC in winter. Check on the #opensim IRC channel on Freenode just before each of these events if there is any confusion.

There is also a development mailing list when development discussion takes place.

Recent Git Commits

let urlmodule pool request do some work ( missing from last commit) (UbitUmarov) (Sun, 29 Nov 2020 04:35:02 -0800)
let urlmodule pool request do some work ( missing from last commit) UbitUmarov <ajlduarte at sapo dot pt> .../CoreModules/Scripting/LSLHttp/UrlModule.cs
reenable keepalive local override, + cosmetics (UbitUmarov) (Sun, 29 Nov 2020 04:29:18 -0800)
reenable keepalive local override, + cosmetics UbitUmarov <ajlduarte at sapo dot pt> .../Framework/Servers/HttpServer/BaseHttpServer.cs
xmlrpc handler, remove a useless tmp string, that can be large, and implicit convertions to utf-16 and back to utf-8, make the serielization be already utf8 (UbitUmarov) (Sat, 28 Nov 2020 12:52:05 -0800)
xmlrpc handler, remove a useless tmp string, that can be large, and implicit convertions to utf-16 and back to utf-8, make the serielization be already utf8 UbitUmarov <ajlduarte at sapo dot pt> .../Framework/Servers/HttpServer/BaseHttpServer.cs
handle missing entries on GridUserData (UbitUmarov) (Thu, 26 Nov 2020 17:08:10 -0800)
handle missing entries on GridUserData UbitUmarov <ajlduarte at sapo dot pt> .../Services/UserAccountService/GridUserService.cs
ofc i forgot a file (UbitUmarov) (Thu, 26 Nov 2020 15:54:20 -0800)
ofc i forgot a file UbitUmarov <ajlduarte at sapo dot pt> .../Handlers/Login/LLLoginServiceInConnector.cs

Personal tools
About This Wiki