Developers Guide: Difference between revisions

m Fix a typo
Ker (talk | contribs)
mNo edit summary
 
(11 intermediate revisions by 4 users not shown)
Line 1: Line 1:
== Build OpenClonk ==
* [[Build OpenClonk]]
 
* [[Git Workflow]]
Windows users can check out this tutorial: [[Building_with_Windows|Building with Visual C++]]
* [[Style Guidelines]]
 
* [[Source code structure]]
Otherwise, here is how you can build OpenClonk in three easy steps:
* [[Sync losses]]
 
 
'''1. Get the source code'''
 
We use Mercurial as our version control system. The [http://bitbucket.org/tortoisehg/stable/wiki/install TortoiseHG website] descibes 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:
<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>
 
'''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:
* [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]
 
'''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 [[SourceCodeReorganization|reorganized the source code]].

Latest revision as of 18:04, 22 January 2013