Colobot
Colobot Documentation

Doxygen documentation of Colobot: Gold Edition project.

Colobot (COLOnize with BOTs) is a game combining elements of real time strategy (RTS) and educational game, aiming to teach programming through entertainment. You are playing as an astronaut on a journey with robot helpers to find a planet for colonization. It features a C++ and Java-like, object-oriented language, CBOT, which can be used to program the robots available in the game.

The original version of the game was developed by Epsitec and released in 2001. Later, in 2005 another version named Ceebot was released. In March 2012, through attempts by Polish Colobot fans, Epsitec agreeed to release the source code of the game on GPLv3 license. The license was given specfifically to our community, TerranovaTeam, part of International Colobot Community (ICC) (previously known as Polish Portal of Colobot (PPC); Polish: Polski Portal Colobota) with our website at http://colobot.info/.

Introduction

The source code released by Epitec was sparsely documented. This documentation, written from scratch, will aim to describe the various components of the code.

Currently, the only documented classes are the ones written from scratch or the old ones rewritten to match the new code. In time, the documentation will be extended to cover every major part of the code.

Code structure

The source code was split from the original all-in-one directory to subdirectories, each containing one major part of the project. The current layout is the following: