Developers Guide: Difference between revisions

Revision as of 20:16, 9 September 2009

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. If you don't have it yet, install it and best TortoiseHG from TortoiseHGs website 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:

3. Compile the game

Commit 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.

@@ Line 1: / Line 1: @@
-== Building OpenClonk in four easy steps. ==
+== Build OpenClonk ==
-. Install Mercurial and TortoiseHG
+Windows users can check out this tutorial: [[Building_with_Windows|Building with Visual C++]]
-http://bitbucket.org/tortoisehg/stable/wiki/install
+Otherwise, here is how you can build OpenClonk in three easy steps:
-Linux users should install the mercurial package from their distribution first. Technically, you can skip installing TortoiseHG, but the GUI changelog is just so much better than the text one.
-. Get the source code
+'''1. Get the source code'''
-Use the TortoiseHG dialog to clone http://hg.openclonk.org/ or execute this command in a commandline shell:
+We use Mercurial as our version control system. If you don't have it yet, install it and best TortoiseHG from [http://bitbucket.org/tortoisehg/stable/wiki/install TortoiseHGs website]
+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:
   <nowiki>hg clone http://hg.openclonk.org/ openclonk</nowiki>
+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:
+ <nowiki>hg pull --update</nowiki>
-. Install Build tools and libraries
+'''2. Install Build tools and libraries'''
-Please refer to the Readme.*.txt in the freshly checked out source tree.
+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:
-* http://forum.openclonk.org/topic_show.pl?pid=1405#pid1405 for Microsoft C++ users
+* [http://forum.openclonk.org/topic_show.pl?pid=1405#pid1405 for Microsoft C++ users]
-* http://forum.openclonk.org/topic_show.pl?pid=1522#pid1522 for GNU Compiler Collection users
+* [http://forum.openclonk.org/topic_show.pl?pid=1522#pid1522 for GNU Compiler Collection users]
-. Compile the game
+'''3. Compile the game'''
-== Get your change into the openclonk.org repository ==
+== Commit changes into the openclonk.org repository ==
-First, change the source code. Then commit it to your local mercurial repository. Then, export the commit 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.
+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 [[SourceCodeReorganization|reorganized the source code]].