Developers Guide - Revision history

Ker at 18:04, 22 January 2013

2013-01-22T18:04:23Z

← Older revision		Revision as of 18:04, 22 January 2013
Line 1:		Line 1:
	* [[Build OpenClonk]]		* [[Build OpenClonk]]
	* [[~~Mercurial Guide~~]]		* [[Git Workflow]]
	* [[Style Guidelines]]		* [[Style Guidelines]]
	* [[Source code structure]]		* [[Source code structure]]
	* [[Sync losses]]		* [[Sync losses]]

Sven2 at 21:08, 28 September 2011

2011-09-28T21:08:31Z

← Older revision		Revision as of 21:08, 28 September 2011
Line 3:		Line 3:
	* [[Style Guidelines]]		* [[Style Guidelines]]
	* [[Source code structure]]		* [[Source code structure]]
			* [[Sync losses]]

Newton: Replaced content with '* Build OpenClonk * Mercurial Guide * Style Guidelines * Source code structure'

2010-09-04T20:10:37Z

Replaced content with '* Build OpenClonk * Mercurial Guide * Style Guidelines * Source code structure'

@@ Line 1: / Line 1: @@
-== Build OpenClonk ==
+* [[Build OpenClonk]]
 * [[Mercurial Guide]]
 * [[Style Guidelines]]
 * [[Source code structure]]

Newton at 22:02, 12 August 2010

2010-08-12T22:02:11Z

← Older revision		Revision as of 22:02, 12 August 2010
Line 1:		Line 1:
	~~Probably the first thing you want to do is to check out the repository and compile your own binaries.~~

	== Build OpenClonk ==		== Build OpenClonk ==

Newton at 00:20, 1 March 2010

2010-03-01T00:20:01Z

← Older revision		Revision as of 00:20, 1 March 2010
Line 1:		Line 1:
	Probably the first thing you want to do is to check out the repository and compile your own binaries~~. This article explains this and how you commit changes to our repository~~.		Probably the first thing you want to do is to check out the repository and compile your own binaries.

	== Build OpenClonk ==		== Build OpenClonk ==
Line 15:		Line 15:
	: '''3. Compile the game'''		: '''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.		: 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.

			== Miscellaneous Links ==
			* [[Mercurial Guide]]
			* [[Style Guidelines]]
			* [[Source code structure]]

Newton at 00:06, 1 March 2010

2010-03-01T00:06:30Z

@@ Line 7: / Line 7: @@
 Otherwise, here is how you can build OpenClonk in three easy steps:
+: '''1. Get the source code'''
-'''1. Get the source code'''
+: See [[Mercurial Guide]]
 : '''2. Install Build tools and libraries'''
-We use Mercurial as our version control system. The [http://bitbucket.org/tortoisehg/stable/wiki/install TortoiseHG website] describes how to install it. If you just want to download the OpenClonk source code, you can also install Mercurial without TortoiseHG.
+: OpenClonk has a couple of dependencies on other libraries. Please refer to the Readme.*.txt in the freshly checked out source tree. You need to download and install the [http://www.fmod.org/index.php/release/version/fmodapi375win.zip FMOD SDK] and the [http://www.microsoft.com/downloads/details.aspx?FamilyID=24a541d6-0486-4453-8641-1eee9e21b282&displaylang=en DirectX SDK]. For windows, we provide prebuilt packages of libraries:
-TortoiseHG is a GUI for Mercurial which makes using Mercurial much more comfortable.
+:* [http://www.openclonk.org/openclonk-deps-vc90.zip for Microsoft C++ users]
+:* [http://www.openclonk.org/mingwlibs2.zip for GNU Compiler Collection users]
-Two tips for somebody new to Mercurial: Ignore the revision numbers, they are only there to mislead you. Pay attention to the changelog id. And activate the "Mercurial Queues" extension to get the "strip" command, with which one can delete changesets that are no longer needed.
+: '''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.

Newton at 23:09, 28 February 2010

2010-02-28T23:09:05Z

