Developer Documentation
From OpenSimulator
(Difference between revisions)
m (Robot: Cosmetic changes) |
m (Robot: Replacing 'OpenSim' to 'OpenSimulator', which is the precise name) |
||
| 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 an [[opensim-libs git repository]] which contains the source code to some of the 3rd party libraries built and included in | + | 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 == | == Submitting Patches == | ||
| Line 24: | Line 24: | ||
==== General ==== | ==== General ==== | ||
| − | * [[Development Team]] — | + | * [[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]] | * [[Automated Release Building]] | ||
* [[On revisions, tags and branches]] | * [[On revisions, tags and branches]] | ||
| − | * [[Hacking | + | * [[Hacking OpenSimulator for fun and profit]] — A starters guide for programming OpenSimulator. |
* [[Coding standards]] — Coding conventions for developers. | * [[Coding standards]] — Coding conventions for developers. | ||
| − | * [[Automated Testing]] — How to write tests for | + | * [[Automated Testing]] — How to write tests for OpenSimulator. |
* [[Debugging Unit Tests]] — How to debug the automated tests. | * [[Debugging Unit Tests]] — How to debug the automated tests. | ||
* [[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. | ||
| − | * [[Creating New Solution]] — How to create new solution according to | + | * [[Creating New Solution]] — How to create new solution according to OpenSimulator conventions. |
* [[Performance]] — Information about performance in OpenSim, including studies on where the bottlenecks are. | * [[Performance]] — Information about performance in OpenSim, including studies on where the bottlenecks are. | ||
* [[Mono]] — The tips for implementing with Mono. | * [[Mono]] — The tips for implementing with Mono. | ||
| Line 44: | Line 44: | ||
==== Architecture ==== | ==== Architecture ==== | ||
| − | * [[OpenSim:Introduction_and_Definitions | OpenSim: Introduction and Definitions]] — A work in progress describing the high level components of | + | * [[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. | * [[:Category:Tech Reference|Technical Reference]] — A technical description of the simulator operation. | ||
* [[Grid Architecture Diagram]] | * [[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. | * [[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 | + | * [[Plugins]] — The types of plugins used in OpenSimulator. |
==== Client Stacks ==== | ==== Client Stacks ==== | ||
| − | * [[Sim Throttles]] — Information on how | + | * [[Sim Throttles]] — Information on how OpenSimulator handles throttling of packets to the client. |
==== Communication Protocols ==== | ==== Communication Protocols ==== | ||
| Line 57: | Line 57: | ||
==== Database ==== | ==== Database ==== | ||
| − | * [[Database Documentation]] — Information on the database schemas used in | + | * [[Database Documentation]] — Information on the database schemas used in OpenSimulator |
* [[MonoSqlite]] — How the database model currently works. | * [[MonoSqlite]] — How the database model currently works. | ||
| − | * [[LSL:PrimitiveParams]] — Notes on converting SL Edit GUI values and LSL PrimitiveParams to | + | * [[LSL:PrimitiveParams]] — Notes on converting SL Edit GUI values and LSL PrimitiveParams to OpenSimulator PrimitiveBaseShape fields |
==== File formats ==== | ==== File 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]] - | + | * [[Asset Formats]] - OpenSimulator asset formats. This includes serialized object formats. |
==== Grid ==== | ==== Grid ==== | ||
| Line 83: | Line 83: | ||
==== Modules ==== | ==== Modules ==== | ||
| − | * [[IRegionModule|Region module basics]] - The basics of how to create a region module, and where example code can be found in the | + | * [[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 90: | Line 90: | ||
==== Physics ==== | ==== Physics ==== | ||
| − | * [[PhysicsEngines]] — Options for physics engines in | + | * [[PhysicsEngines]] — Options for physics engines in OpenSimulator. |
* [[Physics Engine Interface]] — what methods and such exist in a Physics module | * [[Physics Engine Interface]] — what methods and such exist in a Physics module | ||
| Line 100: | Line 100: | ||
==== Scripting ==== | ==== Scripting ==== | ||
* [[Scripting Documentation]] — How to use scripts and what limitations apply. | * [[Scripting Documentation]] — How to use scripts and what limitations apply. | ||
| − | * [[LSL Status]] — A list of LSL-functions that are available in | + | * [[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. | * [[OpenSim.Region.ScriptEngine]] — How the ScriptEngine looks internally. | ||
| Line 112: | Line 112: | ||
==== Testing ==== | ==== Testing ==== | ||
| − | * [[Automated Testing]] - Writing Automated tests for | + | * [[Automated Testing]] - Writing Automated tests for OpenSimulator. |
* [[Debugging Unit Tests]] - Debugging unit tests. | * [[Debugging Unit Tests]] - Debugging unit tests. | ||
* [[Prim Linking Testing]] - Test cases for in world link/unlinking of prims. | * [[Prim Linking Testing]] - Test cases for in world link/unlinking of prims. | ||
| Line 128: | Line 128: | ||
== 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 [[Mailing Lists|development mailing list]] when development discussion takes place. | There is also a [[Mailing Lists|development mailing list]] when development discussion takes place. | ||
Revision as of 22:20, 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 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.
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 — OpenSimulator is brought to you by...
- Release Cycle — How to create an OpenSimulator release.
- Automated Release Building
- On revisions, tags and branches
- Hacking OpenSimulator for fun and profit — A starters guide for programming OpenSimulator.
- Coding standards — Coding conventions for developers.
- Automated Testing — How to write tests for OpenSimulator.
- 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 OpenSimulator 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 OpenSimulator
- 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 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.
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
File 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.
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 OpenSimulator 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 OpenSimulator.
- 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 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
Statistics
- Web Statistics Module - The web statistics module documentation and counter wish list.
Testing
- Automated Testing - Writing Automated tests for OpenSimulator.
- 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 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
- add flotsam comand fcache clearnegatives (UbitUmarov) (Mon, 23 Dec 2024 16:25:10 -0800)
- add flotsam comand fcache clearnegatives UbitUmarov <ajlduarte at sapo dot pt> .../Region/CoreModules/Asset/FlotsamAssetCache.cs
- 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
