Developer Documentation

From OpenSimulator

(Difference between revisions)
Jump to: navigation, search
(Recent Git Commits)
 
(268 intermediate revisions by 41 users not shown)
Line 1: Line 1:
== Communication ==
+
{{Quicklinks}}
  
A good first point of contact is the OpenSim IRC, on irc.freenode.net channel #opensim/#opensim-dev.
+
== Source Code Repository Access ==
  
The OpenSim developers hold [[office hours]] once a week in-world on Tuesdays at "Wright Plaza" on OSGrid.  
+
OpenSimulator uses git as its source code repository. Checkout
  
There is a "Test Hour" on Saturdays, also generally on "Wright Plaza". Both these weekly events are held at 11:00AM PST or 1900UTC.
+
git clone git://opensimulator.org/git/opensim
  
Check on the #opensim IRC channel on Freenode just before each of these events if there is any confusion.
+
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]].
  
* [[OpenSim: Testing]] — What is tested.
+
==== General ====
* [[OpenSim: TechRef]] — A technical description of the simulator operation.
+
* [[Development Team]] — OpenSimulator is brought to you by...
* [[OpenSim: Grids]] — Known Public grids currently available.
+
* [[Organization]] - Guidelines and standards about core developers and how one becomes a member.
* [[Opensim: 0.4 Release Target Discussion]]
+
* [[Release Cycle]] — How to create an OpenSimulator release.
* [[Opensim: 0.5 Release Target Discussion]]
+
* [[Automated Release Building]]
* [[OpenSim: Class Diagrams]]
+
* [[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 ====
 +
* [http://opensimulator.org/mantis Mantis Bug Tracking] — Mantis is the issue tracking tool of OpenSimulator.
 +
* [http://jenkins.opensimulator.org/ Continuous Integration] — OpenSimulator's Jenkins installation builds the source base after each commit and runs the regression tests.
 +
 
 +
==== 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 ====
 +
* [[OpenSim:Introduction_and_Definitions | OpenSim: Introduction and Definitions]] — A work in progress describing the high level components of OpenSimulator
 +
* [[:Category:Tech Reference|Technical Reference]] — A technical description of the simulator operation.
 
* [[Grid Architecture Diagram]]
 
* [[Grid Architecture Diagram]]
* [[OpenSim: Scripting]] — How to use scripts and what limitations apply.
+
* [[Plugins]] — The types of plugins used in OpenSimulator.
* [[OpenSim: Prim Inventory Persistence]] — Information on the current state of prim inventory persistence.
+
* [[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.
* [[PhysicsEngines]]   — Options for physics engines in OpenSim.
+
* [[Hypergrid Implementation]] - details on the internal implementation of the Hypergrid system in OpenSimulator.  For more general details also see the [[Hypergrid]] page.
* [[MonoSqlite]] — How the database model currently works.
+
 
* [[Monodevelop]] — How to use the [[monodevelop]] IDE for editing C# solutions.
+
==== Services ====
* [[LSL Status]] — LSL implementation progress.
+
* [[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.
* [[LSL:PrimitiveParams]] Notes on converting SL Edit GUI values and LSL PrimitiveParams to OpenSim PrimitiveBaseShape fields
+
* [[Services]] - A description of the grid and simulator services used by OpenSimulator.
* [[OpenSim.Region.ScriptEngine]] — How the ScriptEngine looks internally.
+
 
* [[RegionModules]] — The various modules that are used in the RegionServer and how to write new ones.
+
==== Communication ====
* [[OpenSim: Screenshots]] — Various OpenSim screenshots.
+
* [[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.
* [[OpenSim: Threading strategy]] — How threading is implemented and handled.
+
* [[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.
* [[Special Building]] — Special building instructions.
+
* [[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 ====
 +
* [[User Inventory Architecture]] - A general page that aims to detail the user inventory mechanisms in OpenSimulator.
 +
 
 +
==== Map ====
 +
* [[Map]] - Mapping overview
 +
* [[Warp3DImageModule]] — This is an improved map image module.
 +
 
 +
==== Permissions ====
 +
* [[Permissions (Server)]] — Permissions system as implemented on the region server.
 +
* [[OpenSim: Permissions]] — Notes on how object permissions are handled on the client.
 +
 
 +
==== Physics ====
 +
* [[PhysicsEngines]] — Options for physics engines in OpenSimulator.
 +
* [[Physics Engine Interface]] — what methods and such exist in a Physics module
 +
 
 +
==== Regions/Scenes ====
 +
* [[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.
 +
 
 +
==== 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 ====
 +
* [[OpenSim.Region.DataSnapshot]] - Shiny new data gathering/search system
 +
* [[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).
  
== SVN Access ==
+
==== Statistics ====
You can browse the source code for OpenSim [http://opensimulator.org/cgi-bin/viewcvs.cgi using a web browser] or via SVN.
+
* [[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.
  
=== Anonymous Checkout ===
+
==== Threading ====
svn co http://opensimulator.org/svn/opensim/trunk
+
* [[Threading]] — Information on the way that threads are used in OpenSimulator.
  
=== Developer Checkout ===
+
==== Users ====
svn co svn+ssh://USERNAME@opensimulator.org/var/svn/opensim/trunk
+
* [[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.
  
== 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:Development]]
 +
-->

Latest revision as of 06:24, 10 April 2019

Contents

[edit] 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

[edit] Contributing

[edit] Submitting Patches

Please review Submitting code to OpenSim

[edit] 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.

[edit] 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.

[edit] General

[edit] 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.

[edit] Testing

[edit] Architecture

[edit] 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.

[edit] 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).

[edit] 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

[edit] 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.

[edit] 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.

[edit] Inventory

[edit] Map

[edit] Permissions

[edit] Physics

[edit] Regions/Scenes

[edit] 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

[edit] Search

[edit] Sound

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

[edit] 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.

[edit] Threading

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

[edit] 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.

[edit] 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.

[edit] Recent Git Commits

viewers group search page size is 100 ( and not way to detect other value, so hardwired) (UbitUmarov) (Sun, 13 Oct 2019 11:11:21 -0700)
viewers group search page size is 100 ( and not way to detect other value, so hardwired) UbitUmarov <ajlduarte at sapo dot pt> .../Framework/Search/BasicSearchModule.cs
groups v2: remove wrong filters on DB search (UbitUmarov) (Sun, 13 Oct 2019 10:52:33 -0700)
groups v2: remove wrong filters on DB search UbitUmarov <ajlduarte at sapo dot pt> OpenSim/Data/MySQL/MySQLGroupsData.cs
mantis 8598: filter dead groups from group search. honor querystart request. Viewers are very broken on this, seems protocol was made by someone with no idea about lludp (UbitUmarov) (Sun, 13 Oct 2019 08:41:38 -0700)
mantis 8598: filter dead groups from group search. honor querystart request. Viewers are very broken on this, seems protocol was made by someone with no idea about lludp UbitUmarov <ajlduarte at sapo dot pt> OpenSim/Addons/Groups/Service/GroupsService.cs
add osResetAllScripts(LSL_Integer AllLinkset). use with care (UbitUmarov) (Thu, 10 Oct 2019 16:01:59 -0700)
add osResetAllScripts(LSL_Integer AllLinkset). use with care UbitUmarov <ajlduarte at sapo dot pt> .../Shared/Api/Implementation/OSSL_Api.cs
update livomv (UbitUmarov) (Mon, 07 Oct 2019 22:31:39 -0700)
update livomv UbitUmarov <ajlduarte at sapo dot pt> bin/OpenMetaverse.Rendering.Meshmerizer.dll
Fix build break (Melanie) (Sun, 06 Oct 2019 15:57:47 -0700)
Fix build break Melanie <melanie at opensimulator dot org> .../Services/HypergridService/GatekeeperService.cs
Introduce a way to send the grid's message kay, if one is used (Melanie) (Sun, 06 Oct 2019 15:24:41 -0700)
Introduce a way to send the grid's message kay, if one is used Melanie <melanie at opensimulator dot org> .../InstantMessageServiceConnector.cs
Remove a no longer used property that used ScopeID in an improper way (Melanie) (Sun, 06 Oct 2019 11:51:46 -0700)
Remove a no longer used property that used ScopeID in an improper way Melanie <melanie at opensimulator dot org> OpenSim/Services/GridService/HypergridLinker.cs


Personal tools
General
About This Wiki