Go to file
Lukas Werling 952cfef497 Add missing C4Include include in C4ConsoleQtShapes
Qt's moc generates another source file that includes this header without
including C4Include.h first. The generates source file thus doesn't
compile. It is unclear to me why this isn't an issue with our current
build setup (it is an issue with a meson-based build).
2018-10-14 23:19:32 +02:00
cmake Drop broken GCC precompiled header support 2018-10-04 08:33:31 +02:00
docs Warn when using variables outside of their block 2018-07-23 12:12:23 +02: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 Save scenario: Disable all warnings in auto-generated file 2018-07-24 14:20:09 +02:00
src Add missing C4Include include in C4ConsoleQtShapes 2018-10-14 23:19:32 +02:00
tests Travis: Skip TCP bind test because of missing IPv6 support 2018-09-25 20:02:51 +02:00
thirdparty BLAKE2: Fall back to plain C implementation on non-amd64 platforms 2018-03-21 07:51:52 +01:00
tools Appveyor: Fix library bundling path 2018-10-08 20:57:39 +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 Fresh repository, fresh build on Windows, VS created these folders. Hope it's cool to put them on ignore. 2018-10-10 01:43:58 +02:00
.travis.yml Travis: Add update information for AppImage snapshots 2018-10-03 23:45:45 +02:00
CMakeLists.txt Drop broken GCC precompiled header support 2018-10-04 08:33:31 +02:00
COPYING Update all copyright notices for 2016 2016-04-03 20:24:42 +02: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
appveyor.yml Appveyor: Build on Visual Studio 2017 x64 only 2018-10-07 20:21:17 +02:00
config.h.cmake Add WITH_APPDIR_INSTALLATION configuration option 2018-09-24 19:22:32 +02:00
openclonk.appdata.xml Add a Linux AppData file. 2016-08-27 12:28:48 +02:00
openclonk.desktop Update openclonk.desktop 2018-02-12 16:08:47 +01: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.