Developer Documentation
From OpenSimulator
(Difference between revisions)
(→Feature Proposals) |
|||
| (48 intermediate revisions by 4 users not shown) | |||
| Line 11: | Line 11: | ||
See [[Using Git]] for more Details on installing and using GIT with OpenSimulator.org | See [[Using Git]] for more Details on installing and using GIT with OpenSimulator.org | ||
| − | You can also browse the source code for | + | 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= | + | We have [http://www.ohloh.net/projects/4753?p=OpenSimulator Ohloh page], which takes various statistics of the OpenSimulator code base. |
| − | This is also | + | 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 == | ||
| − | Please be aware that some of this documentation may be out of date. | + | 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 ==== | ||
| − | * [[Development Team]] | + | * [[Development Team]] — OpenSimulator is brought to you by... |
| − | * [[Release Cycle]] | + | * [[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 OpenSim for fun and profit]] | + | * [[Hacking OpenSim for fun and profit]] — A starters guide for programming OpenSimulator. |
| − | * [[Coding standards]] | + | * [[Coding standards]] — Coding conventions for developers. |
| − | + | * [[Branches]] — An overview of the repository branches and what they are for. | |
| − | + | * [[Monodevelop]] — How to use the [[monodevelop]] IDE for editing C# solutions. | |
| − | * [[Branches]] | + | * [[Debugging]] - Information about debugging OpenSimulator. |
| − | * [[Monodevelop]] | + | * [[Performance]] — Information about performance in OpenSimulator, including studies on where the bottlenecks are. |
| − | * [[ | + | * [[Mono]] — The tips for implementing with Mono. |
| − | * [[Performance]] | + | * [[Glossary]] - A glossary of terms used in OpenSimulator. |
| − | * [[Mono]] | + | |
| − | ==== Development | + | ==== Development ==== |
| − | * [http://opensimulator.org/mantis Mantis Bug Tracking] | + | * [http://opensimulator.org/mantis Mantis Bug Tracking] — Mantis is the issue tracking tool of OpenSimulator. |
| − | * [http:// | + | * [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] | + | * [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 ==== | ||
| − | * [[OpenSim:Introduction_and_Definitions | OpenSim: Introduction and Definitions]] | + | * [[OpenSim:Introduction_and_Definitions | OpenSim: Introduction and Definitions]] — A work in progress describing the high level components of OpenSimulator |
| − | * [[:Category:Tech Reference|Technical Reference]] | + | * [[:Category:Tech Reference|Technical Reference]] — A technical description of the simulator operation. |
* [[Grid Architecture Diagram]] | * [[Grid Architecture Diagram]] | ||
| − | * [[Connectors]] | + | * [[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 ==== | ||
| + | * [[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 ==== | ==== Client Stacks ==== | ||
| − | * [[Sim Throttles]] | + | * [[Sim Throttles]] — Information on how OpenSimulator handles throttling of packets to the client. |
==== 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 ==== | ||
| − | * [[Database Documentation]] | + | * [[Database Documentation]] — Information on the database schemas used in OpenSimulator |
| − | * [[MonoSqlite]] | + | * [[MonoSqlite]] — How the database model currently works. |
| − | * [[LSL:PrimitiveParams]] | + | * [[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. | * [[OpenSim Archives]] - Opensim Region Archive (OAR) file format. | ||
| − | * [[Inventory Archives]] - | + | * [[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. | ||
==== Map ==== | ==== Map ==== | ||
| − | * [[Warp3DImageModule]] | + | * [[Map]] - Mapping overview |
| − | + | * [[Warp3DImageModule]] — This is an improved map image module. | |
| − | + | ||
| − | + | ||
==== Permissions ==== | ==== Permissions ==== | ||
| − | * [[Permissions (Server)]] | + | * [[Permissions (Server)]] — Permissions system as implemented on the region server. |
| − | * [[OpenSim: Permissions]] | + | * [[OpenSim: Permissions]] — Notes on how object permissions are handled on the client. |
==== Physics ==== | ==== Physics ==== | ||
| − | * [[PhysicsEngines]] | + | * [[PhysicsEngines]] — Options for physics engines in OpenSimulator. |
| − | * [[Physics Engine Interface]] | + | * [[Physics Engine Interface]] — what methods and such exist in a Physics module |
| − | ==== Regions ==== | + | ==== Regions/Scenes ==== |
| − | * [[Overview of How Regions Work]] | + | * [[Overview of How Regions Work]] |
| − | * [[OpenSim: Permissions]] | + | * [[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. | ||
==== Scripting ==== | ==== Scripting ==== | ||
| − | * [[ | + | * [[Scripting Documentation]] — How to use scripts and what limitations apply. |
| − | * [[ | + | * [[LSL Status]] — A list of LSL-functions that are available in OpenSimulator. |
| − | * [[OSSL]] | + | * [[OSSL]] — Some information about the OpenSimulator Scripting Language, and how to implement an OSSL function |
| − | * [[OpenSim.Region.ScriptEngine]] | + | * [[OpenSim.Region.ScriptEngine]] — How the ScriptEngine looks internally. |
==== 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 ==== | ||
* [[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 ==== | ||
| − | * [[ | + | * [[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. | ||
| + | * [[Userlevel]] — Explanation of permissions granted via "God Mode"/Admin Status. | ||
| − | ==Communication== | + | == Communication == |
| − | A good first point of contact is the | + | 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. |
| − | There is also a | + | 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=5|title=none</rss> | ||
[[Category:Support]] | [[Category:Support]] | ||
| − | [[Category:Tech Reference]] | + | [[Category:Tech Reference]] |
[[Category:Help]] | [[Category:Help]] | ||
[[Category:Configuration]] | [[Category:Configuration]] | ||
| − | [[Category: | + | [[Category:Getting Started]] |
[[Category:Development]] | [[Category:Development]] | ||
Revision as of 10:41, 22 May 2013
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 Team — OpenSimulator is brought to you by...
- Release Cycle — How to create an OpenSimulator release.
- Automated Release Building
- On revisions, tags and branches
- Hacking OpenSim for fun and profit — A starters guide for programming OpenSimulator.
- Coding standards — Coding conventions for developers.
- 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.
- Mono — The tips for implementing with Mono.
- Glossary - A glossary of terms used in OpenSimulator.
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.
- 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
- OpenSim: Introduction and Definitions — A work in progress describing the high level components of OpenSimulator
- Technical Reference — A technical description of the simulator operation.
- Grid Architecture Diagram
- Plugins — The types of plugins used in OpenSimulator.
- 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
- 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
- Sim Throttles — Information on how OpenSimulator handles throttling of packets to the client.
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.
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
- OpenSim.Region.ScriptEngine — How the ScriptEngine looks internally.
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).
Statistics
- 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.
- Userlevel — Explanation of permissions granted via "God Mode"/Admin Status.
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.
There is also a development mailing list when development discussion takes place.
Recent Git Commits
- Merge pull request #36 from Tampa/webrtc-fix (Ubit Umarov) (Sat, 06 Jun 2026 07:17:17 -0700)
- Merge pull request #36 from Tampa/webrtc-fix Fix response for vivox server type under webrtc Ubit Umarov <ajlduarte at gmail dot com> .../WebRtcVoiceRegionModule.cs
- Do not respond to vivox under webrtc (Vincent Sylvester) (Thu, 04 Jun 2026 13:44:37 -0700)
- Do not respond to vivox under webrtc Vincent Sylvester <vincentsylvester at zetamex dot com> .../WebRtcVoiceRegionModule.cs
- cosmetics (UbitUmarov) (Thu, 04 Jun 2026 03:36:33 -0700)
- cosmetics UbitUmarov <ajlduarte at sapo dot pt> .../UserManagement/HGUserManagementModule.cs
- Merge pull request #35 from AdilElFarissi/master (Ubit Umarov) (Thu, 04 Jun 2026 03:03:34 -0700)
- Merge pull request #35 from AdilElFarissi/master Bug fixes and cosmetics Ubit Umarov <ajlduarte at gmail dot com> .../UserManagement/HGUserManagementModule.cs
- Bug fix and cosmetics (Adil El Farissi) (Wed, 03 Jun 2026 17:41:25 -0700)
- Bug fix and cosmetics Fix: UserAgentServiceConnector return null if the destination is under TLS/SSL. Refractor: DataSnapshot to use http> UnSecureInstance as @UbitUmarov recommaded. Personally, i prefer it to be under HTTPS as well. Adil El Farissi <144741970+AdilElFarissi at users dot noreply dot github dot com> .../UserManagement/HGUserManagementModule.cs
