Developer Documentation

From OpenSim

Jump to: navigation, search

Contents

Source Code Repository Access

OpenSimulator uses git as its source code repository. Checkout

git clone git://opensimulator.org/git/opensim

See Source Code Repository for more details.

See Using Git for more Details on installing and using GIT with OpenSimulator.org

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.

Contributing

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.

General

Development

Testing

Architecture

Services

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

Communication

  • 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

  • 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

Formats

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

Integration

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

Inventory

Map

Permissions

Physics

Regions/Scenes

Scripting

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

Search

Sound

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

Statistics

Threading

  • Threading — Information on the way that threads are used in OpenSimulator.

Users

  • 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 at "Wright Plaza" on http://osgrid.org. 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

This fixes the Scene thread renaming issue (BlueWall) (Thu, 18 Sep 2014 00:25:27 +0000)
This fixes the Scene thread renaming issue BlueWall <jamesh at bluewallgroup dot com> OpenSim/Region/Framework/Scenes/Scene.cs
Undo "Revert "Small changes to threading to send thread names to unmanaged threads. Needs Mono 3.6+ to see thread names in utilities like top -H . Some formatting of the thread name to fin in the 16 byte limit on Linux. Please test on Windows to see if the work has any adverse effects."" (BlueWall) (Thu, 18 Sep 2014 00:03:54 +0000)
Undo "Revert "Small changes to threading to send thread names to unmanaged threads. Needs Mono 3.6+ to see thread names in utilities like top -H . Some formatting of the thread name to fin in the 16 byte limit on Linux. Please test on Windows to see if the work has any adverse effects."" Fix for break in next commit This reverts commit 376fab140227e92dbd841436509a97b87c9e7792. BlueWall <jamesh at bluewallgroup dot com> OpenSim/Framework/Monitoring/Watchdog.cs
Add eeyore to contributors (Justin Clark-Casey (justincc)) (Wed, 17 Sep 2014 22:45:53 +0000)
Add eeyore to contributors Justin Clark-Casey (justincc) <jjustincc at googlemail dot com> CONTRIBUTORS.txt
Changes to be committed: modified: OpenSim/Region/Framework/Scenes/Scene.PacketHandlers.cs modified: OpenSim/Region/ScriptEngine/Shared/Api/Implementation/LSL_Api.cs This solves mantis bug# 5005: llRegionSay script does not trigger ChatFromWorld event. This was solved by adding World.SimChat() command to the llRegionSay() function (per suggestion of DrCuriosity). Additionally this fixes llRegionSayTo() which was also not functioning by adding a World.SimChat() command and adding a new SimChatToAgent() overrided function to Scene.PacketHandlers.cs This is the second patch revision. Corrections made to the position of World.SimChat() and removal of tabs per suggestion by justincc. (Edward) (Mon, 15 Sep 2014 18:56:49 +0000)
Changes to be committed: modified: OpenSim/Region/Framework/Scenes/Scene.PacketHandlers.cs modified: OpenSim/Region/ScriptEngine/Shared/Api/Implementation/LSL_Api.cs This solves mantis bug# 5005: llRegionSay script does not trigger ChatFromWorld event. This was solved by adding World.SimChat() command to the llRegionSay() function (per suggestion of DrCuriosity). Additionally this fixes llRegionSayTo() which was also not functioning by adding a World.SimChat() command and adding a new SimChatToAgent() overrided function to Scene.PacketHandlers.cs This is the second patch revision. Corrections made to the position of World.SimChat() and removal of tabs per suggestion by justincc. Edward <eeyoreofborg at earthlink dot net> .../Framework/Scenes/Scene.PacketHandlers.cs
Revert "Small changes to threading to send thread names to unmanaged threads. Needs Mono 3.6+ to see thread names in utilities like top -H . Some formatting of the thread name to fin in the 16 byte limit on Linux. Please test on Windows to see if the work has any adverse effects." (BlueWall) (Wed, 17 Sep 2014 22:11:41 +0000)
Revert "Small changes to threading to send thread names to unmanaged threads. Needs Mono 3.6+ to see thread names in utilities like top -H . Some formatting of the thread name to fin in the 16 byte limit on Linux. Please test on Windows to see if the work has any adverse effects." This reverts commit af286d5fcb688e8b64202b6deca4f249e9a2b6b8. Issue with Jenkins builds BlueWall <jamesh at bluewallgroup dot com> OpenSim/Framework/Monitoring/Watchdog.cs

Personal tools
About This Wiki