Platform Developers

From Sirikata Wiki
Revision as of 16:50, 24 June 2009 by Henrik Bennetsen (talk | contribs) (→‎Working with Sirikata: Split this large section into 4 smaller subsections to make the info less daunting)
Jump to navigation Jump to search

Platform Developers Starting Page

Sirikata Platform Developers

The core of Sirikata is a platform for building virtual world applications. This means that we don't produce any single virtual world and there is no resulting "product." Sirikata, at its core, is a set of interfaces and protocols for building virtual worlds. We also implement many of these interfaces, some with multiple variations to support the demands of different applications. If you're interested in building an application on top of Sirikata, for example a game, by writing scripts for objects and using Sirikata's infrastructure to handle things like user logins, content distribution, and rendering, then you are an Application Developer. Sirikata is in its early stages and not quite ready for applications to be built on top of it yet.

If you're interested in helping define these interface and protocols as well as building implementations of them, then you're in the right place. This page describes how the project is setup, how to get in touch with the developers, and how to start contributing.

Communication

Developers stay in touch via a number of mechanisms:

  • Mailing List: Developer List, Archives. Use for discussion about the platform architecture, protocols, and implementations. Patch sets can also be sent to this list for review and application if you do not have core commit access. We don't specifically separate mailing list traffic for application and platform developers since the overlap is significant and often useful, but we'd prefer to see general inquiries on the community mailing list or art related topics go to the artist mailing list.
  • IRC: #sirikata on irc.freenode.net (logs). Used for real time discussion with developers - quick questions, detailed questions about code, etc. (Wikipedia article on IRC)
  • Bugs: Nothing yet, send to the developer list for now.

Working with Sirikata

Because Sirikata is a large project, getting involved can be a bit daunting. This section's goal is to guide you through your first steps in getting involved:

  1. Architecture is a great place to learn about the Sirikata system
  2. Source Code helps you understand how to get and build the code
  3. Subsystems is a place to understand the directory layout of our repository
  4. How Can I Contribute? Learn about a number of ways to get involved

If you're not sure what you want to help out with yet, this process above should hopefully give you some ideas, and the coding projects projects page or a discussion on the developer list can help you pin down exactly what to work on.