Developer Documentation

From OpenSimulator

(Difference between revisions)
Jump to: navigation, search
(General)
(Remove duplicate testing links. Move testing section up since it's an important general section.)
Line 30: Line 30:
 
* [[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.
* [[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.
 
* [[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.
Line 42: Line 40:
 
* [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.
 
* [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.
 +
* [[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.
  
 
==== Architecture ====
 
==== Architecture ====
Line 113: Line 118:
 
==== 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.
 
==== 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 ====
 
==== Threading ====

Revision as of 11:59, 2 May 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

Testing

Architecture

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

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

  • 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.
  • 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.
  • 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

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

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

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
fix some texts init (UbitUmarov) (Wed, 16 Oct 2019 12:09:31 -0700)
fix some texts init UbitUmarov <ajlduarte at sapo dot pt> .../Shared/Tests/LSL_ApiAvatarTests.cs
minor text change (UbitUmarov) (Wed, 16 Oct 2019 07:47:55 -0700)
minor text change UbitUmarov <ajlduarte at sapo dot pt> README.md
minor text change (UbitUmarov) (Wed, 16 Oct 2019 06:54:25 -0700)
minor text change UbitUmarov <ajlduarte at sapo dot pt> README.md
minor text change (UbitUmarov) (Wed, 16 Oct 2019 06:45:04 -0700)
minor text change UbitUmarov <ajlduarte at sapo dot pt> README.md

Personal tools
General
About This Wiki