Developers Guide

Build OpenClonk

Windows users can check out this tutorial: Building with Visual C++

Otherwise, here is how you can build OpenClonk in three easy steps:

1. Get the source code

We use Mercurial as our version control system. The TortoiseHG website describes how to install it. If you just want to download the OpenClonk source code, you can also install Mercurial without TortoiseHG. TortoiseHG is a GUI for Mercurial which makes using Mercurial much more comfortable.

To get the source, you have to clone the repository. Use the TortoiseHG dialog to clone http://hg.openclonk.org/ or execute this command in a commandline shell:

hg clone http://hg.openclonk.org/ openclonk

If you already cloned the repository and only want to update your local repository, use the Synchronise dialog of TortoiseHG to pull the repository and update. Or execute in the commandline:

hg pull --update

2. Install Build tools and libraries

OpenClonk has a couple of dependencies on other libraries. Please refer to the Readme.*.txt in the freshly checked out source tree. For windows, we provide prebuilt packages of libraries:

• for Microsoft C++ users
• for GNU Compiler Collection users

3. Compile the game

Again, the Readme.*.txt has the details, as this step is highly platform dependent. But it's also comparatively uncomplicated: If you installed everything that's listed, and it doesn't build, you found a bug.

Get your changes into the openclonk.org repository

First, make the changes on your local copy of the repository. Then commit it to your local Mercurial repository. After that, you can export the changes as a patch (if you only changed source code or text) or as a bundle (if you changed binary files). Then attach the file to a forum post.

Miscellanous notes

We have reorganized the source code.