Difference between revisions of "Source Understanding Guide"

Right now only a copy pasted of old wiki, we have to improve this. Eventually this page will disappear as all documentation will be included in the doxygen autogenerated doc. --Nct 03:49, 18 December 2005 (PST)

You can start understanding the code by:

• To have an idea of the main loop : doc/main\ engine\ loop.txt
• To have an overview of the glob2's class structure, you can begin by reading the doc/sourceCodeUnderstanding.txt file in glob2's CVS
• To have an idea of unit allocation doc/unitAllocationUnderstanding.txt
• To have a list of all capitals quick comments , read doc/sourceCodeTagging.txt
• To have an overview of the `BuildingType system, read doc/BuildingType.txt
• To have an insight on how the actual YOG system works, and to understand the complexity of FW/NAT passing, read doc/YOGUnderstanding.txt
• To have a quick summary of the unit, read doc/unit.txt
• To understand how building with connecting capabilities (like walls) are ordered, read doc/wall.txt
• The scripting language thread on the mailing list threw up a few interesting points about SGSL. Noteably, these two posts by nct.
• This thread on the mailing list has some discussion of map-related functions.

Also this web page is generated directly from the CVS using `DoxyGen'. You can see some UML diagrams (collaboration diagram, class diagrams, etc...)