Developer Documentation

From OpenSimulator

(Difference between revisions)
Jump to: navigation, search
Line 90: Line 90:
==== Map ====
==== Map ====
* [[Map]] - Mapping overview
* [[Warp3DImageModule]] — This is an improved map image module.
* [[Warp3DImageModule]] — This is an improved map image module.

Revision as of 14:57, 8 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

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


  • Teleports - some diagrams about OGP 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.

Feature Proposals

Please see the Feature Proposals page.


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

a bit more cosmetics in lsl api (UbitUmarov) (Tue, 22 Jun 2021 05:33:03 -0700)
a bit more cosmetics in lsl api UbitUmarov <ajlduarte at sapo dot pt> .../Shared/Api/Implementation/LSL_Api.cs
add other animation asset (UbitUmarov) (Thu, 17 Jun 2021 10:40:20 -0700)
add other animation asset UbitUmarov <ajlduarte at sapo dot pt> .../0e720142-0d4b-cf1d-cae5-277f58299604.dat
add some animation assets (UbitUmarov) (Wed, 16 Jun 2021 19:20:09 -0700)
add some animation assets UbitUmarov <ajlduarte at sapo dot pt> .../038fcec9-5ebd-8a8e-0e2e-6e71a0a1ac53.dat
put back a lludp received buffers queue for usecircuit processing (UbitUmarov) (Mon, 07 Jun 2021 07:50:17 -0700)
put back a lludp received buffers queue for usecircuit processing UbitUmarov <ajlduarte at sapo dot pt> .../Region/ClientStack/Linden/UDP/LLUDPServer.cs
fix osGetGridNick() i did break on recent commit (UbitUmarov) (Thu, 03 Jun 2021 08:39:03 -0700)
fix osGetGridNick() i did break on recent commit UbitUmarov <ajlduarte at sapo dot pt> .../Shared/Api/Implementation/OSSL_Api.cs

Personal tools
About This Wiki