From OpenSim

Technical Reference -> Terms -> Developer Documentation

Contents 1 Source Code Repository Access 2 Submitting Patches 3 Developer Documentation 3.1 General 3.2 Development 3.3 Services 3.4 Client Stacks 3.5 Database 3.6 File formats 3.7 Grid 3.8 Web Integration 3.9 Modules 3.10 Permissions 3.11 Physics 3.12 Protocols 3.13 Regions 3.14 Threading 3.15 Scripting 3.16 Search 3.17 Testing 4 Proposals 4.1 Proposed projects 5 Communication 6 Recent Git Commits

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 OpenSim using a web browser.

Submitting Patches

Please review Submitting_code_to_OpenSim

Developer Documentation

Please be aware that some of this documentation may be out of date.

General

• Development Team — OpenSim is brought to you by...
• OpenSim: Introduction and Definitions — A work in progress describing the high level components of OpenSim
• OpenSim: Technical Reference — A technical description of the simulator operation.
• Grid Architecture Diagram
• The OpenSim API

Development

• Release Cycle — How to create an OpenSimulator release.
• Automated Release Building
• On revisions, tags and branches
• 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.
• 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 OpenSim conventions.
• Performance — Information about performance in OpenSim, including studies on where the bottlenecks are.

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.

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
• Database_Schema — Information on the database schemas 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

File formats

• Technical_Reference/OpenSim_Archive_Region_Format - Opensim Region Archive (OAR) file format.
• Inventory_Archives - OpenSim Inventory Archive (IAR) file format

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

Web Integration

• Webinterface — How to mashup with the web.
• 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.
• Known Web Interfaces within OpenSim — The set of CAPS, XMLRPC, or REST entry points in the project.

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.
• Physics Engine Interface — what methods and such exist in a Physics module

Protocols

• Metaverse Exchange Protocol — MXP is alternative protocol for secondlife protocol.

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.

Threading

• OpenSim: Threading strategy — How threading is implemented and handled.

Scripting

• Scripting_Documentation — How to use scripts and what limitations apply.
• 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
• Creating profiles not used for login - RFC for alternative ways of creating profiles that will never be used for login
• OpenSim_Services_and_Service_Connectors - new infrastructure for connecting region simulators to backend services
• OpenSim Profile Anchors - a mechanism for retaining creator information for offline item transfers
• Explicit Object Serialization - a proposal to explicitly serialize scene objects rather than using automatic .NET XML serialization

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 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 mailman email distribution list available at https://lists.berlios.de/mailman/listinfo/opensim-dev

Recent Git Commits

Fix cast issue (Melanie) (Wed, 01 Sep 2010 17:20:57 -0700)

Fix cast issue Melanie <melanie at t-data dot com> .../Services/InventoryService/XInventoryService.cs

Allow increasing the version in system folders (Melanie) (Wed, 01 Sep 2010 17:04:17 -0700)

Allow increasing the version in system folders Melanie <melanie at t-data dot com> .../Services/InventoryService/XInventoryService.cs

Update: Allow the version to increase only (Melanie) (Wed, 01 Sep 2010 17:02:07 -0700)

Update: Allow the version to increase only Melanie <melanie at t-data dot com> .../Services/InventoryService/XInventoryService.cs

Disallow modification of system folders. Prevent changing the type of folders (Melanie) (Wed, 01 Sep 2010 17:00:54 -0700)

Disallow modification of system folders. Prevent changing the type of folders and prevent resetting the version number Melanie <melanie at t-data dot com> .../Services/InventoryService/XInventoryService.cs

Fix sqlite migration problems by moving migrations in 019_RegionStore.sql and 020 into RegionStore.migrations (Justin Clark-Casey (justincc)) (Wed, 01 Sep 2010 15:06:56 -0700)

Fix sqlite migration problems by moving migrations in 019_RegionStore.sql and 020 into RegionStore.migrations This shows that panda is still not running the sqlite database tests since this change fixes the test failure in that area when "nant test" is executed locally Justin Clark-Casey (justincc) <jjustincc at googlemail dot com> OpenSim/Data/SQLite/Resources/019_RegionStore.sql