From OpenSim

Technical Reference -> Terms -> Developer Documentation

Contents 1 Developer Documentation 1.1 General 1.2 Development 1.3 Services 1.4 Client Stacks 1.5 Database 1.6 File formats 1.7 Grid 1.8 Web Integration 1.9 Modules 1.10 Permissions 1.11 Physics 1.12 Protocols 1.13 Regions 1.14 Threading 1.15 Scripting 1.16 Search 1.17 Testing 2 Proposals 2.1 Proposed projects 3 Communication 4 Interest Groups 5 Git Access 6 Submitting Patches 7 Recent Git Commits

Developer Documentation

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
• 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.
• Improving Performance — Efforts to increase OpenSim's performance.

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

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

Git Access

You can browse the source code for OpenSim using a web browser or via git.

• Anonymous Checkout - see Download
• Developer Checkout

git clone ssh://USERNAME@opensimulator.org/var/git/opensim

Submitting Patches

Please review Submitting_code_to_OpenSim

Recent Git Commits

Inconsistent locking of ScenePresence array in SceneGraph. Fixed by eliminating option to return the actual list. Callers can now either request a copy of the array as a new List or ask the SceneGraph to call a delegate function on every ScenePresence. Iteration and locking of the ScenePresences now takes place only within the SceneGraph class. (Dan Lake) (Tue, 16 Mar 2010 23:40:00 -0700)

Inconsistent locking of ScenePresence array in SceneGraph. Fixed by eliminating option to return the actual list. Callers can now either request a copy of the array as a new List or ask the SceneGraph to call a delegate function on every ScenePresence. Iteration and locking of the ScenePresences now takes place only within the SceneGraph class. This patch also applies a fix to Combat/CombatModule.cs which had unlocked iteration of the ScenePresences and inconsistent try/catch around the use of those ScenePresences. Dan Lake <dan dot lake at intel dot com> .../CoreModules/Avatar/Combat/CombatModule.cs

minor logging changes to BaseHttpServer, OSHttpRequest (Justin Clark-Casey (justincc)) (Tue, 16 Mar 2010 15:58:12 -0700)

minor logging changes to BaseHttpServer, OSHttpRequest Justin Clark-Casey (justincc) <jjustincc at googlemail dot com> .../Framework/Servers/HttpServer/BaseHttpServer.cs

Removed the unused use_async_when_possible config variable (John Hurliman) (Tue, 16 Mar 2010 05:03:04 -0700)

Removed the unused use_async_when_possible config variable John Hurliman <jhurliman at jhurliman dot org> OpenSim/Region/Application/OpenSim.cs

Fixed several unhandled exceptions and performance issues with PrimitiveBaseShape.Textures. This really should be moved from a property to a method if it is going to decode a byte[ into a TextureEntry each time (John Hurliman)] (Tue, 16 Mar 2010 04:50:22 -0700)

Fixed several unhandled exceptions and performance issues with PrimitiveBaseShape.Textures. This really should be moved from a property to a method if it is going to decode a byte[] into a TextureEntry each time John Hurliman <jhurliman at jhurliman dot org> OpenSim/Framework/PrimitiveBaseShape.cs

* Fixing the SimianGrid friend connector enabled detection since the friends module uses a different pattern in the .ini file (John Hurliman) (Tue, 16 Mar 2010 03:40:15 -0700)

* Fixing the SimianGrid friend connector enabled detection since the friends module uses a different pattern in the .ini file John Hurliman <jhurliman at jhurliman dot org> .../SimianGrid/SimianFriendsServiceConnector.cs