Developer Documentation

From OpenSimulator

(Difference between revisions)
Jump to: navigation, search
Line 28: Line 28:
* [[Automated Release Building]]
* [[Automated Release Building]]
* [[On revisions, tags and branches]]
* [[On revisions, tags and branches]]
* [[Hacking OpenSimulator for fun and profit]] — A starters guide for programming OpenSimulator.
* [[Hacking OpenSim for fun and profit]] — A starters guide for programming OpenSimulator.
* [[Coding standards]] — Coding conventions for developers.
* [[Coding standards]] — Coding conventions for developers.
* [[Automated Testing]] — How to write tests for OpenSimulator.
* [[Automated Testing]] — How to write tests for OpenSimulator.

Revision as of 15:33, 24 April 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 systems (such as web frontends) with OpenSimulator.
  • 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.
  • RestConsole - Description how to use the REST remote console
  • REST - Information about the REST interface to assets, inventory, etc.
  • Webinterface - How to mashup with the web.
  • 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

fix the dbs migrations (UbitUmarov) (Thu, 23 Jan 2020 03:14:12 -0800)
fix the dbs migrations UbitUmarov <ajlduarte at sapo dot pt> .../Data/PGSQL/Resources/RegionStore.migrations
store the new variables on sqlite and pgsql ( could not test) (UbitUmarov) (Thu, 23 Jan 2020 02:47:09 -0800)
store the new variables on sqlite and pgsql ( could not test) UbitUmarov <ajlduarte at sapo dot pt> OpenSim/Data/PGSQL/PGSQLSimulationData.cs
serialize the new variables (UbitUmarov) (Wed, 22 Jan 2020 14:01:05 -0800)
serialize the new variables UbitUmarov <ajlduarte at sapo dot pt> .../Scenes/Serialization/SceneObjectSerializer.cs
store the new variables on mysql (UbitUmarov) (Wed, 22 Jan 2020 13:32:40 -0800)
store the new variables on mysql UbitUmarov <ajlduarte at sapo dot pt> OpenSim/Data/MySQL/MySQLSimulationData.cs
fix bug on sit active range check (UbitUmarov) (Wed, 22 Jan 2020 13:19:38 -0800)
fix bug on sit active range check UbitUmarov <ajlduarte at sapo dot pt> OpenSim/Region/Framework/Scenes/ScenePresence.cs

Personal tools
About This Wiki