Go to file
Lukas Werling 99c14b5547 docs: Drop major version part from <version>s
The actual release names dropped the 5.x.x scheme long ago, so there is
no reason to keep it in the docs. It's extra confusing there because the
version is given as a two-part version (e.g. 5.1) most of the time, so
it looks like everything happened in OC 5.x, even though the change was
actually in OC x.0.
2018-03-24 23:13:08 +01:00
cmake Make cross-compiling work with GCC 6+ 2018-02-25 01:11:53 +01:00
docs docs: Drop major version part from <version>s 2018-03-24 23:13:08 +01: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 Fix axe 2018-03-22 22:12:00 +01:00
src Implement TCP Simultaneous Open for IPv6 2018-03-09 23:20:00 +01:00
tests Add C4NetIOTCP::Bind() for binding without connect 2018-03-07 17:30:58 +01:00
thirdparty BLAKE2: Fall back to plain C implementation on non-amd64 platforms 2018-03-21 07:51:52 +01:00
tools Deploy Qt libraries; fix platforms NSIS installer include 2018-02-12 21:44:18 -08: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 docs: Implement client-side search 2018-03-23 21:23:38 +01:00
.travis.yml Remove separate c4value_test 2017-02-21 19:25:21 +01:00
CMakeLists.txt Don't link openclonk-server with SDL and audio libraries 2018-03-09 23:10:11 +01:00
COPYING Squashed 'thirdparty/blake2/' content from commit beb75f451 2018-03-19 13:50:17 +01:00
Credits.txt Credits: Fix Kevin Zheng's name 2018-02-17 11:56: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 Bump version to 9.0 alpha 2018-01-31 21:08:32 +01:00
config.h.cmake Autodetect "/proc/self/exe"-equivalent on FreeBSD (#1999) 2018-02-17 12:41:16 +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.