Go to file
Nicolas Hake 5abc112a81 CMake: Split GTK3 tests into a separate module
Nobody uses pkg-config on Windows, and we already have a perfectly
viable solution for finding libraries - it's called CMake. We're still
defering to pkg-config when it exists because who knows what arcane
cflags might be required on some systems.
2015-10-19 16:11:12 +02:00
cmake CMake: Split GTK3 tests into a separate module 2015-10-19 16:11:12 +02:00
docs documented GetPlayerControlState 2015-10-15 18:05:21 +02:00
include/c4script C4Script: Allow executing strings from cmdline instead of only files 2015-09-04 13:40:27 +02:00
licenses Update copyright notices 2013-12-23 13:03:19 +01:00
masterserver Revert engine-side league localization 2014-04-27 15:42:47 +02:00
planet Enable basic shading in non-FoW viewports 2015-10-18 17:15:18 -04:00
src Fix a free/delete/g_free mismatch 2015-10-18 14:45:52 -04:00
tests Tests: Link winmm 2015-02-08 15:05:14 +01:00
thirdparty CMake: Split GTK3 tests into a separate module 2015-10-19 16:11:12 +02:00
tools Installer: Remove old Tutorial.ocf folder on installation. 2015-09-13 09:34:46 -04:00
.git_archival Prepare build for Git repository 2012-11-20 22:23:59 +01:00
.gitattributes Hard-code line endings of shell scripts to LF 2015-02-23 11:54:37 +01:00
.gitignore Git: Ignore NativeToolsExport.cmake 2015-05-27 22:42:46 +02:00
.travis.yml Add Travis CI integration 2015-02-23 13:39:50 +01:00
CMakeLists.txt CMake: Split GTK3 tests into a separate module 2015-10-19 16:11:12 +02:00
COPYING Point out that the source code license is the ISC license 2015-03-15 20:18:27 +01:00
Credits.txt update credits 2014-10-03 18:54:57 +02:00
README Drop support for GTK+ 2 2015-10-18 14:45:52 -04:00
TRADEMARK Update TRADEMARK and add trademark reference to credits (#1370) 2015-08-09 19:20:53 +02:00
Version.txt Bump version to 7.0-alpha0 2015-05-21 23:09:02 +02:00
config.h.cmake Remove unused feature support test macros 2015-10-12 17:34:29 +02:00
openclonk.desktop Register clonk:// protocol handler on Linux 2014-12-26 21:48:17 +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++11. That said, on Windows, we recommend using Microsoft Visual C++
2010 or higher; the Express edition will be sufficient. On Linux, you will
be fine with GNU g++ 4.6 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/)

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:
  - GTK+ 3.4 or greater (http://www.gtk.org)
  - libGL (http://www.mesa3d.org/)
  - SDL 1.2 (http://www.libsdl.org/download-1.2.php)
  - SDL_mixer 1.2 (http://www.libsdl.org/projects/SDL_mixer/release-1.2.html)
  - libupnp
  - libxrandr
Most distributions should provide these dependencies via their packaging
system. For Debian based distributions, you will need these packages:
  build-essential cmake imagemagick libfreetype6-dev libgl1-mesa-dev
  libglew-dev libgtk-3-dev libjpeg-dev libpng-dev libsdl1.2-dev
  libsdl-mixer1.2-dev libupnp-dev libxrandr-dev x11proto-core-dev
  zlib1g-dev
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.