Developer Documentation

Developer Documentation
You can view the current top 10 bugs blocking forward development.

General

 * OpenSim:Introduction_and_Definitions &mdash: A work in progress describing the high level components of OpenSim
 * OpenSim: TechRef &mdash; A technical description of the simulator operation.
 * Grid Architecture Diagram
 * OpenSim: Screenshots &mdash; Various OpenSim screenshots.
 * The OpenSim API

Development

 * Hacking OpenSim for fun and profit &mdash; A starters guide for programming OpenSim
 * Monodevelop &mdash; How to use the monodevelop IDE for editing C# solutions.
 * Automated_Testing &mdash; How to write tests for OpenSim.
 * Creating New Solution &mdash; How to create new solution according to OpenSim conventions.

Client Stacks

 * Sim Throttles &mdash; Information on how OpenSim handles throttling of packets to the client.

Database

 * Database Documentation &mdash; A map of grid and region instances used in OpenSim
 * MonoSqlite &mdash; How the database model currently works.
 * LSL:PrimitiveParams &mdash; Notes on converting SL Edit GUI values and LSL PrimitiveParams to OpenSim PrimitiveBaseShape fields
 * NHibernate Performance Testing &mdash; SQLite and MySQL performance tests with NHibernate.

File formats

 * OpenSim Region Archive Format - Opensim ARchive (OAR) region archive file format.

Grid

 * Asset Server problems - list of known problems with the asset server
 * Teleports - some diagrams about OGP and Hypergrid teleport sequences

Integration

 * Webinterface &mdash; How to mashup with the web.
 * RemoteAdmin &mdash; How to use the remote admin plug-in.
 * REST &mdash; Information about the REST interface to assets, inventory, etc.

Modules

 * RegionModules &mdash; The various modules that are used in the RegionServer and how to write new ones.
 * How to create a dynamic plugin - A tutorial for using PluginLoader
 * Getting Started with Region Modules - This brief tutorial is intended to get people started with developing applications with/for opensim using region modules and the opensim API.
 * Web Statistics Module - The web statistics module documentation and counter wish list.

Permissions

 * OpenSim:Permissions(Server)  &mdash; Permissions system as implemented on the region server.
 * OpenSim: Permissions &mdash; Notes on how object permissions are handled on the client.

Physics

 * PhysicsEngines  &mdash; Options for physics engines in OpenSim.

Regions

 * OpenSim: Permissions &mdash; Notes on object permissions & definition of the ObjectFlags variable.
 * OpenSim Load Balancing and Region Splitting - Instructions for using load balancing and region splitting features.

Threading

 * OpenSim: Threading strategy &mdash; How threading is implemented and handled.

Scripting

 * Scripting_Documentation &mdash; How to use scripts and what limitations apply.
 * LSL Implemented  &mdash; A list of LSL-functions that are available in OpenSim.
 * OSSL &mdash; Some information about the OpenSimulator Scripting Language, and how to implement an OSSL function
 * OpenSim.Region.ScriptEngine &mdash; 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

Testing

 * Automated_Testing &mdash; Writing Automated tests for OpenSim.
 * Debugging Unit Tests &mdash; Debugging unit tests.
 * OpenSim: Debugging - profiler dumps &mdash; Dumps of OpenSim profiles to aid in tracking memory leaks.

Proposals

 * Opensim: 0.5 Release Target Discussion
 * Opensim: 0.6 Release Target Discussion
 * Opensim: Future Release Discussion


 * A better SimCrossing - A work in progress about implementing a smooth simcrossing
 * OpenID - Proposal for using OpenID in OpenSim
 * AssetServerProposal - Proposal for a distributed asset server
 * MXP - Proposal for evaluation of Metaverse eXchange Protocol as alternative OpenSim protocol.

Proposed projects

 * OpenWiredux: Taking the next step
 * Using SNMP in OpenSim

Communication
A good first point of contact is the OpenSim IRC, on irc.freenode.net channels #opensim / #opensim-dev. 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. Check on the #opensim IRC channel on Freenode just before each of these events if there is any confusion.

SVN Access
You can browse the source code for OpenSim using a web browser or via SVN. svn co http://opensimulator.org/svn/opensim/trunk svn co svn+ssh://USERNAME@opensimulator.org/var/svn/opensim/trunk
 * Anonymous Checkout
 * Developer Checkout

Recent SVN Commits
http://cia.vc/stats/project/opensim/.rss|max=5|title=none

