Transport Empire Developer Handbook
Posted: 21 Nov 2007 12:09
This document is permanently Under Construction.
Transport Empire Prtential Developer Handbook:
1. How to get the source
The Source is available at svn://svn.transportempire.com/trunk/transport_empire_4
Currently it contains only win32, VC10 project and dependancies.
2. How to get the dependancies
TEmpire uses several dependancies to build they include:
Boost - http://www.boost.org/
Ogre - http://www.ogre3d.org
Boost is a gargantuan set of libraries. We actually use only:
3. How to build
TEmpire should port easily to any operating system. Current build however relies on
a few windows specific functions (see timing.h).
Unfortuneatly you have to build yourself a makefile on any platform that is not win32
4. How to submit changes
To submit changes you have to contact our project maintainer - Steve:
http://www.tt-forums.net/memberlist.php ... ile&u=2023
While submitting make sure that the code you have submitted actually
compiles and runs well.
5. General coding tips
Note that TEmpire is a C++ code. This means that it is a template/class/std::
bonanza. Ie you should prefer:
std::string to char*,
std::vector<int> to int[],
cout << "stuff", to printf("stuff")
While nobody will kill you if you use those functions in your own
code - ie inside a class, however when dealing with class interfaces then:
__IT IS STRICTLY FORBIDDEN, UNLESS EXPLICITLY ALLOWED IN SPECIAL
CASES, TO USE C SPECIFIC SOLUTION WHEN C++ SOLUTUION IS AVAILABLE__
This is pretty much the only rule of the project :>
As for formatting your source file, the format is available in template.txt in the source.
6. Reserved for future use
Transport Empire Prtential Developer Handbook:
1. How to get the source
The Source is available at svn://svn.transportempire.com/trunk/transport_empire_4
Currently it contains only win32, VC10 project and dependancies.
2. How to get the dependancies
TEmpire uses several dependancies to build they include:
Boost - http://www.boost.org/
Ogre - http://www.ogre3d.org
Boost is a gargantuan set of libraries. We actually use only:
3. How to build
TEmpire should port easily to any operating system. Current build however relies on
a few windows specific functions (see timing.h).
Unfortuneatly you have to build yourself a makefile on any platform that is not win32
4. How to submit changes
To submit changes you have to contact our project maintainer - Steve:
http://www.tt-forums.net/memberlist.php ... ile&u=2023
While submitting make sure that the code you have submitted actually
compiles and runs well.
5. General coding tips
Note that TEmpire is a C++ code. This means that it is a template/class/std::
bonanza. Ie you should prefer:
std::string to char*,
std::vector<int> to int[],
cout << "stuff", to printf("stuff")
While nobody will kill you if you use those functions in your own
code - ie inside a class, however when dealing with class interfaces then:
__IT IS STRICTLY FORBIDDEN, UNLESS EXPLICITLY ALLOWED IN SPECIAL
CASES, TO USE C SPECIFIC SOLUTION WHEN C++ SOLUTUION IS AVAILABLE__
This is pretty much the only rule of the project :>
As for formatting your source file, the format is available in template.txt in the source.
6. Reserved for future use