OpenClonk Wiki - User contributions [en]

Building with MinGW

2013-02-04T16:14:37Z

Ker:

= Getting the sources =
Just follow the instructions in [[Building_with_Windows#Get_the_sources]].

= Getting MinGW =
Choose the most recent installer from[[http://sourceforge.net/projects/mingw/files/Installer/mingw-get-inst/ sourceforge]].

Click Next until you hit the following screen:

[[File:MinGW_Setup_1.png]]

Check the boxes "C++ Compiler", "MSYS Basic System" and "MinGW Developer Toolkit". Finish the installation wizard.

= Compiling =

== Getting precompiled dependencies ==
Download them from [[http://oli-obk.de/clonk_mingw_deps.zip]] and extract them to the openclonk folder (that you checked out with tortoisegit).

== Getting cmake ==

Download the win32 installer from [[http://www.cmake.org/cmake/resources/software.html#latest]] and click yourself through the installer.

== Compiling the source ==

Run the "MinGW Shell", which can be found under Start->Programs->MinGW.

Now we want to go to the openclonk folder. Since the MinGW Shell kindof simulates a linux shell, you have to use different commands when compared to the windows command prompt.
If you checked out openclonk to "C:\Users\MyUser\openclonk" you have to type '''cd /c/Users/MyUser/openclonk''' to get to that directory. Do this now.

You then tell cmake that you are planning on using mingw and it should create all the necessary files for you: '''cmake . -G"MSYS Makefiles"'''.
If the result looks like the following image, everything went as planned:

[[File:mingw_cmake.png]]

Type '''make''' and watch huge amounts of green text pass by. This is a good time for a coffee break.

Once the compilation is done you should find a '''openclonk.exe'''. Copy all the files from the "deps/bin" folder to this folder and run openclonk.exe.

File:Mingw cmake.png

2013-02-04T14:49:36Z

Ker:

Building with MinGW

2013-02-04T14:49:20Z

Ker: Created page with "= Getting the sources = Just follow the instructions in Building_with_Windows#Get_the_sources. = Getting MinGW = Choose the most recent installer from[[http://sourceforge..."

= Getting the sources =
Just follow the instructions in [[Building_with_Windows#Get_the_sources]].

= Getting MinGW =
Choose the most recent installer from[[http://sourceforge.net/projects/mingw/files/Installer/mingw-get-inst/ sourceforge]].

Click Next until you hit the following screen:

[[File:MinGW_Setup_1.png]]

Check the boxes "C++ Compiler", "MSYS Basic System" and "MinGW Developer Toolkit". Finish the installation wizard.

= Compiling =

== Getting precompiled dependencies ==
Download them from [[http://oli-obk.de/clonk_mingw_deps.zip]] and extract them to the openclonk folder (that you checked out with tortoisegit).

== Getting cmake ==

Download the win32 installer from [[http://www.cmake.org/cmake/resources/software.html#latest]] and click yourself through the installer.

== Compiling the source ==

Run the "MinGW Shell", which can be found under Start->Programs->MinGW.

Now we want to go to the openclonk folder. Since the MinGW Shell kindof simulates a linux shell, you have to use different commands when compared to the windows command prompt.
If you checked out openclonk to "C:\Users\MyUser\openclonk" you have to type '''cd /c/Users/MyUser/openclonk''' to get to that directory. Do this now.

Since we don't want cmake to mess up our openclonk repository, we'll create an extra build folder where it can do as it pleases.
Type "mkdir build" to do that.
Now enter that new folder with '''cd build'''.

You then tell cmake that you are planning on using mingw and it should create all the necessary files for you: '''cmake .. -G"MSYS Makefiles"'''.
If the result looks like the following image, everything went as planned:

[[File:mingw_cmake.png]]

Type '''make''' and watch huge amounts of green text pass by. This is a good time for a coffee break.

File:MinGW Setup 1.png

2013-02-04T13:56:47Z

Ker:

Build OpenClonk

2013-02-04T13:43:33Z

Ker:

Windows users can check out these tutorials:

[[Building_with_Windows|Building with Visual C++]]

[[Building_with_MinGW|Building with MinGW]]

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

== 1. Get the source code ==
See [[Git Workflow]]

== 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://www.openclonk.org/openclonk-deps-vc90.zip for Microsoft C++ users]
:* [http://www.openclonk.org/mingwlibs2.zip for GNU Compiler Collection users]
:You probably want to download and install the [http://www.fmod.org/index.php/release/version/fmodapi375win.zip FMOD SDK] for sound. The [http://www.microsoft.com/downloads/details.aspx?FamilyID=24a541d6-0486-4453-8641-1eee9e21b282&displaylang=en DirectX SDK] is optional, the default is OpenGL.
== 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.

= Building a debug engine =

The Clonk source code contains lots of little pieces of code that check that the engine works correctly. They can often help finding or preventing bugs, but slow the game down, so they are skipped in normal builds. To enable them, pass -DCMAKE_BUILD_TYPE=Debug to cmake, choose the Debug build in the IDE, or pass --enable-debug to configure. If you are using the GNU Compiler Collection, you can also enable [http://gcc.gnu.org/onlinedocs/libstdc++/manual/debug_mode.html the libstdc++ debug mode] by passing CPPFLAGS=-D_GLIBCXX_DEBUG to configure.

Building with Windows

2013-02-03T20:55:13Z

Ker: /* In case you use the Express Edition */

= Get the sources =

The source of OpenClonk is hold in a so-called version control system. Put simply, this is something that allows programmers to coordinate their work (see [[Git Workflow|the Git article]] for how that works). For the moment, it's just a couple of files you want to download.

== Install TortoiseGit ==

The notable difference to a simple download is that you need a special program to do it. Our version control system is Git, and we will use the [http://code.google.com/p/tortoisegit/ TortoiseGit] client. Follow that link and click "Download".

[[File:build_windows_tgit.png|860px]]

As the website tells you, the installation of TortoiseGit has two parts: TortoiseGit and msysGit. It also says that you should start with TortoiseGit, so let us get that installer first. Make sure to choose the right architecture for your version of Windows:

[[File:build_windows_tgit2.png|860px]]

And walk through the installation. Just selecting the default options should get you through alright.

''OpenClonk team members:'' If you want to use [http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html PuTTY] to push commits, make sure to select the appropriate option along the way. Do it again for the msysGit installation below.

[[File:build_windows_tgit4.png]]

Next, you need msysGit, which is what actually does all the work behind the scenes. Following the [http://code.google.com/p/msysgit/downloads/list?can=2&q=%22Full+installer+for+official+Git+for+Windows%22 "Full installer for official Git"] link will get you to another download page:

[[File:build_windows_tgit3.png|860px]]

This installation will ask even more confusing questions. But again default options won't cause anything to break, I would just recommend deactivating some GUI options, as TortoiseGit already offers them:

[[File:build_windows_tgit5.png]]

After a bit of waiting and (if you're lucky) not a single request to restart your computer, this should have given you a working TortoiseGit installation.

== Clone ==

Okay, now we are going to download the sources. Git calls this "cloning" because it's actually a lot more than just the sources you get. After you're done, you can check the [[Git Workflow]] page for how to work with your clone.

For now, just find a place where you want the source to be, open the context menu by right-click and select "Git Clone..." from the TortoiseGit menu:

[[File:build_windows_tgit6.png]]

A dialog will appear asking for the repository URL and the destination path. In our case, we want the source to be the OpenClonk repository. The URL you need is normally "git://git.openclonk.org/openclonk.git". Here's how it should look like:

''OpenClonk team members:'' Use "ssh://git@git.openclonk.org/openclonk.git" instead and activate the option to auto-load the PuTTY key for maximum convenience.

[[File:build_windows_tgit_pub.png]]

After pressing "OK", TortoiseGit will work for a while. After watching a tortoise somersaulting for a while, it should finish. Congratulations, you now have the bleeding edge of OpenClonk development on your hard drive!

[[File:build_windows_tgit_finish.png]]

This a lot of stuff and most likely you won't understand much of it. Here's a quick orientation guide of the actually important bits:
* "docs" - the sources of our [http://docs.openclonk.org/en/sdk/ documentation]
* "planet" - these are the game resources - scripts, graphics and everything to explain how to make a game out of them
* "src" - all the source code of the game engine. Lots of C++ ahead.

= Get it to Compile =

This is nice, but we are interested in seeing the game run, aren't we? For this, we need a program that will take all those C++ files and make an executable file out of it. Unfortunately, programming is complicated stuff so even setting up the tools and the environment has become a bit of science. But this won't stop us.

== Get Microsoft Visual Studio ==

You can say what you want about Microsoft, but they sure make nice development environments. And they are even giving a lot of it away for free. We will use[http://www.microsoft.com/express/vc/#webInstall Visual Studio C++ 2010]. Follow that link, click yourself through the ever-shifting Microsoft website to the 2010 Express Edition, until you arrive at something that ideally looks like follows:

[[File:build_windows_msvc1_new.png|860px]]

The installer will offer us a lot of stuff we don't really need for OpenClonk. You should uncheck it to make the installation faster.

[[File:build_windows_msvc2.png]]

You will most likely stare at the following screen for a bit. It won't take that long, and for me didn't even restart the computer like it suggested it would.

[[File:build_windows_msvc3.png]]

=== In case you use the Express Edition ===
Since clonk can currently only be compiled for 32 bit, and the 2010 Express Edition doesn't allow 32 bit compilation, you will need additional files

1. [http://www.microsoft.com/en-us/download/details.aspx?id=8279 Windows SDK 7.1]

2. [http://www.microsoft.com/en-us/download/details.aspx?id=4422 Compiler Update for the Windows SDK 7.1]

3. [http://www.microsoft.com/en-us/download/confirmation.aspx?id=23691 Visual Studio 2010 Service Pack 1]

== Get Dependencies ==

Like most big programs, OpenClonk doesn't stand on its own. Some things (like opening PNG images) were already programmed by other programers far better than we could ever do. This is why we have to get a few so-called "libraries" before Clonk can be built.

You could try to search and download all those libraries by hand, but that would be pretty boring. Instead, just download [http://www.openclonk.org/openclonk-deps-vc90.zip this package] that contains everything you need to build Clonk.

[[File:build_windows_deps.png]]

Unpack both directories into the same path you put all the other files. Don't worry, nothing will get overwritten in "planet".

== Get CMake ==

Before all this becomes useful, we still need something that tells the compiler ''how'' all those sources and libraries should be compiled together.

For this, Visual C++ needs a project file. But there is none - we have to consult ''another'' program to generate it for us. This might seem confusing - but the point is that there are a lot of build environments besides Visual Studio, and having all those project files next to each other would become a problem in the long run.

What we need is [http://www.cmake.org/cmake/resources/software.html#latest CMake]. Follow that link and download the installer:

[[File:build_windows_cmake1.png|860px]]

You know what to do.

[[File:build_windows_cmake2.png]]

After the installation, start the CMake GUI from the start menu. Put the path you cloned the repository into the source code path field.

[[File:build_windows_cmake3.png]]

Now click the "Configure" button in the lower left. It will ask what compiler we want to use. Select the compiler you want to use, for example "Visual Studio 10". Do ''not'' pick the Win64 option, as the precompiled libraries are 32 bit.

[[File:build_windows_cmake4.png]]

If you get some error messages (in red), you're probably missing some dependencies. Don't worry if cmake complains about some missing paths, it shouldn't affect you.

The last step is to click the "Generate" button.

== Your First Build ==

Okay, now we have everything needed to make OpenClonk run for the first time. Go into the source directory and double-click on the "openclonk.sln" file that should now have appeared:

[[File:build_windows_build1.png]]

Visual C++ should open and look similar to this:

[[File:build_windows_build2.png]]

We only want to build the engine, so select "clonk" from the list, right-click and select "Set as Start-Up project"

[[File:build_windows_build3.png]]

Now select "Build Solution" from the "Build" menu (or just press F7). No, I don't know what "solution" means. Drink a cup of coffee or two while you wait for the compiler to do its job.

Eventually, you will arrive at this screen.

[[File:build_windows_build4.png]]

Nevertheless, you can now select "Start Debugging" from the "Debug" menu (or just press F5) and should be greeted by the startup screen of a fresh OpenClonk build!

[[File:Openclonk_first_start.jpg]]

In case you are wondering why OpenClonk suddenly starts in some kind of pseudo windowed mode: This is because we just built a debug build (note the "dbg" after the version?). This build is a bit slower but allows you to get a better look at the internals of the engine while it's running. Maybe we'll have another article about that soon.

= Enabling sound and DirectX =

So far, the version of OpenClonk you can compile runs with OpenGL only and without sound. Here is how to enable both DirectX and sound:

Download the latest [http://msdn.microsoft.com/en-us/directx/default.aspx DirectX SDK] from the Microsoft website and install it. For sound, download the [http://www.fmod.org/index.php/download#FMOD3ProgrammersAPI FMOD 3 Programmers API] and unpack it somewhere. Now, you need to copy api/fmod.dll into your planet/ directory, all the files that are in api/inc to planet/deps/include and api/lib/fmodvc.lib to planet/deps/lib.

Thats it. Now, you need to re-run CMake and check both USE_DIRECTX and USE_FMOD. Compiling the game with VC++ will now produce a build where you can hear the sound and use direct x.

Building with Windows

2013-02-03T19:49:08Z

Ker: /* Get Microsoft Visual Studio */

= Get the sources =

The source of OpenClonk is hold in a so-called version control system. Put simply, this is something that allows programmers to coordinate their work (see [[Git Workflow|the Git article]] for how that works). For the moment, it's just a couple of files you want to download.

== Install TortoiseGit ==

The notable difference to a simple download is that you need a special program to do it. Our version control system is Git, and we will use the [http://code.google.com/p/tortoisegit/ TortoiseGit] client. Follow that link and click "Download".

[[File:build_windows_tgit.png|860px]]

As the website tells you, the installation of TortoiseGit has two parts: TortoiseGit and msysGit. It also says that you should start with TortoiseGit, so let us get that installer first. Make sure to choose the right architecture for your version of Windows:

[[File:build_windows_tgit2.png|860px]]

And walk through the installation. Just selecting the default options should get you through alright.

''OpenClonk team members:'' If you want to use [http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html PuTTY] to push commits, make sure to select the appropriate option along the way. Do it again for the msysGit installation below.

[[File:build_windows_tgit4.png]]

Next, you need msysGit, which is what actually does all the work behind the scenes. Following the [http://code.google.com/p/msysgit/downloads/list?can=2&q=%22Full+installer+for+official+Git+for+Windows%22 "Full installer for official Git"] link will get you to another download page:

[[File:build_windows_tgit3.png|860px]]

This installation will ask even more confusing questions. But again default options won't cause anything to break, I would just recommend deactivating some GUI options, as TortoiseGit already offers them:

[[File:build_windows_tgit5.png]]

After a bit of waiting and (if you're lucky) not a single request to restart your computer, this should have given you a working TortoiseGit installation.

== Clone ==

Okay, now we are going to download the sources. Git calls this "cloning" because it's actually a lot more than just the sources you get. After you're done, you can check the [[Git Workflow]] page for how to work with your clone.

For now, just find a place where you want the source to be, open the context menu by right-click and select "Git Clone..." from the TortoiseGit menu:

[[File:build_windows_tgit6.png]]

A dialog will appear asking for the repository URL and the destination path. In our case, we want the source to be the OpenClonk repository. The URL you need is normally "git://git.openclonk.org/openclonk.git". Here's how it should look like:

''OpenClonk team members:'' Use "ssh://git@git.openclonk.org/openclonk.git" instead and activate the option to auto-load the PuTTY key for maximum convenience.

[[File:build_windows_tgit_pub.png]]

After pressing "OK", TortoiseGit will work for a while. After watching a tortoise somersaulting for a while, it should finish. Congratulations, you now have the bleeding edge of OpenClonk development on your hard drive!

[[File:build_windows_tgit_finish.png]]

This a lot of stuff and most likely you won't understand much of it. Here's a quick orientation guide of the actually important bits:
* "docs" - the sources of our [http://docs.openclonk.org/en/sdk/ documentation]
* "planet" - these are the game resources - scripts, graphics and everything to explain how to make a game out of them
* "src" - all the source code of the game engine. Lots of C++ ahead.

= Get it to Compile =

This is nice, but we are interested in seeing the game run, aren't we? For this, we need a program that will take all those C++ files and make an executable file out of it. Unfortunately, programming is complicated stuff so even setting up the tools and the environment has become a bit of science. But this won't stop us.

== Get Microsoft Visual Studio ==

You can say what you want about Microsoft, but they sure make nice development environments. And they are even giving a lot of it away for free. We will use[http://www.microsoft.com/express/vc/#webInstall Visual Studio C++ 2010]. Follow that link, click yourself through the ever-shifting Microsoft website to the 2010 Express Edition, until you arrive at something that ideally looks like follows:

[[File:build_windows_msvc1_new.png|860px]]

The installer will offer us a lot of stuff we don't really need for OpenClonk. You should uncheck it to make the installation faster.

[[File:build_windows_msvc2.png]]

You will most likely stare at the following screen for a bit. It won't take that long, and for me didn't even restart the computer like it suggested it would.

[[File:build_windows_msvc3.png]]

=== In case you use the Express Edition ===
Since clonk can currently only be compiled for 32 bit, and the 2010 Express Edition doesn't allow 32 bit compilation, you will need additional files

1. [http://www.microsoft.com/en-us/download/details.aspx?id=8279 Windows SDK 7.1]

2. [http://www.microsoft.com/en-us/download/details.aspx?id=4422 Compiler Update for the Windows SDK 7.1]

== Get Dependencies ==

Like most big programs, OpenClonk doesn't stand on its own. Some things (like opening PNG images) were already programmed by other programers far better than we could ever do. This is why we have to get a few so-called "libraries" before Clonk can be built.

You could try to search and download all those libraries by hand, but that would be pretty boring. Instead, just download [http://www.openclonk.org/openclonk-deps-vc90.zip this package] that contains everything you need to build Clonk.

[[File:build_windows_deps.png]]

Unpack both directories into the same path you put all the other files. Don't worry, nothing will get overwritten in "planet".

== Get CMake ==

Before all this becomes useful, we still need something that tells the compiler ''how'' all those sources and libraries should be compiled together.

For this, Visual C++ needs a project file. But there is none - we have to consult ''another'' program to generate it for us. This might seem confusing - but the point is that there are a lot of build environments besides Visual Studio, and having all those project files next to each other would become a problem in the long run.

What we need is [http://www.cmake.org/cmake/resources/software.html#latest CMake]. Follow that link and download the installer:

[[File:build_windows_cmake1.png|860px]]

You know what to do.

[[File:build_windows_cmake2.png]]

After the installation, start the CMake GUI from the start menu. Put the path you cloned the repository into the source code path field.

[[File:build_windows_cmake3.png]]

Now click the "Configure" button in the lower left. It will ask what compiler we want to use. Select the compiler you want to use, for example "Visual Studio 10". Do ''not'' pick the Win64 option, as the precompiled libraries are 32 bit.

[[File:build_windows_cmake4.png]]

If you get some error messages (in red), you're probably missing some dependencies. Don't worry if cmake complains about some missing paths, it shouldn't affect you.

The last step is to click the "Generate" button.

== Your First Build ==

Okay, now we have everything needed to make OpenClonk run for the first time. Go into the source directory and double-click on the "openclonk.sln" file that should now have appeared:

[[File:build_windows_build1.png]]

Visual C++ should open and look similar to this:

[[File:build_windows_build2.png]]

We only want to build the engine, so select "clonk" from the list, right-click and select "Set as Start-Up project"

[[File:build_windows_build3.png]]

Now select "Build Solution" from the "Build" menu (or just press F7). No, I don't know what "solution" means. Drink a cup of coffee or two while you wait for the compiler to do its job.

Eventually, you will arrive at this screen.

[[File:build_windows_build4.png]]

Nevertheless, you can now select "Start Debugging" from the "Debug" menu (or just press F5) and should be greeted by the startup screen of a fresh OpenClonk build!

[[File:Openclonk_first_start.jpg]]

In case you are wondering why OpenClonk suddenly starts in some kind of pseudo windowed mode: This is because we just built a debug build (note the "dbg" after the version?). This build is a bit slower but allows you to get a better look at the internals of the engine while it's running. Maybe we'll have another article about that soon.

= Enabling sound and DirectX =

So far, the version of OpenClonk you can compile runs with OpenGL only and without sound. Here is how to enable both DirectX and sound:

Download the latest [http://msdn.microsoft.com/en-us/directx/default.aspx DirectX SDK] from the Microsoft website and install it. For sound, download the [http://www.fmod.org/index.php/download#FMOD3ProgrammersAPI FMOD 3 Programmers API] and unpack it somewhere. Now, you need to copy api/fmod.dll into your planet/ directory, all the files that are in api/inc to planet/deps/include and api/lib/fmodvc.lib to planet/deps/lib.

Thats it. Now, you need to re-run CMake and check both USE_DIRECTX and USE_FMOD. Compiling the game with VC++ will now produce a build where you can hear the sound and use direct x.

Build OpenClonk

2013-01-22T18:04:38Z

Ker: /* 1. Get the source code */

Windows users can check out this tutorial: [[Building_with_Windows|Building with Visual C++]]

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

== 1. Get the source code ==
See [[Git Workflow]]

== 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://www.openclonk.org/openclonk-deps-vc90.zip for Microsoft C++ users]
:* [http://www.openclonk.org/mingwlibs2.zip for GNU Compiler Collection users]
:You probably want to download and install the [http://www.fmod.org/index.php/release/version/fmodapi375win.zip FMOD SDK] for sound. The [http://www.microsoft.com/downloads/details.aspx?FamilyID=24a541d6-0486-4453-8641-1eee9e21b282&displaylang=en DirectX SDK] is optional, the default is OpenGL.
== 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.

= Building a debug engine =

The Clonk source code contains lots of little pieces of code that check that the engine works correctly. They can often help finding or preventing bugs, but slow the game down, so they are skipped in normal builds. To enable them, pass -DCMAKE_BUILD_TYPE=Debug to cmake, choose the Debug build in the IDE, or pass --enable-debug to configure. If you are using the GNU Compiler Collection, you can also enable [http://gcc.gnu.org/onlinedocs/libstdc++/manual/debug_mode.html the libstdc++ debug mode] by passing CPPFLAGS=-D_GLIBCXX_DEBUG to configure.

Developers Guide

2013-01-22T18:04:23Z

Ker:

* [[Build OpenClonk]]
* [[Git Workflow]]
* [[Style Guidelines]]
* [[Source code structure]]
* [[Sync losses]]

C4Script Documentation

2013-01-22T18:04:04Z

Ker: /* Further links */

[[File:C4Script.png|300px|thumb|right|One of the simpler scripts... :-)]]
Like the previous Clonk titles, OpenClonk offers countless possibilites to create your own scenarios, objects and campaigns. Since [http://www.clonk.de/classics.php?lng=en Clonk 4], one of Clonk's most remarkable features has been it's extensibility. The complete content is scripted in C4Script, Clonk's own powerful scripting language, has been developed further since 1998. Now, it feels pretty much like a typical C-style scripting language. If you know other programming languages, you will have no problem to familarize yourself with C4Script and if you never programmed before, it can be a good introduction and practice to programming.

Everything about C4Script and the game data is documented in our [http://docs.openclonk.org/en/sdk/ C4Script Documentation].

You may want to [http://www.openclonk.org/download/ download] the latest game data first before you add or edit any game content. See the [http://www.openclonk.org/nightly-builds/ nightly builds] page for the most current builds.

== Further links ==
* [[Artists Guide|Graphics]] - Render and texture 3D-models
* [[Artists_Guide#Sounds_.26_Music|Sounds and music]] - Include sound effects and music into the game
* [[Content Developers Guide|Game content]] - including creating objects, scenarios and campaigns with C4Script
* [[Git Workflow]] - How to use our repository
* [[Developers Guide]] - For engine developers

FAQ

2013-01-22T18:03:22Z

Ker: /* How do I submit a patch? */

If you don't find your particular question answered here, post in the [http://forum.openclonk.org/ forum]! You don't need to register but can ask as Anonymous there.

__TOC__

=== I cannot start the game! What do I do? ===
Describe your problem in the forum and post any relevant information:
* There is a Clonk.log in your OpenClonk directory. On Windows, it's in C:\Users\[Username]\AppData\Roaming\OpenClonk\
* What's your video card? Are your drivers up-to-date? Intel Express Chipsets reportedly have problems with OpenGL
* Which version of this game are you using? Did you try out the latest development snapshot? Does the problem persist then?

=== How do I submit a patch? ===
This answer assumes that you are using TortoiseGit. After you [[Git Workflow|checked out the source code]] and made your changes, you need to ''commit'' these changes. Afterwards, you can use the context menu to create a patch. This will create a new file which you can paste into a forum post. If you made or changed a binary file, please also attach it to your post.

=== Why is this page in English? Isn't Clonk a German game? ===
Clonk has been a German shareware game and thus its community has been mainly German. With the switch to the English language for the OpenClonk community, we intended to widen the community to an international level and make it possible for non-Germans to contribute to and participate in OpenClonk.
However, there is a German subforum now.

And of course, German, as well as other languages will continue to be supported in the game. Just the ''development'' and the community of OpenClonk will be in English.

=== Why did you start from scratch regarding the game content? ===
During shareware Clonk development, the game content stayed mainly about the same and was just extended by add-ons. This and the decision to keep the game as backward compatible as possible blocked lots of good changes and new concepts that could have been introduced in the game.

OpenClonk is a different game than the old Clonk series, it is not be just a sequel in the fashion of previous Clonk development. The aim of OpenClonk is not to replace Clonk Rage by "making it better" while keeping everything as it was before.
Clonk is about mining, about production lines and economy, fast and fiddly melees, known for flexibility in scenario design and whatnot. In this project, we aim to improve these strengths, which means that during OpenClonk development more fundamental changes must be (and are) possible.

Clonk Rage on the other hand will continue to exist alongside OpenClonk as the last title of the shareware series and will continue to include all that classical and that the community has come to love. Also read
[http://forum.openclonk.org/topic_show.pl?pid=1677#pid1677 this old forum discussion] on this topic.

=== Will you convert all those great Clonk Rage expansions for OpenClonk? ===
No, and we never will. OpenClonk is not backwards compatible with Clonk Rage, and never will be. We have broken ties with the old game content which all these expansions rely on. Hence the name, they are expansions for Clonk Rage. Specifically, Clonk Rage. OpenClonk is a different game with different game content, graphics, and script language, and therefore cannot have it's game content expanded with expansions designed for a completely different game.

=== Am I able to play with several players on one PC? ===
Generally yes. However, currently this is not possible yet.

=== Will there be keyboard-only controls? ===
No. OpenClonk is played with keyboard and mouse as the whole game is designed to utilize the advantages of mouse control. This adds a completely new set of gameplay possibilities to the game that would never have been possible in the shareware Clonk titles. However, gamepad controls are supported in the game and they work quite well considering that a gamepad doesn't have a pointing device.
However you can create your own keyboard-only control scheme based on the gamepad control scheme.

=== Are other Clonk games available as source code? ===
The source code for most older Clonk versions [http://www.clonk.de/source.php is available from Redwolf Design]. Here is a list of modified versions:
* [http://users.v-lo.krakow.pl/~anszom/clonk/index.en.shtml Linux port of Clonk Planet]
* [http://wiki.gp2x.org/wiki/Clonk2X Clonk Planet for GP2x]
* [http://www.goldwipf.de/ The GWE] ([http://www.ccan.de/cgi-bin/ccan/ccan-view.pl?a=view&i=5757 download from CCAN])

=== Is there an editor for OpenClonk? ===
Yes, the [http://wiki.openclonk.org/w/Developing_Content_with_Eclipse C4DT], the Clonk Development Tools for Eclipse, maintained by Mortimer. Eclipse is a powerful open source IDE that you will have heard of if you ever developed in Java. C4DT is a plugin for Eclipse that makes it possible to develop for Clonk in C4Script and even debug your code one-instruction-at-a-time using this powerful IDE.

The old explorer-like Editor.exe that you might know from Clonk Rage doesn't exist anymore in OpenClonk. However, the editor mode still exists for drawing and designing scenarios. Just start clonk with the commandline parameter ''--editor''.

For more information on how to develop content for the game, see the [[C4Script Documentation]].

=== How to develop for OpenClonk? ===
If you are looking to develop your own game content for or based on OpenClonk, have a look at the [[C4Script Documentation]], you should find everything there. See also a related FAQ answer: [[#Is there an editor for OpenClonk?|Is there an editor for OpenClonk?]]

If you are interested in getting involved and contributing to OpenClonk, this introduction on [[Development|development]] should make you happy :-).
For any other open questions regarding this, consider dropping by in our [http://forum.openclonk.org/ forum] or in our [irc://irc.euirc.net/openclonk IRC channel]!

=== What is the newest version? 5 or 3? ===
There has been some confusion regarding the version numbers of OpenClonk, so here is a little explanation: The full (''engine'') version number of for example OpenClonk 3.2 is 5.3.2 -
;5 = OpenClonk (the OC engine is a further development of [http://www.clonk.de/ Clonk Rage] which had 4 as it's first version number)
;3 = 3rd major release
;2 = 2nd update of the major release

=== Where can I report bugs? ===
In the [http://bugs.openclonk.org bugtracker].

=== How can I build OpenClonk myself? ===
Check out [[Build_OpenClonk|this tutorial]].