Building with Linux - Revision history

Luchs: Release tarballs

2019-04-11T21:29:28Z

Release tarballs

← Older revision		Revision as of 21:29, 11 April 2019
Line 15:		Line 15:
	To get the sources, you need to clone our git repository. Enter the command		To get the sources, you need to clone our git repository. Enter the command

	$ git clone ~~git~~://~~git~~.openclonk~~.org~~/openclonk~~.git~~		$ git clone https://github.com/openclonk/openclonk

	''OpenClonk team members:'' Use "~~ssh~~://~~git@git~~.openclonk.org/openclonk.~~git" instead~~.		''OpenClonk team members:'' Use "git@github.com:openclonk/openclonk" instead.

			If you're trying to build a release, you can also use the tarballs from the [https://www.openclonk.org/builds/release/ download archive]:

			<code>
			$ wget https://www.openclonk.org/builds/release/6.1/openclonk-6.1-src.tar.bz2
			$ tar xf openclonk-6.1-src.tar.bz2
			</code>

			''Note'': This tutorial is written for the latest development version. Building older releases will work similarly, but the dependencies might differ. Check out the <kbd>README</kbd> file in the tarball to see the dependency list for that release.

	Congratulations, you now have the bleeding edge of OpenClonk development on your hard drive! There is 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:		Congratulations, you now have the bleeding edge of OpenClonk development on your hard drive! There is 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:

Luchs: Add note about installing

2019-04-11T21:16:48Z

Add note about installing

← Older revision		Revision as of 21:16, 11 April 2019
Line 78:		Line 78:

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

			= Installing =

			Once you've successfully built OpenClonk, you can run the binary directly from the repository checkout:

			<code>
			./openclonk
			</code>

			If you ran CMake in a separate build directory, you'll need to link the <kbd>planet</kbd> folder:

			<code>
			# /tmp/openclonk is the repository checkout.
			/tmp/openclonk/build $ ./openclonk
			[23:06:47] OpenClonk
			[...]
			[23:06:47] ExePath: "/tmp/openclonk/build/"
			[...]
			[23:06:47] Error opening system group file (System.ocg)!

			# Link the planet folder.
			/tmp/openclonk/build $ ln -s ../planet
			</code>

			You can also do a global installation in your system using the <kbd>install</kbd> target:

			<code>
			sudo make install
			# or if you selected the Ninja generator
			sudo ninja install
			</code>

			This will install everything into <kbd>/usr/local</kbd> per default. You can change this with the <kbd>CMAKE_INSTALL_PREFIX</kbd> setting:

			<code>
			# Install into ~/.local instead.
			cmake . -DCMAKE_INSTALL_PREFIX=$HOME/.local
			make install
			</code>

			OpenClonk should then appear in your desktop environment's application menu.

Marky: Moved the "in short version" to the top.

2018-12-19T22:18:49Z

Moved the "in short version" to the top.

← Older revision		Revision as of 22:18, 19 December 2018
Line 1:		Line 1:
			= 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 17.10, the use of <kbd>ninja</kbd> is optional):
			<code>
			# apt-get install git cmake build-essential libpng-dev libjpeg-dev ninja-build \
			libfreetype6-dev libglew-dev libreadline-dev libsdl2-dev libqt5widgets5 \
			qtbase5-dev libalut-dev libvorbis-dev libopenal-dev libdw-dev
			$ git clone https://github.com/openclonk/openclonk && cd openclonk && cmake . -GNinja && ninja openclonk
			</code>

			If you did it this way you can skip the rest of the tutorial. Otherwise, if you prefer using GUIs, have a look at the rest of this page.

	= Get the sources =		= Get the sources =

Line 66:		Line 78:

	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.		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 17.10, the use of <kbd>ninja</kbd> is optional):~~
	~~<code>~~
	~~# apt-get install git cmake build-essential libpng-dev libjpeg-dev ninja-build \~~
	~~libfreetype6-dev libglew-dev libreadline-dev libsdl2-dev libqt5widgets5 \~~
	~~qtbase5-dev libalut-dev libvorbis-dev libopenal-dev libdw-dev~~
	~~$ git clone https://github.com/openclonk/openclonk && cd openclonk && cmake . -GNinja && ninja openclonk~~
	~~</code>~~

K-Pone: /* In short */ fixed clone URL and apt-get call

2018-06-28T11:34:55Z

In short: fixed clone URL and apt-get call

