Development Docs

From Armagetron
Revision as of 17:54, 20 June 2006 by Wrtlprnft (talk | contribs) (→‎Stuff in CVS HEAD: added the Cockpits list to have it linked from somewhere)

Sections: Installing the Game | Playing the Game | Competition Hub | Server Administration | Extending Armagetron Advanced | Development Docs


This is documentation for developers or for people who just want to hack on the code. It is not intended to replace the automatic API documentation generated by doxygen (we do have a doxyfile, right?), but is intended to supplement those documents with additional information that may not necessarily appear in the API docs. It is also not intended as a substitute for good commenting tactics. And finally, it is a place to put planning documentation (like the stuff Philippe writes), proposals, RFC-type material, and so forth. But not the roadmap, we use Sourceforge's tracker for that.

Set Up Your System

Stuff That's Current

Stuff in CVS HEAD

Data File Handling

Stuff That's Real but doesn't fit above

Wishlist, or Stuff that's planned

(Might not be planned, but this is it)

History

This is stuff that's of historical significance to the project. It's very difficult to remember where you're going if you don't remember where you came from, right? This is technical stuff. Community history should have its own section.


Sections: Installing the Game | Playing the Game | Competition Hub | Server Administration | Extending Armagetron Advanced | Development Docs