Developer Documentation

From OpenSimulator

Revision as of 08:12, 30 September 2020 by Steevithak (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
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.

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

libOpenMetaverse contains the source code of libOpenMetaverse for versions >=

See Also:

OpenSimulator git commits RSS feed

OpenSimulator Project Metrics can be found on the Synopsys Black Duck Open Hub website.


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.



  • Mantis Bug Tracking — Mantis is the issue tracking tool of OpenSimulator.
  • Continuous Integration — OpenSimulator's Jenkins installation builds the source base after each commit and runs the regression tests.




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


  • 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.
  • LLUDP Dissector - Lua code for a wireshark protocol dissector that can parse the message_template.msg file and use it to decode all the message fields from the LLUDP protocol
  • Communication Protocols - Introduction to the various communication protocols used by OpenSimulator. This includes viewer to OpenSimulator TCP and UDP protocols (e.g. login, agent update message exchange, asset fetch, etc.), inter-region protocols and grid service protocols. It also details methods by which arbitary UDP and TCP messages can be sent back and forth between clients/modified viewers and OpenSimulator region modules.
  • 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.


  • 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
  • OSSL Script Library/ModSendCommand - A mechanism for in-world scripts to use a generic modSendCommand() and the link_message event to communicate with region modules.
  • OSSL_Script_Library/ModInvoke - A mechanism for region modules to make new functions available to in-world scripts without patching the OpenSimulator runtime.
  • ScriptEngines — Information about script engines (chiefly XEngine).
  • Scripts Performance - Factors that affect script performance, and how to measure them



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


  • Stats Manager - Information about the main statistics monitor used in OpenSimulator and how to add/remove extra stats from modules.
  • Web Statistics Module - The web statistics module documentation and counter wish list.


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

Discussing Documentation

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. There is also a development mailing list when development discussion takes place.

More About the Dev Infrastructure

See the Infrastructure page for more details on the software infrastructure that supports OpenSimulator development.

Recent Git Commits

Fixed unit tests for Load OAR (Oren Hurvitz) (Thu, 18 Mar 2021 03:41:43 -0700)
Fixed unit tests for Load OAR Oren Hurvitz <orenh at kitely dot com> .../World/Archiver/ArchiveReadRequest.cs
Added textures to the OpenSim library: Default Moon, Default Water Normal (Oren Hurvitz) (Tue, 16 Mar 2021 06:15:40 -0700)
Added textures to the OpenSim library: Default Moon, Default Water Normal Oren Hurvitz <orenh at kitely dot com> bin/inventory/SettingsLibrary/Items.xml
Added "Default Water" item to the OpenSim library (Oren Hurvitz) (Tue, 16 Mar 2021 05:50:02 -0700)
Added "Default Water" item to the OpenSim library Oren Hurvitz <orenh at kitely dot com> bin/assets/SettingsAssetSet/DefaultWater.dat
Added cloud textures to the OpenSim Library (Oren Hurvitz) (Tue, 16 Mar 2021 04:45:54 -0700)
Added cloud textures to the OpenSim Library Oren Hurvitz <orenh at kitely dot com> bin/assets/SettingsAssetSet/SettingsAssetSet.xml
Renamed a couple of the Settings Library subfolders to "Skies" and "Days", to match the names used in Second Life (Oren Hurvitz) (Tue, 16 Mar 2021 03:42:48 -0700)
Renamed a couple of the Settings Library subfolders to "Skies" and "Days", to match the names used in Second Life Oren Hurvitz <orenh at kitely dot com> bin/inventory/SettingsLibrary/Folders.xml
Have the "Settings Library" folder use the same icon as the user's own "Settings" folder (Oren Hurvitz) (Tue, 16 Mar 2021 03:31:58 -0700)
Have the "Settings Library" folder use the same icon as the user's own "Settings" folder Oren Hurvitz <orenh at kitely dot com> bin/inventory/SettingsLibrary/Folders.xml
Renamed "Default Daycycle(3/1)" to "Default Daycycle (More Daylight)" (Oren Hurvitz) (Tue, 16 Mar 2021 02:01:49 -0700)
Renamed "Default Daycycle(3/1)" to "Default Daycycle (More Daylight)" This makes it easier for users to understand the difference between this asset and the asset called "Default Daycycle". Oren Hurvitz <orenh at kitely dot com> .../World/LightShare/EnvironmentModule.cs
When migrating Windlight region settings to EEP, store the EEP settings immediately. (Oren Hurvitz) (Tue, 16 Mar 2021 01:26:30 -0700)
When migrating Windlight region settings to EEP, store the EEP settings immediately. Previously the migration was done only in memory, but the settings in the database weren't modified. They would only get updated in the database the first time the user made any change to the EEP settings. Also, added better error logging: include the full stack trace. Oren Hurvitz <orenh at kitely dot com> .../World/LightShare/EnvironmentModule.cs

Personal tools
About This Wiki