Difference between revisions of "Getting Started for Platform Developers"

From Sirikata Wiki
Jump to: navigation, search
Line 1: Line 1:
 
Platform developers work on the code which runs the core of Sirikata worlds. Both the core system and plugins implementing. Examples of code developed by platform developers are the core message forwarding code, physics simulation plugins, the renderer for clients, and scripting plugins.
 
Platform developers work on the code which runs the core of Sirikata worlds. Both the core system and plugins implementing. Examples of code developed by platform developers are the core message forwarding code, physics simulation plugins, the renderer for clients, and scripting plugins.
  
 +
=== Getting into the Code ===
 
* You'll need to [[GetTheCode|Check out]] and [[BuildTheCode|build]] the code before you can contribute any changes.
 
* You'll need to [[GetTheCode|Check out]] and [[BuildTheCode|build]] the code before you can contribute any changes.
 +
** The [[Source Code]] page helps you understand more about how we manage source code.
 +
** We're not too picky, but we suggest following the [[Coding Standards]] so we have a consistent, readable codebase.
 
* The [http://www.sirikata.com/docs/guides/platformguide/ Platform Developer's Guide] is the best reference for platform development.  It provides:
 
* The [http://www.sirikata.com/docs/guides/platformguide/ Platform Developer's Guide] is the best reference for platform development.  It provides:
 
** A high-level breakdown of the [http://www.sirikata.com/docs/guides/platformguide/components/ components of Sirikata's architecture], followed by more detail on each component.
 
** A high-level breakdown of the [http://www.sirikata.com/docs/guides/platformguide/components/ components of Sirikata's architecture], followed by more detail on each component.
Line 7: Line 10:
 
** [http://www.sirikata.com/docs/guides/platformguide/tutorials/ Tutorials] covering a few common tasks in the Sirikata code and describing how to use some utilities already available within the code base.
 
** [http://www.sirikata.com/docs/guides/platformguide/tutorials/ Tutorials] covering a few common tasks in the Sirikata code and describing how to use some utilities already available within the code base.
  
* [[Platform Developers|Platform Developers starting page]] is how you learn about Sirikata's architecture and getting involved in it's development.
 
* [[Platform Developer Communication]] describes how to get in touch with other platform developers, both synchronously and asynchronously.
 
 
* [[Documentation|Documentation]] is very much a work in progress but this is an overview what we currently have
 
* [[Documentation|Documentation]] is very much a work in progress but this is an overview what we currently have
 +
 +
=== Getting in Touch with Other Developers ===
 +
 +
* Need to talk to other platform developers to bounce implementation ideas off them or ask questions about the code?  [[Platform Developer Communication]] describes how to get in touch with other platform developers, both synchronously and asynchronously.
 +
 +
=== How and Where to Contribute ===
 +
 
* The [[Roadmap|roadmap]] gives a 10,000 foot view of developers current plans
 
* The [[Roadmap|roadmap]] gives a 10,000 foot view of developers current plans
* Looking for something to work on? Check out some [[CodingProjects|coding project]] ideas.
+
* Looking for something to work on? Learn [[Contributing|how you can contribute]] and check out some [[CodingProjects|coding project]] ideas.

Revision as of 07:57, 5 April 2011

Platform developers work on the code which runs the core of Sirikata worlds. Both the core system and plugins implementing. Examples of code developed by platform developers are the core message forwarding code, physics simulation plugins, the renderer for clients, and scripting plugins.

Getting into the Code

  • You'll need to Check out and build the code before you can contribute any changes.
    • The Source Code page helps you understand more about how we manage source code.
    • We're not too picky, but we suggest following the Coding Standards so we have a consistent, readable codebase.
  • The Platform Developer's Guide is the best reference for platform development. It provides:
    • A high-level breakdown of the components of Sirikata's architecture, followed by more detail on each component.
    • A tour of the source code should help you get into the code and figure out where you want to start working.
    • Tutorials covering a few common tasks in the Sirikata code and describing how to use some utilities already available within the code base.
  • Documentation is very much a work in progress but this is an overview what we currently have

Getting in Touch with Other Developers

  • Need to talk to other platform developers to bounce implementation ideas off them or ask questions about the code? Platform Developer Communication describes how to get in touch with other platform developers, both synchronously and asynchronously.

How and Where to Contribute