Difference between revisions of "Development Docs"
m (→Wishlist, or Stuff that's planned: Link to Goals) |
m (Added wiki structuring project link) |
||
| Line 2: | Line 2: | ||
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. | 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. | ||
| + | |||
| + | == Documentation == | ||
| + | |||
| + | * [[Wiki Structuring Project]] | ||
== Set Up Your System == | == Set Up Your System == | ||
Revision as of 23:22, 27 August 2006
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.
Documentation
Set Up Your System
Stuff That's Current
Stuff in SVN HEAD
- Embedded Web Server
- Map/Config Rotation
- Particle System
- Joda's Team Code
- New Sound Engine
- Spawn points
- Zones v2
Data File Handling
- Config Files
- Resource System
- Statistical Collections Database (fancy way of saying "stat files")
Stuff That's Real but doesn't fit above
- Experimental Map Features
- Send DTD on the resource repository through ssh—only of interest for people on the development team
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
Information about the current Armagetron Advanced Development. How to compile the game or current working in progress.
