Developer Documentation

From OpenSimulator

(Difference between revisions)
Jump to: navigation, search
(Services)
(General)
(46 intermediate revisions by 2 users not shown)
Line 17: Line 17:
 
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.
 
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 ==
+
== Contributing ==
 +
 
 +
=== Submitting Patches ===
 
Please review [[Submitting code to OpenSim]]
 
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 ==
 
== Developer Documentation ==
Line 25: Line 32:
 
==== General ====
 
==== General ====
 
* [[Development Team]] — OpenSimulator is brought to you by...
 
* [[Development Team]] — OpenSimulator is brought to you by...
 +
* [[Organization]] - Guidelines and standards about core developers and how one becomes a member.
 
* [[Release Cycle]] — How to create an OpenSimulator release.
 
* [[Release Cycle]] — How to create an OpenSimulator release.
 
* [[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.
+
* [[Codebase overview]] - Very broad overview of the codebase.
* [[Debugging Unit Tests]] — How to debug the automated tests.
+
 
* [[Branches]] — An overview of the repository branches and what they are for.
 
* [[Branches]] — An overview of the repository branches and what they are for.
 
* [[Monodevelop]] — How to use the [[monodevelop]] IDE for editing C# solutions.
 
* [[Monodevelop]] — How to use the [[monodevelop]] IDE for editing C# solutions.
* [[Creating New Solution]] — How to create new solution according to OpenSimulator conventions.
+
* [[Debugging]] - Information about debugging OpenSimulator.
* [[Performance]] — Information about performance in OpenSim, including studies on where the bottlenecks are.
+
* [[Performance]] — Information about performance in OpenSimulator, including studies on where the bottlenecks are.
* [[Mono]] — The tips for implementing with Mono.
+
* [[Glossary]] - A glossary of terms used in OpenSimulator.
  
 
==== Development ====
 
==== Development ====
Line 42: Line 49:
 
* [http://jenkins.opensimulator.org/ Continuous Integration] — OpenSimulator's Jenkins installation builds the source base after each commit and runs the regression tests.
 
* [http://jenkins.opensimulator.org/ Continuous Integration] — OpenSimulator's Jenkins installation builds the source base after each commit and runs the regression tests.
 
* [http://forge.opensimulator.org/gf/ OpenSimulator GForge] — Project hosting for OpenSimulator related projects.
 
* [http://forge.opensimulator.org/gf/ OpenSimulator GForge] — Project hosting for OpenSimulator related projects.
 +
 +
==== Testing ====
 +
* [[Testing]] - General testing information.
 +
* [[Automated Testing]] - Writing Automated tests for OpenSimulator.
 +
* [[Prim Linking Testing]] - Test cases for in world link/unlinking of prims.
 +
* [[pCampBot]] - A facility for stress-testing a simulator.
  
 
==== Architecture ====
 
==== Architecture ====
Line 48: Line 61:
 
* [[Grid Architecture Diagram]]
 
* [[Grid Architecture Diagram]]
 
* [[Plugins]] — The types of plugins used in OpenSimulator.
 
* [[Plugins]] — The types of plugins used in OpenSimulator.
 +
* [[IRegionModule|Region module basics]] - The basics of how to create a region module, and where example code can be found in the OpenSimulator source tree.
  
 
==== Services ====
 
==== 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.
 
* [[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 services used by OpenSimulator.
+
* [[Services]] - A description of the grid and simulator services used by OpenSimulator.
  
 
==== Client Stacks ====
 
==== Client Stacks ====
* [[Sim Throttles]] Information on how OpenSimulator handles throttling of packets to the client.
+
* [[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 ====
 
==== Communication Protocols ====
* [[Communication Protocols]] - Introduction to the various communication protocols used by OpenSimulator.
+
* [[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 ====
 
==== Database ====
Line 64: Line 79:
 
* [[LSL:PrimitiveParams]] — Notes on converting SL Edit GUI values and LSL PrimitiveParams to OpenSimulator PrimitiveBaseShape fields
 
* [[LSL:PrimitiveParams]] — Notes on converting SL Edit GUI values and LSL PrimitiveParams to OpenSimulator PrimitiveBaseShape fields
  
==== File formats ====
+
==== 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.).
 +
 
 +
==== Formats ====
 
* [[OpenSim Archives]] - Opensim Region Archive (OAR) file format.
 
* [[OpenSim Archives]] - Opensim Region Archive (OAR) file format.
 
* [[Inventory Archives]] - OpenSimulator Inventory Archive (IAR) file format
 
* [[Inventory Archives]] - OpenSimulator Inventory Archive (IAR) file format
* [[Asset Formats]] - OpenSimulator asset formats. This includes serialized object formats.
+
* [[Asset Formats]] - OpenSimulator asset formats. This includes serialized object formats and appearance formats.
 
+
==== Grid ====
+
* [[Teleports]] - some diagrams about OGP and Hypergrid teleport sequences
+
* [[Agent Domain / Service]] - Details about the GridForge hosted Agent Domain/Service code
+
  
 
==== Integration ====
 
==== Integration ====
* [[AuthIntegration]] - How to integrate external systems (such as web frontends) with OpenSimulator.
+
* [[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).
 
* [[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.
 
* [[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  
 
* [[RestConsole]] - Description how to use the REST remote console  
 
* [[REST]] - Information about the REST interface to assets, inventory, etc.
 
* [[REST]] - Information about the REST interface to assets, inventory, etc.
* [[Webinterface]] - How to mashup with the web.
+
* [[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.
 
* [[Known Web Interfaces within OpenSim]] - The set of CAPS, XMLRPC, or REST entry points in the project.
 +
 +
==== Inventory ====
 +
* [[User Inventory Architecture]] - A general page that aims to detail the user inventory mechanisms in OpenSimulator.
  
 
==== Map ====
 
==== Map ====
 +
* [[Map]] - Mapping overview
 
* [[Warp3DImageModule]] — This is an improved map image module.
 
* [[Warp3DImageModule]] — This is an improved map image module.
 
==== Modules ====
 
* [[IRegionModule|Region module basics]] - The basics of how to create a region module, and where example code can be found in the OpenSimulator source tree.
 
  
 
==== Permissions ====
 
==== Permissions ====
Line 96: Line 116:
 
* [[Physics Engine Interface]] — what methods and such exist in a Physics module
 
* [[Physics Engine Interface]] — what methods and such exist in a Physics module
  
==== Regions ====
+
==== Regions/Scenes ====
* [[Overview of How Regions Work]] - notes from ter_afk to rknop in #opensim-dev, cleaned up a bit
+
* [[Overview of How Regions Work]]
 
* [[OpenSim: Permissions]] — Notes on object permissions & definition of the ObjectFlags variable.
 
* [[OpenSim: Permissions]] — Notes on object permissions & definition of the ObjectFlags variable.
 
* [[OpenSim Load Balancing and Region Splitting]] - Instructions for using load balancing and region splitting features.
 
* [[OpenSim Load Balancing and Region Splitting]] - Instructions for using load balancing and region splitting features.
Line 105: Line 125:
 
* [[LSL Status]] — A list of LSL-functions that are available in OpenSimulator.
 
* [[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]] — 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.
 
* [[OpenSim.Region.ScriptEngine]] — How the ScriptEngine looks internally.
 
* [[OpenSim.Region.ScriptEngine]] — How the ScriptEngine looks internally.
  
Line 110: Line 132:
 
* [[OpenSim.Region.DataSnapshot]] - Shiny new data gathering/search system
 
* [[OpenSim.Region.DataSnapshot]] - Shiny new data gathering/search system
 
* [[ImageService]] - Shiny new region module for serving search-related images
 
* [[ImageService]] - Shiny new region module for serving search-related images
 +
 +
==== Sound ====
 +
* [[Sound Protocol]] - Technical information about the sound protocols (e.g. UDP messages between viewer and server).
  
 
==== Statistics ====
 
==== Statistics ====
 
* [[Web Statistics Module]] - The web statistics module documentation and counter wish list.
 
* [[Web Statistics Module]] - The web statistics module documentation and counter wish list.
 
==== Testing ====
 
* [[Automated Testing]] - Writing Automated tests for OpenSimulator.
 
* [[Debugging Unit Tests]] - Debugging unit tests.
 
* [[Prim Linking Testing]] - Test cases for in world link/unlinking of prims.
 
* [[pCampBot]] - A facility for stress-testing a simulator.
 
  
 
==== Threading ====
 
==== Threading ====
* [[OpenSim: Threading strategy]] — How threading is implemented and handled.
+
* [[Threading]] — Information on the way that threads are used in OpenSimulator.
  
 
==== Users ====
 
==== 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.
 
* [[Userlevel]] — Explanation of permissions granted via "God Mode"/Admin Status.
 
== Feature Proposals ==
 
 
Please see the [[Feature Proposals]] page.
 
  
 
== Communication ==
 
== Communication ==
A good first point of contact is the OpenSimulator IRC, on irc.freenode.net 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.
+
A good first point of contact is the [[IRC|#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 [[Mailing Lists|development mailing list]] when development discussion takes place.
 
There is also a [[Mailing Lists|development mailing list]] when development discussion takes place.

Revision as of 16:53, 20 March 2014

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.

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.

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

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

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.
  • OpenSim.Region.ScriptEngine — How the ScriptEngine looks internally.

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.

Communication

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

use ILGenerator ILOffset instead of old mono il offset (UbitUmarov) (Wed, 27 Mar 2024 14:54:39 -0700)
use ILGenerator ILOffset instead of old mono il offset UbitUmarov <ajlduarte at sapo dot pt> .../ScriptEngine/YEngine/MMRScriptObjCode.cs
mantis 9121: fix failed lsl string casts on lsl list sort (UbitUmarov) (Wed, 27 Mar 2024 14:51:49 -0700)
mantis 9121: fix failed lsl string casts on lsl list sort UbitUmarov <ajlduarte at sapo dot pt> OpenSim/Region/ScriptEngine/Shared/LSL_Types.cs
clean appdomain related things (UbitUmarov) (Tue, 26 Mar 2024 14:34:33 -0700)
clean appdomain related things UbitUmarov <ajlduarte at sapo dot pt> .../Shared/Api/Implementation/LSL_Api.cs
and rename it again as just osGetLinkInventoryKey, so it is coerent with llGetInventoryKey (mantis 9119) (UbitUmarov) (Tue, 26 Mar 2024 11:32:05 -0700)
and rename it again as just osGetLinkInventoryKey, so it is coerent with llGetInventoryKey (mantis 9119) UbitUmarov <ajlduarte at sapo dot pt> .../Shared/Api/Implementation/OSSL_Api.cs
let runprebuild.bat also copy system drawing for windows (UbitUmarov) (Sun, 24 Mar 2024 05:11:42 -0700)
let runprebuild.bat also copy system drawing for windows UbitUmarov <ajlduarte at sapo dot pt> runprebuild.bat

Personal tools
General
About This Wiki