Go to file
Lukas Werling fa78b98312 Change alut includes to <AL/alut.h>
Alut's pkg-config definition only adds the top-level include directory
containing the AL directory to the include paths. This works on most
platforms because OpenAL adds that AL directory. However, with nix,
these two directories are distinct and the build fails.
2017-05-10 16:04:22 +02:00
cmake CMake: Add date of commit to logfile 2017-04-12 12:34:36 +02:00
docs Merge branch 'master' of ssh://git.openclonk.org/openclonk 2017-05-07 15:16:01 -04:00
include/c4script Add --check/-c parameter to c4script for syntax checking 2016-12-23 17:18:00 +01:00
licenses Use PCG as random number generator 2016-04-20 22:42:00 +02:00
masterserver Revert engine-side league localization 2014-04-27 15:42:47 +02:00
planet Editor: Add translation overview table (Tools menu) 2017-05-09 22:43:56 -04:00
src Change alut includes to <AL/alut.h> 2017-05-10 16:04:22 +02:00
tests C4Script: Add ParseInt function 2017-04-11 14:21:25 +02:00
thirdparty Backward: Also print stack trace to OpenClonk.log 2017-03-21 20:18:00 +01:00
tools OS X: Make bundling of libraries recursion-safe (#1818) 2016-09-04 14:11:51 +02:00
.git_archival CMake: Add date of commit to logfile 2017-04-12 12:34:36 +02:00
.gitattributes Hard-code line endings of shell scripts to LF 2015-02-23 11:54:37 +01:00
.gitignore .gitignore 2016-10-22 17:42:23 +02:00
.travis.yml Remove separate c4value_test 2017-02-21 19:25:21 +01:00
CMakeLists.txt Editor: Add translation overview table (Tools menu) 2017-05-09 22:43:56 -04:00
COPYING Update all copyright notices for 2016 2016-04-03 20:24:42 +02:00
Credits.txt Correct the spelling of my name in Credits.txt 2016-01-17 13:49:57 +01:00
README Update dependency list in README 2016-11-10 22:19:58 +01:00
TRADEMARK Update TRADEMARK and add trademark reference to credits (#1370) 2015-08-09 19:20:53 +02:00
Version.txt increase version to 8.0 alpha 2016-01-23 19:56:53 +01:00
config.h.cmake Use backward-cpp on Linux for nicer stack traces 2017-03-21 20:17:55 +01:00
openclonk.appdata.xml Add a Linux AppData file. 2016-08-27 12:28:48 +02:00
openclonk.desktop Add OpenClonk to StrategyGame and ArcadeGame categories. 2016-05-29 09:39:17 +02:00
scriptdefinitionsources.txt scriptdefinitionsources.txt: list of source files that contain definitions relevant to script (C4DT reads it) 2012-05-01 14:34:27 +02:00

README

Requirements
============
You should be able to build OpenClonk with any C++ compiler that supports
ISO C++14. That said, on Windows, we recommend using Microsoft Visual C++
2015 or higher; the Express edition will be sufficient. On Linux, you will
be fine with GNU g++ 4.9 or later. Apple users should use a clang-based
XCode version.

To generate project files for your chosen build system, you will also have to
install CMake from http://www.cmake.org/.

Additionally, OpenClonk depends on a number of third-party libraries:
  - zlib (http://zlib.net/)
  - libpng (http://www.libpng.org/pub/png/libpng.html)
  - libjpeg-turbo (http://sourceforge.net/projects/libjpeg-turbo/files/)
  - FreeType (http://www.freetype.org/)
  - The OpenGL Extension Wrangler Library (http://glew.sourceforge.net/)
  - FreeALUT (https://github.com/vancegroup/freealut)
  - libogg and libvorbis (https://www.xiph.org/downloads/)
  - Qt >= 5.7 (https://www.qt.io/download-open-source/)

OS X Specific
=============
OpenClonk supports OS X versions 10.8 "Mountain Lion" and later.
If you are using brew (https://github.com/mxcl/homebrew) or MacPorts
(http://www.macports.org/), the packages you'll have to install are:
    libjpeg, libpng, freetype, glew, libogg, libvorbis

Linux Specific
==============
For building OpenClonk on Linux, you need the following libraries in addition
to the ones listed above:
  - SDL 2.0 (https://www.libsdl.org/download-2.0.php)
  - libGL (http://www.mesa3d.org/)
  - OpenAL Soft >= 1.13 (https://github.com/kcat/openal-soft)
  - miniupnpc (http://miniupnp.free.fr/)
  - libxrandr
Most distributions should provide these dependencies via their packaging
system. At least gcc-4.9 is required.

Windows Specific
================
In addition to the libraries above, you will need one more if you want to
target Windows:
  - OpenAL Soft (http://kcat.strangesoft.net/openal.html)
To create an installer, you will also need the Nullsoft Install System
(http://nsis.sourceforge.net/). To create the installer, build the "setup" target.