← Older revision		Revision as of 23:09, 28 February 2010
Line 37:		Line 37:
	We're using the distributed version control system Mercurial, so you actually already have your own repository which is a clone of the openclonk.org repository. So what you got to do is to make the changes on your local copy of the repository. You commit them to your local Mercurial repository and after that export them as a patch (if you only changed source code or text) or as a bundle (if you changed binary files).		We're using the distributed version control system Mercurial, so you actually already have your own repository which is a clone of the openclonk.org repository. So what you got to do is to make the changes on your local copy of the repository. You commit them to your local Mercurial repository and after that export them as a patch (if you only changed source code or text) or as a bundle (if you changed binary files).
	You can show your piece of code to one of the people with write access to our repository by posting it in the forum. We'll have a look at the changeset and determine if your changes are fit for incorporating them into the source tree.		You can show your piece of code to one of the people with write access to our repository by posting it in the forum. We'll have a look at the changeset and determine if your changes are fit for incorporating them into the source tree.

	~~== Miscellanous notes ==~~

	~~=== Mercurial extensions you really need ===~~

	~~Add these to your ~/.hgrc:~~

	~~hgext.mq=~~
	This enables the "strip" command, with which you can remove a unwanted revision. Absolutely necessary, because the great thing about distributed revision control is that one can commit early and often and then go back and clean up, often creating new commits to replace the old ones. But the old ones do not disappear after being abandoned. Or maybe you want to try out some revision from somebody else, and get rid of it afterwards.

	~~hgext.rebase=~~
	~~hgext.transplant=~~
	~~These enable you to reorder history. Essential if you have an experimental feature followed by a bugfix and only want to push the bugfix to the public repository.~~

Newton at 18:42, 28 February 2010

2010-02-28T18:42:35Z

← Older revision		Revision as of 18:42, 28 February 2010
Line 1:		Line 1:
			Probably the first thing you want to do is to check out the repository and compile your own binaries. This article explains this and how you commit changes to our repository.

	== Build OpenClonk ==		== Build OpenClonk ==

Line 17:		Line 19:
	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:		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>		<nowiki>hg pull --update</nowiki>


	'''2. Install Build tools and libraries'''		'''2. Install Build tools and libraries'''
Line 24:		Line 27:
	* [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]


	'''3. Compile the game'''		'''3. Compile the game'''
Line 29:		Line 33:
	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.		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~~ ==		== Contribute changes ==

	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.

	~~See also~~ the ~~[http://forum.~~openclonk.org~~/topic_show~~.~~pl?tid=226 topic~~ in the ~~developers corner]~~.		We're using the distributed version control system Mercurial, so you actually already have your own repository which is a clone of the openclonk.org repository. So what you got to do is to make the changes on your local copy of the repository. You commit them to your local Mercurial repository and after that export them as a patch (if you only changed source code or text) or as a bundle (if you changed binary files).
			You can show your piece of code to one of the people with write access to our repository by posting it in the forum. We'll have a look at the changeset and determine if your changes are fit for incorporating them into the source tree.

	== Miscellanous notes ==		== Miscellanous notes ==

Newton: /* Miscellanous notes */

2010-02-27T16:02:06Z

Miscellanous notes

← Older revision		Revision as of 16:02, 27 February 2010
Line 36:		Line 36:

	== Miscellanous notes ==		== Miscellanous notes ==

	~~We have [[SourceCodeReorganization\|reorganized the source code]].~~

	=== Mercurial extensions you really need ===		=== Mercurial extensions you really need ===

Isilkor: moved DevelopersGuide to Developers Guide: Spacey titles preferred

2010-02-27T15:58:13Z

moved DevelopersGuide to Developers Guide: Spacey titles preferred

@@ Line 10: / Line 10: @@
 We use Mercurial as our version control system. The [http://bitbucket.org/tortoisehg/stable/wiki/install 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:
@@ Line 36: / Line 38: @@
 We have [[SourceCodeReorganization|reorganized the source code]].