Developer Documentation
From OpenSimulator
(Difference between revisions)
(→Communication) |
m (Robot: Cosmetic changes) |
||
| Line 17: | Line 17: | ||
This is also an [[opensim-libs git repository]] which contains the source code to some of the 3rd party libraries built and included in OpenSim. | This is also an [[opensim-libs git repository]] which contains the source code to some of the 3rd party libraries built and included in OpenSim. | ||
| − | ==Submitting Patches== | + | == Submitting Patches == |
Please review [[Submitting code to OpenSim]] | Please review [[Submitting code to OpenSim]] | ||
== 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]] — OpenSim 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 OpenSim. |
| − | * [[Coding standards]] | + | * [[Coding standards]] — Coding conventions for developers. |
| − | * [[Automated Testing]] | + | * [[Automated Testing]] — How to write tests for OpenSim. |
| − | * [[Debugging Unit Tests]] | + | * [[Debugging Unit Tests]] — How to debug the automated tests. |
| − | * [[Branches]] | + | * [[Branches]] — An overview of the repository branches and what they are for. |
| − | * [[Monodevelop]] | + | * [[Monodevelop]] — How to use the [[monodevelop]] IDE for editing C# solutions. |
| − | * [[Creating New Solution]] | + | * [[Creating New Solution]] — How to create new solution according to OpenSim conventions. |
| − | * [[Performance]] | + | * [[Performance]] — Information about performance in OpenSim, including studies on where the bottlenecks are. |
| − | * [[Mono]] | + | * [[Mono]] — The tips for implementing with Mono. |
==== Development Services ==== | ==== Development Services ==== | ||
| − | * [http://opensimulator.org/mantis Mantis Bug Tracking] | + | * [http://opensimulator.org/mantis Mantis Bug Tracking] — Mantis is the issue tracking tool of OpenSimulator. |
| − | * [http://panda.opensimulator.org/ Panda Building] | + | * [http://panda.opensimulator.org/ Panda Building] — Panda builds the source base continuously and runs unit tests. |
| − | * [http://forge.opensimulator.org/gf/ OpenSimulator GForge] | + | * [http://forge.opensimulator.org/gf/ OpenSimulator GForge] — Project hosting for OpenSimulator related projects. |
==== 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 OpenSim |
| − | * [[:Category:Tech Reference|Technical Reference]] | + | * [[:Category:Tech Reference|Technical Reference]] — A technical description of the simulator operation. |
* [[Grid Architecture Diagram]] | * [[Grid Architecture Diagram]] | ||
| − | * [[Connectors]] | + | * [[Connectors]] — A description of OpenSim's connector architecture, used for linking region code with services (asset, inventory, etc.) in both local (standalone) and distributed (grid) configurations. |
| − | * [[Plugins]] | + | * [[Plugins]] — The types of plugins used in OpenSim. |
==== Client Stacks ==== | ==== Client Stacks ==== | ||
| − | * [[Sim Throttles]] | + | * [[Sim Throttles]] — Information on how OpenSim handles throttling of packets to the client. |
==== Communication Protocols ==== | ==== Communication Protocols ==== | ||
| Line 57: | Line 57: | ||
==== Database ==== | ==== Database ==== | ||
| − | * [[Database Documentation]] | + | * [[Database Documentation]] — Information on the database schemas used in OpenSim |
| − | * [[MonoSqlite]] | + | * [[MonoSqlite]] — How the database model currently works. |
| − | * [[LSL:PrimitiveParams]] | + | * [[LSL:PrimitiveParams]] — Notes on converting SL Edit GUI values and LSL PrimitiveParams to OpenSim PrimitiveBaseShape fields |
==== File formats ==== | ==== File formats ==== | ||
* [[OpenSim Archives]] - Opensim Region Archive (OAR) file format. | * [[OpenSim Archives]] - Opensim Region Archive (OAR) file format. | ||
* [[Inventory Archives]] - OpenSim Inventory Archive (IAR) file format | * [[Inventory Archives]] - OpenSim Inventory Archive (IAR) file format | ||
| − | * [[Asset Formats]] - OpenSim asset formats. | + | * [[Asset Formats]] - OpenSim asset formats. This includes serialized object formats. |
==== Grid ==== | ==== Grid ==== | ||
| Line 80: | Line 80: | ||
==== Map ==== | ==== Map ==== | ||
| − | * [[Warp3DImageModule]] | + | * [[Warp3DImageModule]] — This is an improved map image module. |
==== Modules ==== | ==== Modules ==== | ||
| Line 86: | Line 86: | ||
==== 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 OpenSim. |
| − | * [[Physics Engine Interface]] | + | * [[Physics Engine Interface]] — what methods and such exist in a Physics module |
==== Regions ==== | ==== Regions ==== | ||
* [[Overview of How Regions Work]] - notes from ter_afk to rknop in #opensim-dev, cleaned up a bit | * [[Overview of How Regions Work]] - notes from ter_afk to rknop in #opensim-dev, cleaned up a bit | ||
| − | * [[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 OpenSim. |
| − | * [[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 ==== | ||
| Line 112: | Line 112: | ||
==== Testing ==== | ==== Testing ==== | ||
| − | * [[ | + | * [[Automated Testing]] - Writing Automated tests for OpenSim. |
* [[Debugging Unit Tests]] - Debugging unit tests. | * [[Debugging Unit Tests]] - Debugging unit tests. | ||
| − | * [[ | + | * [[Prim Linking Testing]] - Test cases for in world link/unlinking of prims. |
* [[pCampBot]] - A facility for stress-testing a simulator. | * [[pCampBot]] - A facility for stress-testing a simulator. | ||
==== Threading ==== | ==== Threading ==== | ||
| − | * [[OpenSim: Threading strategy]] | + | * [[OpenSim: Threading strategy]] — How threading is implemented and handled. |
==== Users ==== | ==== Users ==== | ||
| − | * [[Userlevel]] | + | * [[Userlevel]] — Explanation of permissions granted via "God Mode"/Admin Status. |
| − | ==Feature Proposals== | + | == Feature Proposals == |
Please see the [[Feature Proposals]] page. | Please see the [[Feature Proposals]] page. | ||
| − | ==Communication== | + | == Communication == |
A good first point of contact is the OpenSim IRC, on irc.freenode.net channels #opensim / #opensim-dev / #osgrid / #opensim-scripting. 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 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 OpenSim IRC, on irc.freenode.net channels #opensim / #opensim-dev / #osgrid / #opensim-scripting. 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 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 18:57, 3 March 2012
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 OpenSim 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 OpenSim.
Submitting Patches
Please review Submitting code to OpenSim
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 — OpenSim 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 OpenSim.
- Coding standards — Coding conventions for developers.
- Automated Testing — How to write tests for OpenSim.
- Debugging Unit Tests — How to debug the automated tests.
- Branches — An overview of the repository branches and what they are for.
- Monodevelop — How to use the monodevelop IDE for editing C# solutions.
- Creating New Solution — How to create new solution according to OpenSim conventions.
- Performance — Information about performance in OpenSim, including studies on where the bottlenecks are.
- Mono — The tips for implementing with Mono.
Development Services
- Mantis Bug Tracking — Mantis is the issue tracking tool of OpenSimulator.
- Panda Building — Panda builds the source base continuously and runs unit tests.
- OpenSimulator GForge — Project hosting for OpenSimulator related projects.
Architecture
- OpenSim: Introduction and Definitions — A work in progress describing the high level components of OpenSim
- Technical Reference — A technical description of the simulator operation.
- Grid Architecture Diagram
- Connectors — A description of OpenSim's connector architecture, used for linking region code with services (asset, inventory, etc.) in both local (standalone) and distributed (grid) configurations.
- Plugins — The types of plugins used in OpenSim.
Client Stacks
- Sim Throttles — Information on how OpenSim handles throttling of packets to the client.
Communication Protocols
- Communication Protocols - Introduction to the various communication protocols used by OpenSimulator.
Database
- Database Documentation — Information on the database schemas used in OpenSim
- MonoSqlite — How the database model currently works.
- LSL:PrimitiveParams — Notes on converting SL Edit GUI values and LSL PrimitiveParams to OpenSim PrimitiveBaseShape fields
File formats
- OpenSim Archives - Opensim Region Archive (OAR) file format.
- Inventory Archives - OpenSim Inventory Archive (IAR) file format
- Asset Formats - OpenSim asset formats. This includes serialized object formats.
Grid
- Asset Server problems - list of known problems with the asset server
- Teleports - some diagrams about OGP and Hypergrid teleport sequences
- Agent Domain / Service - Details about the GridForge hosted Agent Domain/Service code
Integration
- AuthIntegration - How to integrate external systems (such as web frontends) with OpenSimulator.
- RemoteAdmin - How to use the remote admin plug-in.
- RestConsole - Description how to use the REST remote console
- REST - Information about the REST interface to assets, inventory, etc.
- Webinterface - How to mashup with the web.
- Known Web Interfaces within OpenSim - The set of CAPS, XMLRPC, or REST entry points in the project.
Map
- Warp3DImageModule — This is an improved map image module.
Modules
- Region module basics - The basics of how to create a region module, and where example code can be found in the OpenSim source tree.
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 OpenSim.
- Physics Engine Interface — what methods and such exist in a Physics module
Regions
- Overview of How Regions Work - notes from ter_afk to rknop in #opensim-dev, cleaned up a bit
- 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 OpenSim.
- 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
Statistics
- Web Statistics Module - The web statistics module documentation and counter wish list.
Testing
- Automated Testing - Writing Automated tests for OpenSim.
- Debugging Unit Tests - Debugging unit tests.
- Prim Linking Testing - Test cases for in world link/unlinking of prims.
- pCampBot - A facility for stress-testing a simulator.
Threading
- OpenSim: Threading strategy — How threading is implemented and handled.
Users
- Userlevel — Explanation of permissions granted via "God Mode"/Admin Status.
Feature Proposals
Please see the Feature Proposals page.
Communication
A good first point of contact is the OpenSim IRC, on irc.freenode.net channels #opensim / #opensim-dev / #osgrid / #opensim-scripting. 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 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
- cosmetics (UbitUmarov) (Sun, 22 Dec 2024 15:29:34 -0800)
- cosmetics UbitUmarov <ajlduarte at sapo dot pt> OpenSim/ConsoleClient/ConsoleClient.cs
- fix typo (UbitUmarov) (Sat, 21 Dec 2024 17:22:48 -0800)
- fix typo UbitUmarov <ajlduarte at sapo dot pt> OpenSim/Data/SQLite/SQLiteSimulationData.cs
- get PID from Environment.ProcessId (UbitUmarov) (Sat, 30 Nov 2024 13:11:03 -0800)
- get PID from Environment.ProcessId UbitUmarov <ajlduarte at sapo dot pt> OpenSim/Framework/Servers/ServerBase.cs
- fix rez distance check (UbitUmarov) (Sat, 30 Nov 2024 11:52:29 -0800)
- fix rez distance check UbitUmarov <ajlduarte at sapo dot pt> .../Shared/Api/Implementation/LSL_Api.cs
- fix vel parameter on rez obj witrh params (UbitUmarov) (Sat, 30 Nov 2024 11:14:48 -0800)
- fix vel parameter on rez obj witrh params UbitUmarov <ajlduarte at sapo dot pt> .../Shared/Api/Implementation/LSL_Api.cs
