Developer Documentation

From OpenSimulator

(Difference between revisions)
Jump to: navigation, search
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 OpenSim [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=OpenSim 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 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 OpenSimulator.
  
 
== Submitting Patches ==
 
== Submitting Patches ==
Line 24: Line 24:
  
 
==== General ====
 
==== General ====
* [[Development Team]] — OpenSim 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]]
 
* [[Automated Release Building]]
 
* [[On revisions, tags and branches]]
 
* [[On revisions, tags and branches]]
* [[Hacking OpenSim for fun and profit]] — A starters guide for programming OpenSim.
+
* [[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 OpenSim.
+
* [[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 OpenSim conventions.
+
* [[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
+
* [[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 OpenSim.
+
* [[Plugins]] — The types of plugins used in OpenSimulator.
  
 
==== Client Stacks ====
 
==== Client Stacks ====
* [[Sim Throttles]] — Information on how OpenSim handles throttling of packets to the client.
+
* [[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 OpenSim
+
* [[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 OpenSim PrimitiveBaseShape fields
+
* [[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]] - OpenSim Inventory Archive (IAR) file format
+
* [[Inventory Archives]] - OpenSimulator Inventory Archive (IAR) file format
* [[Asset Formats]] - OpenSim asset formats. This includes serialized object 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 OpenSim 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.
  
 
==== Permissions ====
 
==== Permissions ====
Line 90: Line 90:
  
 
==== Physics ====
 
==== Physics ====
* [[PhysicsEngines]] — Options for physics engines in OpenSim.
+
* [[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 OpenSim.
+
* [[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 OpenSim.
+
* [[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 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 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 23:20, 3 March 2012

Contents

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 Services

Architecture

Client Stacks

  • Sim Throttles — Information on how OpenSimulator handles throttling of packets to the client.

Communication Protocols

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

Grid

Integration

Map

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

Physics

Regions

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

Statistics

Testing

Threading

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 LSL_Integer osIsNotValidNumber(LSL_Float v) (UbitUmarov) (Thu, 17 Oct 2019 15:33:11 -0700)
add LSL_Integer osIsNotValidNumber(LSL_Float v) UbitUmarov <ajlduarte at sapo dot pt> .../Shared/Api/Implementation/OSSL_Api.cs
simplify last code a bit (UbitUmarov) (Thu, 17 Oct 2019 14:40:54 -0700)
simplify last code a bit UbitUmarov <ajlduarte at sapo dot pt> OpenSim/Region/ScriptEngine/Shared/LSL_Types.cs
Xengine: Error on division by Zero. Yengine will take a lot more work. If your script gets killed by this, don't bother us, your script is just BAD (UbitUmarov) (Thu, 17 Oct 2019 13:35:34 -0700)
Xengine: Error on division by Zero. Yengine will take a lot more work. If your script gets killed by this, don't bother us, your script is just BAD UbitUmarov <ajlduarte at sapo dot pt> OpenSim/Region/ScriptEngine/Shared/LSL_Types.cs
Yengine make float.tostring culture invariant (UbitUmarov) (Thu, 17 Oct 2019 11:40:54 -0700)
Yengine make float.tostring culture invariant UbitUmarov <ajlduarte at sapo dot pt> .../ScriptEngine/YEngine/MMRScriptTypeCast.cs
tests: windows does not have 1ms time resolution (UbitUmarov) (Wed, 16 Oct 2019 12:16:59 -0700)
tests: windows does not have 1ms time resolution UbitUmarov <ajlduarte at sapo dot pt> .../ScriptEngine/Shared/Tests/LSL_ApiUserTests.cs

Personal tools
General
About This Wiki