Developer Documentation

From OpenSimulator

(Difference between revisions)
Jump to: navigation, search
Line 113: Line 113:
==== Regions/Scenes ====
==== Regions/Scenes ====
* [[Overview of How Regions Work]] - notes from ter_afk to rknop in #opensim-dev, cleaned up a bit
* [[Overview of How Regions Work]]
* [[OpenSim: Permissions]] — Notes on object permissions & definition of the ObjectFlags variable.
* [[OpenSim: Permissions]] — Notes on object permissions & definition of the ObjectFlags variable.
* [[OpenSim Load Balancing and Region Splitting]] - Instructions for using load balancing and region splitting features.
* [[OpenSim Load Balancing and Region Splitting]] - Instructions for using load balancing and region splitting features.

Revision as of 12:52, 29 October 2012


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


  • 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

File formats

  • 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.


  • Teleports - some diagrams about normal grid teleport and hypergrid teleport sequences.
  • Agent Domain / Service - Details about the GridForge hosted Agent Domain/Service code


  • 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.



  • Region module basics - The basics of how to create a region module, and where example code can be found in the OpenSimulator source tree.





  • 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.





  • 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

do init new acd circuit code + cosmetics (UbitUmarov) (Sun, 17 Jan 2021 07:07:35 -0800)
do init new acd circuit code + cosmetics UbitUmarov <ajlduarte at sapo dot pt> OpenSim/Framework/AgentCircuitManager.cs
avoid a null ref on hg useragentservice (UbitUmarov) (Thu, 14 Jan 2021 12:23:20 -0800)
avoid a null ref on hg useragentservice UbitUmarov <ajlduarte at sapo dot pt> .../Services/HypergridService/UserAgentService.cs
more changes to smartthreadpool (UbitUmarov) (Wed, 13 Jan 2021 08:23:49 -0800)
more changes to smartthreadpool UbitUmarov <ajlduarte at sapo dot pt> ThirdParty/SmartThreadPool/STPEventWaitHandle.cs
simplify groups v2 cache (UbitUmarov) (Wed, 13 Jan 2021 03:16:32 -0800)
simplify groups v2 cache UbitUmarov <ajlduarte at sapo dot pt> .../Addons/Groups/RemoteConnectorCacheWrapper.cs
fix groups v2 notices (UbitUmarov) (Wed, 13 Jan 2021 02:39:51 -0800)
fix groups v2 notices UbitUmarov <ajlduarte at sapo dot pt> OpenSim/Addons/Groups/GroupsModule.cs

Personal tools
About This Wiki