Developer Documentation

From OpenSimulator

(Difference between revisions)
Jump to: navigation, search
m (Database)
(Recent Git Commits)
(200 intermediate revisions by 27 users not shown)
Line 1: Line 1:
{{Template:Quicklinks}}
+
{{Quicklinks}}
 +
 
 +
== 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 [http://opensimulator.org/viewgit/?a=shortlog&p=opensim using a web browser].
 +
 
 +
We have [http://www.ohloh.net/projects/4753?p=OpenSimulator 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.
 +
 
 +
[https://bitbucket.org/opensimulator/libopenmetaverse libOpenMetaverse] contains the source code of libOpenMetaverse for versions  >= 0.9.1.0
 +
 
 +
== 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 ==
 
== Developer Documentation ==
You can view the current [[Top 10 Bugs|top 10 bugs]] blocking forward development.
+
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 ====
 
==== General ====
* [[OpenSim:Introduction_and_Definitions]] &mdash: A work in progress describing the high level components of OpenSim
+
* [[Development Team]] — OpenSimulator is brought to you by...
* [[OpenSim: TechRef]] — A technical description of the simulator operation.
+
* [[Organization]] - Guidelines and standards about core developers and how one becomes a member.
* [[Grid Architecture Diagram]]
+
* [[Release Cycle]] — How to create an OpenSimulator release.
* [[OpenSim: Screenshots]] — Various OpenSim screenshots.
+
* [[Automated Release Building]]
* [http://docs.opensimulator.org/index.html The OpenSim API]
+
* [[On revisions, tags and branches]]
 +
* [[Hacking OpenSim for fun and profit]] A starters guide for programming OpenSimulator.
 +
* [[Coding standards]] — Coding conventions for developers.
 +
* [[Codebase overview]] - Very broad overview of the codebase.
 +
* [http://www.metaverseink.com/blog/opensim/policies-for-patching-opensimulator/ Policies for patching OpenSimulator] — Because coding standards don't tell the whole story.
 +
* [[Branches]] — An overview of the repository branches and what they are for.
 +
* [[Monodevelop]] — How to use the [[monodevelop]] IDE for editing C# solutions.
 +
* [[Debugging]] - Information about debugging OpenSimulator.
 +
* [[Performance]] — Information about performance in OpenSimulator, including studies on where the bottlenecks are.
 +
* [[Glossary]] - A glossary of terms used in OpenSimulator.
  
 
==== Development ====
 
==== Development ====
* [[Hacking OpenSim for fun and profit]] — A starters guide for programming OpenSim
+
* [http://opensimulator.org/mantis Mantis Bug Tracking] — Mantis is the issue tracking tool of OpenSimulator.
* [[Monodevelop]] — How to use the [[monodevelop]] IDE for editing C# solutions.
+
* [http://jenkins.opensimulator.org/ Continuous Integration] — OpenSimulator's Jenkins installation builds the source base after each commit and runs the regression tests.
* [[Automated_Testing]] — How to write tests for OpenSim.
+
* [[Creating New Solution]] — How to create new solution according to OpenSim conventions.
+
  
==== Client Stacks ====
+
==== Testing ====
* [[Sim Throttles]] — Information on how OpenSim handles throttling of packets to the client.
+
* [[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.
  
==== Database ====
+
==== Architecture ====
* [[Database Documentation]] — A map of grid and region instances used in OpenSim
+
* [[OpenSim:Introduction_and_Definitions | OpenSim: Introduction and Definitions]] A work in progress describing the high level components of OpenSimulator
* [[MonoSqlite]] — How the database model currently works.
+
* [[:Category:Tech Reference|Technical Reference]] — A technical description of the simulator operation.
* [[LSL:PrimitiveParams]] — Notes on converting SL Edit GUI values and LSL PrimitiveParams to OpenSim PrimitiveBaseShape fields
+
* [[Grid Architecture Diagram]]
* [[NHibernate Performance Testing]] — SQLite and MySQL performance tests with NHibernate.
+
* [[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.
 +
* [[Hypergrid Implementation]] - details on the internal implementation of the Hypergrid system in OpenSimulator.  For more general details also see the [[Hypergrid]] page.
  
==== File formats ====
+
==== Services ====
* [[OpenSim Region Archive Format]] - Opensim ARchive (OAR) region archive file format.
+
* [[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.
  
==== Grid ====
+
==== Communication ====
* [[Asset Server problems]] - list of known problems with the asset server
+
* [[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.
* [[Teleports]] - some diagrams about OGP and Hypergrid teleport sequences
+
* [[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 ====
 
==== Integration ====
* [[Webinterface]] — How to mashup with the web.
+
* [[AuthIntegration]] - How to integrate external authentication systems (such as web frontends) with OpenSimulator's authentication system.
* [[RemoteAdmin]] — How to use the remote admin plug-in.
+
* [[ClothingManipulation]] - How to set clothing on avatars using external ROBUST service calls.
* [[REST]] — Information about the REST interface to assets, inventory, etc.
+
* [[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.
  
==== Modules ====
+
==== Inventory ====
* [[RegionModules]] — The various modules that are used in the RegionServer and how to write new ones.
+
* [[User Inventory Architecture]] - A general page that aims to detail the user inventory mechanisms in OpenSimulator.
* [[How to create a dynamic plugin]] - A tutorial for using PluginLoader
+
 
* [[Getting Started with Region Modules]] - This brief tutorial is intended to get people started with developing applications with/for opensim using region modules and the opensim API.
+
==== Map ====
 +
* [[Map]] - Mapping overview
 +
* [[Warp3DImageModule]] This is an improved map image module.
  
 
==== Permissions ====
 
==== Permissions ====
* [[OpenSim:Permissions(Server)]]   — Permissions system as implemented on the region server.
+
* [[Permissions (Server)]] Permissions system as implemented on the region server.
* [[OpenSim: Permissions]] — Notes on how object permissions are handled on the client.
+
* [[OpenSim: Permissions]] Notes on how object permissions are handled on the client.
  
 
==== Physics ====
 
==== Physics ====
* [[PhysicsEngines]]   — Options for physics engines in OpenSim.
+
* [[PhysicsEngines]] Options for physics engines in OpenSimulator.
 +
* [[Physics Engine Interface]] — what methods and such exist in a Physics module
  
==== Regions ====
+
==== Regions/Scenes ====
* [[OpenSim: Permissions]] — Notes on object permissions & definition of the ObjectFlags variable.
+
* [[Overview of How Regions Work]]
 +
* [[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.
 
==== Threading ====
 
* [[OpenSim: Threading strategy]] — How threading is implemented and handled.
 
  
 
==== Scripting ====
 
==== Scripting ====
* [[Scripting_Documentation]] — How to use scripts and what limitations apply.
+
* [[Scripting Documentation]] How to use scripts and what limitations apply.
* [[LSL_Status/Functions|LSL Implemented]]   — A list of LSL-functions that are available in OpenSim.
+
* [[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
* [[OpenSim.Region.ScriptEngine]] — How the ScriptEngine looks internally.
+
* [[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
  
 
==== Search ====
 
==== Search ====
Line 67: Line 131:
 
* [[ImageService]] - Shiny new region module for serving search-related images
 
* [[ImageService]] - Shiny new region module for serving search-related images
  
==== Testing ====
+
==== Sound ====
* [[Automated_Testing]] — Writing Automated tests for OpenSim.
+
* [[Sound Protocol]] - Technical information about the sound protocols (e.g. UDP messages between viewer and server).
* [[OpenSim: Debugging - profiler dumps]] — Dumps of OpenSim profiles to aid in tracking memory leaks.
+
 
+
==Proposals==
+
  
* [[Opensim: 0.5 Release Target Discussion]]
+
==== Statistics ====
* [[Opensim: 0.6 Release Target Discussion]]
+
* [[Stats Manager]] - Information about the main statistics monitor used in OpenSimulator and how to add/remove extra stats from modules.
* [[Opensim: Future Release Discussion]]
+
* [[Web Statistics Module]] - The web statistics module documentation and counter wish list.
  
* [[A better SimCrossing]] - A work in progress about implementing a smooth simcrossing
+
==== Threading ====
* [[OpenID]] - Proposal for using OpenID in OpenSim
+
* [[Threading]] — Information on the way that threads are used in OpenSimulator.
* [[AssetServerProposal]] - Proposal for a distributed asset server
+
* [[SETPCICP|MXP]] - Proposal for evaluation of Metaverse eXchange Protocol as alternative OpenSim protocol.
+
 
+
==== Proposed projects ====
+
 
+
* [[OpenWiredux: Taking the next step]]
+
* [[Using SNMP in OpenSim]]
+
 
+
==Communication==
+
 
+
A good first point of contact is the OpenSim IRC, on irc.freenode.net channels #opensim / #opensim-dev. The OpenSim 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. Check on the #opensim IRC channel on Freenode just before each of these events if there is any confusion.
+
  
==SVN Access==
+
==== Users ====
You can browse the source code for OpenSim [http://opensimulator.org/cgi-bin/viewcvs.cgi using a web browser] or via SVN.
+
* [[Appearance Troubleshooting]] - Also contains useful information about avatar behave and the relevant message exchanges between the viewer and the simulator.
* Anonymous Checkout
+
* [[Attachment Protocols]] - Information on the attachment protocols used by viewers and OpenSimulator.
svn co http://opensimulator.org/svn/opensim/trunk
+
* [[Name Binding]] - Some information on how OpenSimulator (and Second Life) binds user UUIDs to names (e.g. 25bf6e60-91c0-4d28-8349-ba254cd4388e -> Jane Doe).
* Developer Checkout
+
* [[Userlevel]] — Explanation of permissions granted via "God Mode"/Admin Status.
svn co svn+ssh://USERNAME@opensimulator.org/var/svn/opensim/trunk
+
  
==Recent SVN Commits==
+
== Discussing Documentation ==
<rss>http://cia.vc/stats/project/opensim/.rss|max=5|title=none</rss>
+
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.
 +
There is also a [[Mailing Lists|development mailing list]] when development discussion takes place.
  
[[Category:Main]]
+
== Recent Git Commits ==
 +
<rss>http://opensimulator.org/viewgit?a=rss-log&p=opensim|max=8|title=none</rss>
 +
<!--
 +
[[Category:Support]]
 +
[[Category:Tech Reference]]
 +
[[Category:Help]]
 +
[[Category:Configuration]]
 
[[Category:Getting Started]]
 
[[Category:Getting Started]]
 
[[Category:Development]]
 
[[Category:Development]]
<cleanpage title=hide cats=hide />
+
-->

Revision as of 06:24, 10 April 2019

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.


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

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

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

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).
  • Scripts Performance - Factors that affect script performance, and how to measure them

Search

Sound

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

Statistics

  • 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

  • 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. 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
rename new osGetLinkInventoryItemKey as osGetLinkInventoryItemAssetKey (UbitUmarov) (Sun, 24 Mar 2024 04:34:23 -0700)
rename new osGetLinkInventoryItemKey as osGetLinkInventoryItemAssetKey UbitUmarov <ajlduarte at sapo dot pt> .../Shared/Api/Implementation/OSSL_Api.cs
osGetLinkInventoryAssetKey (Jeff Kelley) (Sat, 23 Mar 2024 12:20:13 -0700)
osGetLinkInventoryAssetKey deleted: bin/System.Drawing.Common.dll Signed-off-by: UbitUmarov <ajlduarte@sapo.pt> Jeff Kelley <opensim at pescadoo dot net> .../Shared/Api/Implementation/OSSL_Api.cs
revert to append all contents of .version file on the full version, if present and not empty (UbitUmarov) (Sun, 10 Mar 2024 17:18:05 -0700)
revert to append all contents of .version file on the full version, if present and not empty UbitUmarov <ajlduarte at sapo dot pt> OpenSim/Framework/Servers/ServerBase.cs


Personal tools
General
About This Wiki