Developer Documentation

From OpenSimulator

Revision as of 11:18, 18 July 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

  • LLUDP ClientStack - Information on the LLUDP client stack used by OpenSimulator to send and receive UDP packets from viewers implementing the Linden Labs virtual environment protocol.
  • 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

Entity Transfer

  • Logout - information about user logout.
  • SimulatorLoginProtocol - information about user login.
  • Teleports - documentation on how user teleports are handled in different scenarios (within region, within simulator, between simulators, etc.).


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


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



  • Sound Protocol - Technical information about the sound protocols (e.g. UDP messages between viewer and server).



  • 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.
  • Attachment Protocols - Information on the attachment protocols used by viewers and OpenSimulator.
  • Name Binding - Some information on how OpenSimulator (and Second Life) binds user UUIDs to names (e.g. 25bf6e60-91c0-4d28-8349-ba254cd4388e -> Jane Doe).
  • Userlevel — Explanation of permissions granted via "God Mode"/Admin Status.


A good first point of contact is the #opensim-dev IRC channel. The OpenSimulator developers also hold office hours once a week in-world on Tuesdays at "Wright Plaza" on 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.

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

Recent Git Commits

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
fix AgentFOV gen (UbitUmarov) (Wed, 02 Jun 2021 06:29:52 -0700)
fix AgentFOV gen UbitUmarov <ajlduarte at sapo dot pt> .../Region/ClientStack/Linden/UDP/LLClientView.cs
lludp remove obsolete pending queue (UbitUmarov) (Wed, 02 Jun 2021 06:28:47 -0700)
lludp remove obsolete pending queue UbitUmarov <ajlduarte at sapo dot pt> OpenSim/Framework/AgentCircuitData.cs
cosmetics like change empty string compares (UbitUmarov) (Wed, 02 Jun 2021 03:07:56 -0700)
cosmetics like change empty string compares UbitUmarov <ajlduarte at sapo dot pt> .../RegionModulesControllerPlugin.cs

Personal tools
About This Wiki