git

Currently, the best way of getting openc2e is downloading the source code via git, a popular version control system.

On a machine with the official git client installed, you can acquire the source with the following command:

git clone git://github.com/ccdevnet/openc2e.git openc2e

If successful, this will pull the most recent source code into a 'openc2e' folder in the current directory. Once you've done that once, you can later update to the latest version by running the following command from inside the 'openc2e' folder:

git pull

If you don't want to use the a git client, you can visit the openc2e github page and click the 'Download' link to get an archive of the latest source.

Requirements

In order to build a copy of openc2e on a unix-based system, you will need the following software installed:

On Debian, these can be taken care of with a single command:

apt-get install libyaml-perl libsdl1.2debian-all libsdl1.2-dev libopenal-dev libalut-dev libboost-filesystem-dev libsdl-net1.2-dev libsdl-gfx1.2-dev libsdl-ttf2.0-dev re2c bison zlib1g-dev libboost-iostreams-dev libboost-thread-dev libboost-serialization-dev libboost-program-options-dev libboost-regex-dev libqt4-dev build-essential perl cmake

On Mac OS X 10.5, you need to install the following:

Building

As soon as you've installed everything you need, you then run the following:

mkdir build && cd build
cmake ..

This will make and move into a directory called build, ensure that you have everything you need and create a makefile for the build.

To start the actual build, follow this up with:

make

Yes, it's that easy! The build process will run automatically. If the compile is successful, it will produce an executable called 'openc2e'. But before you can run it, you must make a link to your Creatures data files in the build directory, like so:

ln -s '/path/to/creatures/folder' data

After that, you can just run...

./openc2e

... and watch it load! The 'data' link can be changed to the folder of any supported Creatures game (currently C1, C2, C3 and DS). Alternatively, you can run something like the following:

./openc2e -d '/path/to/creatures/folder'

...rather than creating the data link. Also, you can try the '-h' flag for a list of other available flags. For docking C3 and DS, add a -d for the path for both games in that order. Have fun.