Developer Documentation

From OpenSimulator

Revision as of 06:24, 10 April 2019 by CodyCooper (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.

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 >=


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

Recent Git Commits

missed one (UbitUmarov) (Sat, 31 Oct 2020 06:10:00 -0700)
missed one UbitUmarov <ajlduarte at sapo dot pt> .../EntityTransfer/EntityTransferModule.cs
a few changed on avatar stand cases (UbitUmarov) (Sat, 31 Oct 2020 05:44:17 -0700)
a few changed on avatar stand cases UbitUmarov <ajlduarte at sapo dot pt> .../EntityTransfer/EntityTransferModule.cs
remove a forgotten warning about YEngine (UbitUmarov) (Fri, 30 Oct 2020 17:31:00 -0700)
remove a forgotten warning about YEngine UbitUmarov <ajlduarte at sapo dot pt> bin/OpenSim.ini.example
fix local grid assetservice on standalone.ini (UbitUmarov) (Fri, 30 Oct 2020 11:46:21 -0700)
fix local grid assetservice on standalone.ini UbitUmarov <ajlduarte at sapo dot pt> bin/config-include/Standalone.ini
flotsam: fix full cached file replacement, do default assets caching with replacement on startup (UbitUmarov) (Fri, 30 Oct 2020 09:25:07 -0700)
flotsam: fix full cached file replacement, do default assets caching with replacement on startup UbitUmarov <ajlduarte at sapo dot pt> .../Region/CoreModules/Asset/FlotsamAssetCache.cs
clean up opensim library scripts. This are suposed to be usefaul, or at least have some didactic use (UbitUmarov) (Fri, 30 Oct 2020 09:18:32 -0700)
clean up opensim library scripts. This are suposed to be usefaul, or at least have some didactic use UbitUmarov <ajlduarte at sapo dot pt> bin/assets/ScriptsAssetSet/DefaultSay.lsl
add some bento pose animations for future firestorm and others. Courtesy of Beq Janus and authors Miro Collas and Chaser Zaks (UbitUmarov) (Thu, 29 Oct 2020 19:45:12 -0700)
add some bento pose animations for future firestorm and others. Courtesy of Beq Janus and authors Miro Collas and Chaser Zaks UbitUmarov <ajlduarte at sapo dot pt> .../PS_Arms_Down_Legs_together_bento.anim
change asset fetch on uuidgatherer (UbitUmarov) (Thu, 29 Oct 2020 19:40:14 -0700)
change asset fetch on uuidgatherer UbitUmarov <ajlduarte at sapo dot pt> OpenSim/Region/Framework/Scenes/UuidGatherer.cs

Personal tools
About This Wiki