Stechec/Tow Bowl Tactics - Source Documentation

v3.1/r1129

Introduction

First, please take a look at the document Proposition d'architecture (still in french), it might give you a good oversight of the program, while this documentation will go more inside.

If you have some time and an average english level (better than mine, it's not difficult), please feel free to fix some basic mistakes.

Source Layout

Tow Bowl Tactics is based on Stechec which provides many handy tools and modules, such as logger, XML parser, data transfert, SDL wrapper, etc. Stechec is in fact pre-existent and not specific to TBT. It is now maintained and developed here in parallel to TBT. That's why the source code is splitted in stechec and bb5 directories.

Tow Bowl Tactics has been designed to be as modular as possible, therefore you will probably find easier to browse this documentation by Modules (mostly based on directories layout).

Notes

Implementing an user interface

For those who wants to implement an user interface to TBT (which could be a text-based UI, 2D GUI, 3D GUI, AI, ...), you should look closely to the Api class. It will provide you all game informations you may need, and enough methods to do any actions the game require (move player, end a turn, ...).

Stechec Toolbox

There are some tools already implemented, that you must be aware of, see Tools Library module.

Happy coding!

---