Developer Documentation
From OpenSimulator
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 OpenSim using a web browser.
We have Ohloh page, which takes various statistics of the OpenSimulator code base.
This is also a opensim-libs SVN repository which contains the source code to some of the 3rd party libraries built and included in OpenSim.
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 Team — OpenSim is brought to you by...
- 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.
- Mono — The tips for implementing with Mono.
Development 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.
Architecture
- OpenSim: Introduction and Definitions — A work in progress describing the high level components of OpenSim
- Technical Reference — A technical description of the simulator operation.
- Grid Architecture Diagram
- Connectors — A description of OpenSim's connector architecture, used for linking region code with services (asset, inventory, etc.) in both local (standalone) and distributed (grid) configurations.
- Plugins — The types of plugins used in OpenSim.
Client Stacks
- Sim Throttles — Information on how OpenSim handles throttling of packets to the client.
Communication Protocols
- Communication Protocols - Introduction to the various communication protocols used by OpenSimulator.
Database
- Database Documentation — 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
- OpenSim Archives - 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
Map
- Warp3DImageModule — This is an improved map image module.
Modules
- Region module basics - The basics of how to create a region module, and where example code can be found in the OpenSim source tree.
Permissions
- 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
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.
Scripting
- Scripting_Documentation — How to use scripts and what limitations apply.
- LSL_Status — 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
Statistics
- Web Statistics Module - The web statistics module documentation and counter wish list.
Testing
- Automated_Testing — Writing Automated tests for OpenSim.
- Debugging Unit Tests — Debugging unit tests.
- Prim_Linking_Testing — Test cases for in world link/unlinking of prims.
Threading
- OpenSim: Threading strategy — How threading is implemented and handled.
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.
Feature 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 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
Communication
A good first point of contact is the OpenSim IRC, on irc.freenode.net channels #opensim / #opensim-dev / #osgrid / #opensim-scripting. 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
- add flotsam comand fcache clearnegatives (UbitUmarov) (Mon, 23 Dec 2024 16:25:10 -0800)
- add flotsam comand fcache clearnegatives UbitUmarov <ajlduarte at sapo dot pt> .../Region/CoreModules/Asset/FlotsamAssetCache.cs
- cosmetics (UbitUmarov) (Sun, 22 Dec 2024 15:29:34 -0800)
- cosmetics UbitUmarov <ajlduarte at sapo dot pt> OpenSim/ConsoleClient/ConsoleClient.cs
- fix typo (UbitUmarov) (Sat, 21 Dec 2024 17:22:48 -0800)
- fix typo UbitUmarov <ajlduarte at sapo dot pt> OpenSim/Data/SQLite/SQLiteSimulationData.cs
- get PID from Environment.ProcessId (UbitUmarov) (Sat, 30 Nov 2024 13:11:03 -0800)
- get PID from Environment.ProcessId UbitUmarov <ajlduarte at sapo dot pt> OpenSim/Framework/Servers/ServerBase.cs
- fix rez distance check (UbitUmarov) (Sat, 30 Nov 2024 11:52:29 -0800)
- fix rez distance check UbitUmarov <ajlduarte at sapo dot pt> .../Shared/Api/Implementation/LSL_Api.cs
