This is to create a tutorial game like chat noire. <[login to view URL]>
Important items:
1. Objective-C targetting the 2.2 SDK
2. Every function must have VERY detailed documentation.
3. A [login to view URL] indicating what is contained in what file.
4. Some sort of flow diagram indicating how the various components call each other.
The point of this game is tutorial -- documented code with frequent readable comments is the priority.
5. I'd like to do this in milestones -- A code drop every week. ? We'd negotiate the milestones and schedule before project start.
## Deliverables
The code comments are very important here, not the gameplay. ? I don't care if the game is fun -- but that it is a good teaching tool.
Functions would have to be documented something like this:
//-----------------------------------------------------------------
// function:
// ? this function loads [login to view URL] and draws it on screen
// Parameters
// ? Param1 -- The [login to view URL] file location
// ? Param2 -- The size of the cat.
// Returns:
// ? 0 -- no Error
// Exceptions:
// ? None
-(int) LoadCat ...
{
//Algorith
// Load the cat
// Catch any exceptions
...
// Step 1 -- load the cat.
// We use LoadFileEX to load the cat and render it
// Note -- ? the API throws an exception, so it must be in a try block.
}
}