OpenClonk Wiki - User contributions [en]

Release Steps

2018-04-02T23:39:14Z

Caesar: /* After Release */ Add step for flathub.

__NOTOC__
This page contains all steps to release a new version of OpenClonk and is meant for developers to check whether all steps have been considered.

=== Before Release ===

Steps to do before the release, and after the feature freeze.

* If releasing from a stable branch: make sure all relevant commits have been cherry-picked from master.
* Fix all bugs related to this release, which can be found in the bugtracker's [http://bugs.openclonk.org/roadmap_page.php roadmap].
* Go the [http://londeroth.org/~ck/oc-release/oc-release.cgi release button] and perform a dry release to create a release candidate.
* Test this release candidate with few simple tests: download, check installer content, run game, play game, play network game.

=== Release ===

If it is made sure that the current [https://git.openclonk.org/openclonk.git master branch] or the current stable branch does not contain any bugs one can initiate the release procedure.

* Optional: Update all Version.txt files and Version= entries in planet/ to the new version number.
* '''Update the Version.txt''' to the new version number and put the extra version in Version.txt to FALSE. Commit and push.
* Then go to the '''[http://londeroth.org/~ck/oc-release/oc-release.cgi release button]''' and release from the correct branch.

=== After Release ===

* '''Create a tag''' for the released changeset with the vX.Y tag (lightweight: git tag vX.Y). '''Only push''' the tag if sure the release has worked.
* '''Create a stable branch''' named stable-X for bugfix releases (if not already created).
* '''Make announcements''' in our blog and in our forum.
* Notify an openclonk.org admin to '''transfer the [https://git.openclonk.org/openclonk.git/archive/ source package]''' to www.openclonk.org/builds/release/X.Y/openclonk-X.Y-src.tar.bz2.
* Notify an openclonk.org admin to '''mark this version as released in the bugtracker''' and add the next version to the roadmap.
* '''Notify our Linux package maintainers''' for [https://packages.debian.org/de/sid/openclonk Debian], [https://aur.archlinux.org/packages/openclonk/ Arch], [http://www.freshports.org/games/openclonk/ FreeBSD] and [http://www.openclonk.org/download/ others] that a new version has been released.
* Update [https://github.com/flathub/org.openclonk.OpenClonk flathub] (Caesar is the main maintainer, Luchs should have write access.)

=== Optional ===

* '''Update external websites''': [http://gamejolt.com/games/platformer/openclonk/44187/ Game Jolt], [http://en.wikipedia.org/wiki/OpenClonk wikipedia article],[https://www.reddit.com/r/freegames/ reddit/freegames], [https://www.youtube.com/user/OpenClonkProject YouTube].
* Spread the word! More advertisement!

Building with Linux

2017-08-13T09:57:08Z

Caesar: /* In short */ formatting

= Get the sources =

Let's just assume you already have the sources :p

= 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 the Compiler Tools ==

Before you can start building an executable, you will need some more tools:
* make, gcc for building (this may be part of your Linux distribution already)

== 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. Simply get the following packages:
* libsdl2-dev
* libopenal-dev
* libminiupnpc-dev
* libgl1-mesa-dev (will most likely be already installed after you got libsdl2-dev)
* libxrandr-dev (will most likely be installed already after you got libsdl2-dev)
* qtbase5-dev
* libfreetype6-dev
* libjpeg-dev
* libglew-dev

== 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 you need 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, and having all those project files next to each other would become a problem in the long run.

Get the cmake package.

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, most likely the "Unix Makefile" will be the one that you need.

[[File:build_windows_cmake4.png]]

If you get some error messages (in red), you're probably missing some dependencies. Cmake will tell you which ones are missing, and you just need to install those, too.

Repeat the "Configure" step, until Cmake no longer gives you error messages. It may still show you some missing paths, but that shouldn't affect you:

The last step is to click the "Generate" button. If you can click "Generate" and you do not get an error message, you're good.

== Your First Build ==

Okay, now we have everything needed to make OpenClonk run for the first time. Open a terminal in the build directory that you configured in cmake, where the makefiles are located now. Enter the command

make -j$(nproc)

You could simply call make, but it will take a little longer to compile then: Instead, we start $(nproc) parallel jobs, where $(nproc) will be substituted by the amount of threads your processor can handle.

= In short =

If you prefer doing things on the command line, this is a short alternate path to getting a working build (tested on Ubuntu 16.04, the use of <kbd>ninja</kbd> is optional):
<code>
# apt install git cmake build-essential libpng-dev libjpeg-dev ninja-build \
libfreetype6-dev libglew-dev libreadline-dev libsdl2-dev libqt5widgets5 \
qtbase5-dev libsdl2-mixer-dev libdw-dev
$ git clone git://git.openclonk.org/openclonk && cd openclonk && cmake . -GNinja && ninja openclonk
</code>

Building with Linux

2017-08-13T09:55:26Z

Caesar: /* In short */ Make it a bit clearer that this is orthogonal to the rest of the guide

= Get the sources =

Let's just assume you already have the sources :p

= 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 the Compiler Tools ==

Before you can start building an executable, you will need some more tools:
* make, gcc for building (this may be part of your Linux distribution already)

== 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. Simply get the following packages:
* libsdl2-dev
* libopenal-dev
* libminiupnpc-dev
* libgl1-mesa-dev (will most likely be already installed after you got libsdl2-dev)
* libxrandr-dev (will most likely be installed already after you got libsdl2-dev)
* qtbase5-dev
* libfreetype6-dev
* libjpeg-dev
* libglew-dev

== 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 you need 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, and having all those project files next to each other would become a problem in the long run.

Get the cmake package.

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, most likely the "Unix Makefile" will be the one that you need.

[[File:build_windows_cmake4.png]]

If you get some error messages (in red), you're probably missing some dependencies. Cmake will tell you which ones are missing, and you just need to install those, too.

Repeat the "Configure" step, until Cmake no longer gives you error messages. It may still show you some missing paths, but that shouldn't affect you:

The last step is to click the "Generate" button. If you can click "Generate" and you do not get an error message, you're good.

== Your First Build ==

Okay, now we have everything needed to make OpenClonk run for the first time. Open a terminal in the build directory that you configured in cmake, where the makefiles are located now. Enter the command

make -j$(nproc)

You could simply call make, but it will take a little longer to compile then: Instead, we start $(nproc) parallel jobs, where $(nproc) will be substituted by the amount of threads your processor can handle.

= In short =

If you prefer doing things on the command line, this is a short alternate path to getting a working build (tested on Ubuntu 16.04, the use of <code>ninja</code> is optional):
<code>
# apt install git cmake build-essential libpng-dev libjpeg-dev ninja-build \
libfreetype6-dev libglew-dev libreadline-dev libsdl2-dev libqt5widgets5 \
qtbase5-dev libsdl2-mixer-dev libdw-dev
$ git clone git://git.openclonk.org/openclonk && cd openclonk && cmake . -GNinja && ninja openclonk
</code>

Building with Linux

2017-08-13T07:19:10Z

Caesar: Add short console version

= Get the sources =

Let's just assume you already have the sources :p

= 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 the Compiler Tools ==

Before you can start building an executable, you will need some more tools:
* make, gcc for building (this may be part of your Linux distribution already)

== 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. Simply get the following packages:
* libsdl2-dev
* libopenal-dev
* libminiupnpc-dev
* libgl1-mesa-dev (will most likely be already installed after you got libsdl2-dev)
* libxrandr-dev (will most likely be installed already after you got libsdl2-dev)
* qtbase5-dev
* libfreetype6-dev
* libjpeg-dev
* libglew-dev

== 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 you need 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, and having all those project files next to each other would become a problem in the long run.

Get the cmake package.

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, most likely the "Unix Makefile" will be the one that you need.

[[File:build_windows_cmake4.png]]

If you get some error messages (in red), you're probably missing some dependencies. Cmake will tell you which ones are missing, and you just need to install those, too.

Repeat the "Configure" step, until Cmake no longer gives you error messages. It may still show you some missing paths, but that shouldn't affect you:

The last step is to click the "Generate" button. If you can click "Generate" and you do not get an error message, you're good.

== Your First Build ==

Okay, now we have everything needed to make OpenClonk run for the first time. Open a terminal in the build directory that you configured in cmake, where the makefiles are located now. Enter the command

make -j$(nproc)

You could simply call make, but it will take a little longer to compile then: Instead, we start $(nproc) parallel jobs, where $(nproc) will be substituted by the amount of threads your processor can handle.

= In short =

On a stock Ubuntu 16.04, the following was enough to get a working build:
<code>
# apt install git cmake build-essential libpng-dev libjpeg-dev ninja-build \
libfreetype6-dev libglew-dev libreadline-dev libsdl2-dev libqt5widgets5 \
qtbase5-dev libsdl2-mixer-dev libdw-dev
$ git clone git://git.openclonk.org/openclonk && cd openclonk && cmake . -GNinja && ninja openclonk
</code>