Developer Documentation

From OpenSimulator

(Difference between revisions)
Jump to: navigation, search
(File formats)
(Recent Git Commits)
 
(46 intermediate revisions by 6 users not shown)
Line 15: Line 15:
 
We have [http://www.ohloh.net/projects/4753?p=OpenSimulator Ohloh page], which takes various statistics of the OpenSimulator code base.
 
We have [http://www.ohloh.net/projects/4753?p=OpenSimulator 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.
+
 
 +
[[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 ==
 
== Contributing ==
Line 32: Line 35:
 
==== 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]]
Line 37: Line 41:
 
* [[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.
 +
* [[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.
 
* [[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.
 
* [[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.
  
Line 47: Line 52:
 
* [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 60: Line 64:
 
* [[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.
 +
* [[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 65: Line 71:
 
* [[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.
 
+
* [[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 ====
+
* [[Agent Domain / Service]] - Details about the GridForge hosted Agent Domain/Service code (legacy doc since this LL inspired work has long been abandoned).
* [[Communication Protocols]] - Introduction to the various communication protocols used by OpenSimulator.
+
  
 
==== Database ====
 
==== Database ====
Line 80: Line 85:
 
* [[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 96: Line 97:
 
* [[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 ====
 
* [[Map]] - Mapping overview
 
* [[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 121: Line 122:
 
* [[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.
  
 
==== 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.
  
== 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 ==
 
== Recent Git Commits ==
<rss>http://opensimulator.org/viewgit?a=rss-log&p=opensim|max=5|title=none</rss>
+
<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 150: Line 160:
 
[[Category:Getting Started]]
 
[[Category:Getting Started]]
 
[[Category:Development]]
 
[[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

fix saving appearence to notecard, so they can work on older regions (UbitUmarov) (Sun, 15 Sep 2019 08:49:58 -0700)
fix saving appearence to notecard, so they can work on older regions UbitUmarov <ajlduarte at sapo dot pt> OpenSim/Framework/AvatarAppearance.cs
allow particles scale max to be 7.96m, supported by protocol (UbitUmarov) (Wed, 11 Sep 2019 16:25:52 -0700)
allow particles scale max to be 7.96m, supported by protocol UbitUmarov <ajlduarte at sapo dot pt> .../Shared/Api/Implementation/LSL_Api.cs
fix bad indexes math (UbitUmarov) (Wed, 11 Sep 2019 07:52:26 -0700)
fix bad indexes math UbitUmarov <ajlduarte at sapo dot pt> OpenSim/Framework/AvatarAppearance.cs
fix a bad typo (UbitUmarov) (Wed, 11 Sep 2019 07:24:28 -0700)
fix a bad typo UbitUmarov <ajlduarte at sapo dot pt> OpenSim/Framework/AvatarAppearance.cs
take unit tests limited settings in consideration on setappearance (UbitUmarov) (Wed, 11 Sep 2019 07:08:09 -0700)
take unit tests limited settings in consideration on setappearance UbitUmarov <ajlduarte at sapo dot pt> .../Avatar/AvatarFactory/AvatarFactoryModule.cs
pesty warning (UbitUmarov) (Wed, 11 Sep 2019 06:09:55 -0700)
pesty warning UbitUmarov <ajlduarte at sapo dot pt> .../Avatar/AvatarFactory/AvatarFactoryModule.cs
remove a config option that controled a useless sim feature. note that at this point, and as normal on master, appearence/bakes etc may have a few more issues than before, as always thanks for your help testing it, and hapy clouds (UbitUmarov) (Wed, 11 Sep 2019 06:03:25 -0700)
remove a config option that controled a useless sim feature. note that at this point, and as normal on master, appearence/bakes etc may have a few more issues than before, as always thanks for your help testing it, and hapy clouds UbitUmarov <ajlduarte at sapo dot pt> .../Linden/Caps/SimulatorFeaturesModule.cs
enable agent hover again, (it is still bad on most viewers for opensim (UbitUmarov) (Wed, 11 Sep 2019 05:54:14 -0700)
enable agent hover again, (it is still bad on most viewers for opensim UbitUmarov <ajlduarte at sapo dot pt> .../Linden/Caps/AgentPreferencesModule.cs


Personal tools
General
About This Wiki