Programmer's Guide

Contents 1 Getting Started 2 Employed Libraries 3 Useful Tools 3.1 Compiler, Debugger, IDE 3.2 Mercurial 4 Format and Quality Standards 5 Examples and Tutorials

Getting Started

As a first step, clone the current active development branch using the following command:

hg clone https://bitbucket.org/sumwars/sumwars-code
hg update default

Next, try to build the game from source. Visit the Build instructions section if you run into problems.

Employed Libraries

Summoning Wars uses several development libraries. These are required for building the game. Moreover, experience with these can be especially useful for contributing to Summoning Wars. If you have difficulties acquiring the libraries refer to the Library Installation Guide.
The complete list of libraries is:

• OGRE >= 1.7.3
• CEGUI >= 1.7.5
• OIS >= 1.2
• alut
• ogg/vorbis
• physfs
• enet

Useful Tools

Compiler, Debugger, IDE

The source code of Summoning Wars should compile with any C++98 compliant compiler. Compilers that are known to work are g++ under Linux and MicroSoft's Visual C++ under Windows. The choice of the debugger and IDE (if any) is arbitrary as well. There are no special IDE project files provided. Instead, there is a CMakeFile, that is known to work with MicroSoft's Visual Studio.

Mercurial

Excellent Mercurial tutorial

Format and Quality Standards

Have a look at the Programming Standards - and obey them.

Examples and Tutorials