Developer Documentation

2009-03-03T17:55:58Z

Mcortez: /* Communication */

{{Template:Quicklinks}}

== Developer Documentation ==

==== General ====
* [[OpenSim:Introduction_and_Definitions]] — A work in progress describing the high level components of OpenSim
* [[OpenSim: TechRef]] — A technical description of the simulator operation.
* [[Grid Architecture Diagram]]
* [[OpenSim: Screenshots]] — Various OpenSim screenshots.
* [http://docs.opensimulator.org/index.html The OpenSim API]

==== Development ====
* [[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.
* [[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.

==== Services ====

* [http://opensimulator.org/mantis Mantis Bug Tracking] — Mantis is the issue tracking tool of OpenSimulator.
* [http://www.opensimulator.org:8085/browse/OPENSIM-TRUNK Bamboo Continuous Integration] — Bamboo builds the source base continuously and runts unit tests.
* [http://forge.opensimulator.org/gf/ OpenSimulator GForge] — Project hosting for OpenSimulator related projects.

==== Client Stacks ====
* [[Sim Throttles]] — Information on how OpenSim handles throttling of packets to the client.

==== Database ====
* [[Database Documentation]] — A map of grid and region instances 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
* [[NHibernate Performance Testing]] — 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]] — How to mashup with the web.
* [[RemoteAdmin]] — How to use the remote admin plug-in.
* [[REST]] — Information about the REST interface to assets, inventory, etc.

==== Modules ====
* [[RegionModules]] — 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)]] — 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.

==== Protocols ====
* [[Metaverse Exchange Protocol]] — MXP is alternative protocol for secondlife protocol.

==== Regions ====
* [[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.

==== Threading ====
* [[OpenSim: Threading strategy]] — How threading is implemented and handled.

==== Scripting ====
* [[Scripting_Documentation]] — How to use scripts and what limitations apply.
* [[LSL_Status/Functions|LSL Implemented]] — 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

==== Testing ====
* [[Automated_Testing]] — Writing Automated tests for OpenSim.
* [[Debugging Unit Tests]] — Debugging unit tests.
* [[OpenSim: Debugging - profiler dumps]] — Dumps of OpenSim profiles to aid in tracking memory leaks.
* [[Prim_Linking_Testing]] — Test cases for in world link/unlinking of prims.

==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

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

There is also a mailman email distribution list available at https://lists.berlios.de/mailman/listinfo/opensim-dev

==Interest Groups==
* [[OpenSim Quality Focus Group]] - A proposed group for developers interested in improving the quality of OpenSim as we head towards beta status.

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

==Submitting Patches==

Please review [[Submitting_code_to_OpenSim]]

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

[[Category:Main]]
[[Category:Getting Started]]
[[Category:Development]]
<cleanpage title=hide cats=hide />

OpenSimulator - User contributions [en]

Developer Documentation