← Older revision		Revision as of 11:34, 28 June 2018
Line 72:		Line 72:
	If you prefer doing things on the command line, this is a short alternate path to getting a working build (tested on Ubuntu 17.10, the use of <kbd>ninja</kbd> is optional):		If you prefer doing things on the command line, this is a short alternate path to getting a working build (tested on Ubuntu 17.10, the use of <kbd>ninja</kbd> is optional):
	<code>		<code>
	# apt install git cmake build-essential libpng-dev libjpeg-dev ninja-build \		# apt-get install git cmake build-essential libpng-dev libjpeg-dev ninja-build \
	libfreetype6-dev libglew-dev libreadline-dev libsdl2-dev libqt5widgets5 \		libfreetype6-dev libglew-dev libreadline-dev libsdl2-dev libqt5widgets5 \
	qtbase5-dev libalut-dev libvorbis-dev libopenal-dev libdw-dev		qtbase5-dev libalut-dev libvorbis-dev libopenal-dev libdw-dev
	$ git clone ~~git~~://~~git~~.openclonk~~.org~~/openclonk && cd openclonk && cmake . -GNinja && ninja openclonk		$ git clone https://github.com/openclonk/openclonk && cd openclonk && cmake . -GNinja && ninja openclonk
	</code>		</code>

Luchs: ubuntu packages => alut instead of SDL_mixer

2018-01-16T19:41:27Z

ubuntu packages => alut instead of SDL_mixer

← Older revision		Revision as of 19:41, 16 January 2018
Line 70:		Line 70:
	= In short =		= 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):		If you prefer doing things on the command line, this is a short alternate path to getting a working build (tested on Ubuntu 17.10, the use of <kbd>ninja</kbd> is optional):
	<code>		<code>
	# apt install git cmake build-essential libpng-dev libjpeg-dev ninja-build \		# apt install git cmake build-essential libpng-dev libjpeg-dev ninja-build \
	libfreetype6-dev libglew-dev libreadline-dev libsdl2-dev libqt5widgets5 \		libfreetype6-dev libglew-dev libreadline-dev libsdl2-dev libqt5widgets5 \
	qtbase5-dev ~~libsdl2~~-~~mixer~~-dev libdw-dev		qtbase5-dev libalut-dev libvorbis-dev libopenal-dev libdw-dev
	$ git clone git://git.openclonk.org/openclonk && cd openclonk && cmake . -GNinja && ninja openclonk		$ git clone git://git.openclonk.org/openclonk && cd openclonk && cmake . -GNinja && ninja openclonk
	</code>		</code>

Fulgen: /* Get Dependencies */

2017-08-13T10:20:47Z

Get Dependencies

← Older revision		Revision as of 10:20, 13 August 2017
Line 32:		Line 32:
	* libfreetype6-dev		* libfreetype6-dev
	* libjpeg-dev		* libjpeg-dev
			* libpng-dev
	* libglew-dev		* libglew-dev

Fulgen: /* Get Dependencies */

2017-08-13T10:18:12Z

Get Dependencies

← Older revision		Revision as of 10:18, 13 August 2017
Line 23:		Line 23:
	== Get Dependencies ==		== 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:		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 (they may have different names on your distribution):
	* libsdl2-dev		* libsdl2-dev
	* libopenal-dev		* libopenal-dev

Fulgen: /* Get CMake */

2017-08-13T10:17:22Z

Get CMake

← Older revision		Revision as of 10:17, 13 August 2017
Line 52:		Line 52:
	[[File:cmake-gui-linux.png]]		[[File:cmake-gui-linux.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.		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:		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:

Fulgen: /* Get the sources */

2017-08-13T10:16:31Z

Get the sources

← Older revision		Revision as of 10:16, 13 August 2017
Line 3:		Line 3:
	To get the sources, you need to clone our git repository. Enter the command		To get the sources, you need to clone our git repository. Enter the command

	~~<nowiki>~~$ git clone git://git.openclonk.org/openclonk.git~~</nowiki>~~		$ git clone git://git.openclonk.org/openclonk.git

	''OpenClonk team members:'' Use "ssh://git@git.openclonk.org/openclonk.git" instead.		''OpenClonk team members:'' Use "ssh://git@git.openclonk.org/openclonk.git" instead.

Fulgen: /* Get the sources */

2017-08-13T10:15:54Z

Get the sources

← Older revision		Revision as of 10:15, 13 August 2017
Line 1:		Line 1:
	= Get the sources =		= Get the sources =

	~~Let~~'~~s just assume~~ you ~~already~~ have the sources :p		To get the sources, you need to clone our git repository. Enter the command

			<nowiki>$ git clone git://git.openclonk.org/openclonk.git</nowiki>
			''OpenClonk team members:'' Use "ssh://git@git.openclonk.org/openclonk.git" instead.

			Congratulations, you now have the bleeding edge of OpenClonk development on your hard drive! There is 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 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 =		= Get it to Compile =