Free and Open Source real time strategy game with a new take on micro-management

Difference between revisions of "Source Understanding Guide"

From Globulation2

Jump to: navigation, search
(https://bitbucket.org/giszmo/glob2 again)
 
(8 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Message|outdated content|most of the following referenced documents are outdated}}
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.
--[[User:Nct|Nct]] 03:49, 18 December 2005 (PST)


You can start understanding the code by:
You can start understanding the code by:
* To have an idea of the main loop : [http://savannah.nongnu.org/cgi-bin/viewcvs/*checkout*/glob2/glob2/doc/main%20engine%20loop.txt doc/main\ engine\ loop.txt]
* To have an idea of the main loop : [https://bitbucket.org/giszmo/glob2/src/8d2f3a39946a/doc/main%20engine%20loop.txt doc/main engine loop.txt]
* To have an overview of the glob2's '''class structure''', you can begin by reading the [http://savannah.nongnu.org/cgi-bin/viewcvs/*checkout*/glob2/glob2/doc/sourceCodeUnderstanding.txt?rev=HEAD&content-type=text/plain doc/sourceCodeUnderstanding.txt] file in glob2's CVS
* To have an overview of the glob2's '''class structure''', you can begin by reading the doc/sourceCodeUnderstanding.txt file in glob2's [[Mercurial]]
* To have an idea of '''unit allocation''' [http://savannah.nongnu.org/cgi-bin/viewcvs/*checkout*/glob2/glob2/doc/unitAllocationUnderstanding.txt?rev=1.1 doc/unitAllocationUnderstanding.txt]
* To have an idea of '''unit allocation''' doc/unitAllocationUnderstanding.txt
* To have a list of all '''capitals quick comments''' , read [http://savannah.nongnu.org/cgi-bin/viewcvs/*checkout*/glob2/glob2/doc/sourceCodeTagging.txt?rev=HEAD&content-type=text/plain doc/sourceCodeTagging.txt]
* To have a list of all '''capitals quick comments''' , read doc/sourceCodeTagging.txt
* To have an overview of the `BuildingType system, read [http://savannah.nongnu.org/cgi-bin/viewcvs/*checkout*/glob2/glob2/doc/BuildingType.txt?rev=HEAD&content-type=text/plain doc/BuildingType.txt]
* To have an overview of the `BuildingType system, read doc/BuildingType.txt
* For a listing of all the BuildingType INT's read [[BuildingSourceInts]]
* For a listing of all the BuildingType INT's read [[BuildingSourceInts]]
* To have an insight on how the actual YOG system works, and to understand the complexity of FW/NAT passing, read [http://savannah.nongnu.org/cgi-bin/viewcvs/*checkout*/glob2/glob2/doc/YogUnderstanding.txt?rev=HEAD&content-type=text/plain doc/YOGUnderstanding.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 [http://savannah.nongnu.org/cgi-bin/viewcvs/*checkout*/glob2/glob2/doc/unit.txt?rev=HEAD&content-type=text/plain doc/unit.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 [http://savannah.nongnu.org/cgi-bin/viewcvs/*checkout*/glob2/glob2/doc/wall.txt?rev=HEAD&content-type=text/plain doc/wall.txt]
* To understand how '''building with connecting capabilities (like walls) are ordered''', read doc/wall.txt
* The [http://lists.nongnu.org/archive/html/glob2-devel/2005-05/msg00042.html scripting language] thread on the mailing list threw up a few interesting points about SGSL. Noteably, [http://lists.nongnu.org/archive/html/glob2-devel/2005-05/msg00063.html these] [http://lists.nongnu.org/archive/html/glob2-devel/2005-05/msg00085.html two] posts by nct.
* The [http://lists.nongnu.org/archive/html/glob2-devel/2005-05/msg00042.html scripting language] thread on the mailing list threw up a few interesting points about SGSL. Noteably, [http://lists.nongnu.org/archive/html/glob2-devel/2005-05/msg00063.html these] [http://lists.nongnu.org/archive/html/glob2-devel/2005-05/msg00085.html two] posts by nct.
* [http://lists.gnu.org/archive/html/glob2-devel/2005-07/msg00014.html This thread] on the mailing list has some discussion of map-related functions.
* [http://lists.gnu.org/archive/html/glob2-devel/2005-07/msg00014.html This thread] on the mailing list has some discussion of map-related functions.


[[Category:en]]
Also [http://moneo.phear.org/~nct/html this] web page is generated directly from the [http://savannah.nongnu.org/cgi-bin/viewcvs/glob2/glob2/ CVS] using ''`DoxyGen'''. You can see some UML diagrams (collaboration diagram, class diagrams, etc...)

[[Category:Developer Resources]]
[[Category:Developer Resources]]

Latest revision as of 19:38, 4 October 2012

outdated content: most of the following referenced documents are outdated

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 Mercurial
  • 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
  • For a listing of all the BuildingType INT's read BuildingSourceInts
  • 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.
Misc