Developer Documentation

From OpenSimulator

(Difference between revisions)
Jump to: navigation, search
(Users)
m (General: added descriptions to items that lacked it)
 
(46 intermediate revisions by 6 users not shown)
Line 13: Line 13:
 
You can also browse the source code for OpenSimulator [http://opensimulator.org/viewgit/?a=shortlog&p=opensim using a web browser].
 
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.
  
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.
+
[https://bitbucket.org/opensimulator/libopenmetaverse libOpenMetaverse] contains the source code of libOpenMetaverse for versions  >= 0.9.1.0
 +
 
 +
'''See Also:'''
 +
 
 +
[http://opensimulator.org/viewgit/?a=rss-log&p=opensim OpenSimulator git commits RSS feed]
 +
 
 +
[https://www.openhub.net/p/opensimulator OpenSimulator Project Metrics] can be found on the Synopsys Black Duck Open Hub website.
  
 
== Contributing ==
 
== Contributing ==
Line 31: Line 37:
  
 
==== General ====
 
==== General ====
 +
* [[Organization]] - Guidelines about core developers and how one becomes a member.
 
* [[Development Team]] — OpenSimulator is brought to you by...
 
* [[Development Team]] — OpenSimulator is brought to you by...
 
* [[Release Cycle]] — How to create an OpenSimulator release.
 
* [[Release Cycle]] — How to create an OpenSimulator release.
* [[Automated Release Building]]
+
* [[Branches]] — An overview of how we use repository branches.
* [[On revisions, tags and branches]]
+
* [[On revisions, tags and branches]] - How we use Git branches and tags
 +
* [[Automated Release Building]] - How releases are built
 
* [[Hacking OpenSim 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.
* [[Branches]] — An overview of the repository branches and what they are for.
+
* [http://www.metaverseink.com/blog/opensim/policies-for-patching-opensimulator/ Patch Policies] — Because coding standards don't tell the whole story.
 +
* [[Codebase overview]] - Very broad overview of the codebase.
 
* [[Monodevelop]] — How to use the [[monodevelop]] IDE for editing C# solutions.
 
* [[Monodevelop]] — How to use the [[monodevelop]] IDE for editing C# solutions.
 
* [[Debugging]] - Information about debugging OpenSimulator.
 
* [[Debugging]] - Information about debugging OpenSimulator.
 
* [[Performance]] — Information about performance in OpenSimulator, 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.
 
* [[Glossary]] - A glossary of terms used in OpenSimulator.
 +
* [[Research Papers]] - A list of research papers about OpenSimulator
  
 
==== Development ====
 
==== Development ====
 
* [http://opensimulator.org/mantis Mantis Bug Tracking] — Mantis is the issue tracking tool of OpenSimulator.
 
* [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.
 
* [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.
 
  
 
==== Testing ====
 
==== Testing ====
Line 61: Line 69:
 
* [[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.
 
* [[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.
  
 
==== Services ====
 
==== Services ====
Line 66: Line 75:
 
* [[Services]] - A description of the grid and simulator services used by OpenSimulator.
 
* [[Services]] - A description of the grid and simulator services used by OpenSimulator.
  
==== Client Stacks ====
+
==== Communication ====
* [[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.
 
+
* [[LLUDP Dissector]] - Lua code for a wireshark protocol dissector that can parse the message_template.msg file and use it to decode all the message fields from the LLUDP protocol
==== Communication Protocols ====
+
* [[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.
* [[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 81: Line 90:
 
* [[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 and appearance formats.
 
* [[Asset Formats]] - OpenSimulator asset formats. This includes serialized object formats and appearance formats.
 
==== Grid ====
 
* [[Teleports]] - some diagrams about normal grid teleport and hypergrid teleport sequences.
 
* [[Agent Domain / Service]] - Details about the GridForge hosted Agent Domain/Service code
 
  
 
==== Integration ====
 
==== Integration ====
Line 97: Line 102:
 
* [[Services]] - Contains general information on the default OpenSimulator services (asset, inventory, etc.) and more detailed information of HTTP interfaces for some services.
 
* [[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 ====
Line 119: Line 127:
 
* [[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
* [[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 ====
 
* [[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 ====
 +
* [[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.
 
* [[Web Statistics Module]] - The web statistics module documentation and counter wish list.
  
Line 133: Line 148:
 
==== Users ====
 
==== Users ====
 
* [[Appearance Troubleshooting]] - Also contains useful information about avatar behave and the relevant message exchanges between the viewer and the simulator.
 
* [[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.
  
== Communication ==
+
== Discussing Documentation ==
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.
 
+
 
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.
  
== Recent Git Commits ==
+
== More About the Dev Infrastructure ==
<rss>http://opensimulator.org/viewgit?a=rss-log&p=opensim|max=5|title=none</rss>
+
  
 +
See the [[Infrastructure]] page for more details on the software infrastructure that supports OpenSimulator development.
 +
 +
== Recent Git Commits ==
 +
<rss>http://opensimulator.org/viewgit?a=rss-log&p=opensim|max=8|title=none</rss>
 +
<!--
 
[[Category:Support]]
 
[[Category:Support]]
 
[[Category:Tech Reference]]
 
[[Category:Tech Reference]]
Line 149: Line 169:
 
[[Category:Getting Started]]
 
[[Category:Getting Started]]
 
[[Category:Development]]
 
[[Category:Development]]
 +
-->

Latest revision as of 09:24, 24 September 2020

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.

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

See Also:

OpenSimulator git commits RSS feed

OpenSimulator Project Metrics can be found on the Synopsys Black Duck Open Hub website.

[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.
  • LLUDP Dissector - Lua code for a wireshark protocol dissector that can parse the message_template.msg file and use it to decode all the message fields from the LLUDP 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] More About the Dev Infrastructure

See the Infrastructure page for more details on the software infrastructure that supports OpenSimulator development.

[edit] Recent Git Commits

typos... (UbitUmarov) (Sat, 26 Sep 2020 14:58:55 -0700)
typos... UbitUmarov <ajlduarte at sapo dot pt> bin/config-include/GridCommon.ini.example
region ini files: gatekeeper MUST be defined at Hypergrid section (or startup), not on per service entry (UbitUmarov) (Sat, 26 Sep 2020 06:33:08 -0700)
region ini files: gatekeeper MUST be defined at Hypergrid section (or startup), not on per service entry UbitUmarov <ajlduarte at sapo dot pt> bin/config-include/StandaloneCommon.ini.example
gridinfo and ossl (UbitUmarov) (Sat, 26 Sep 2020 06:25:36 -0700)
gridinfo and ossl UbitUmarov <ajlduarte at sapo dot pt> OpenSim/Framework/GridInfo.cs
try to fix lm about on large regions, again... (UbitUmarov) (Fri, 25 Sep 2020 16:10:55 -0700)
try to fix lm about on large regions, again... UbitUmarov <ajlduarte at sapo dot pt> .../CoreModules/World/Land/LandManagementModule.cs
encode parcel flag group Owned (UbitUmarov) (Fri, 25 Sep 2020 13:49:30 -0700)
encode parcel flag group Owned UbitUmarov <ajlduarte at sapo dot pt> .../Region/ClientStack/Linden/UDP/LLClientView.cs
delete tabs that keep getting in (UbitUmarov) (Fri, 25 Sep 2020 13:15:16 -0700)
delete tabs that keep getting in UbitUmarov <ajlduarte at sapo dot pt> bin/config-include/StandaloneCommon.ini.example
on regions config make HomeURIAlias visible (UbitUmarov) (Fri, 25 Sep 2020 13:13:56 -0700)
on regions config make HomeURIAlias visible UbitUmarov <ajlduarte at sapo dot pt> bin/config-include/GridCommon.ini.example
on regions define HomeURI only at [Hypergrid, stop having it all over, and worse overriding that, a region is only member of one grid at a time (UbitUmarov)] (Fri, 25 Sep 2020 12:59:44 -0700)
on regions define HomeURI only at [Hypergrid], stop having it all over, and worse overriding that, a region is only member of one grid at a time UbitUmarov <ajlduarte at sapo dot pt> bin/config-include/StandaloneCommon.ini.example


Personal tools
General
About This Wiki