Go to file
Tobias Zwick 600e02f6b4 update credits 2014-10-03 18:54:57 +02:00
cmake CMake: Rename OpenAL_LIBRARY to OpenAL_LIBRARIES for MSVC to be more consistent with the other platforms. 2014-09-29 23:07:05 +02:00
docs Implement setting for forced values of parameters in league games. 2014-10-03 14:02:28 +02:00
include/c4script Update copyright notices 2013-12-23 13:03:19 +01: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 update credits 2014-10-03 18:54:57 +02:00
src Implement setting for forced values of parameters in league games. 2014-10-03 14:02:28 +02:00
tests cmake: properly removed gtest from the all target 2013-01-30 13:06:22 +01:00
thirdparty Ship a fallback natupnp.h 2014-08-03 21:48:53 +02:00
tools add Settlement.ocf to the list of obsolete folders to be deleted on install 2014-10-03 17:50:26 +02:00
.git_archival Prepare build for Git repository 2012-11-20 22:23:59 +01:00
.gitattributes Prepare build for Git repository 2012-11-20 22:23:59 +01:00
.gitignore Add openclonk.manifest to .gitignore 2014-09-25 16:45:18 +02:00
CMakeLists.txt Added scenario achievements displayed as small symbols beside the scenario name in the startup selection screen. 2014-09-24 23:08:40 +02:00
COPYING Update copyright notices 2013-12-23 13:03:19 +01:00
Credits.txt update credits 2014-10-03 18:54:57 +02:00
README Update dependencies list in the README 2014-05-25 22:47:56 +02:00
TRADEMARK Update copyright notices 2013-12-23 13:03:19 +01:00
Version.txt Raise Version number to 5.4.99 2014-09-28 22:55:17 +02:00
config.h.cmake Merge all of the audio provider switches into one 2014-08-01 23:37:42 +02:00
openclonk.desktop Rename game binary to "openclonk" (#830) 2013-01-28 13:57:29 +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/)
  - Boost (http://www.boost.org/users/download/)

OS X Specific
=============
OpenClonk supports OS X versions 10.6 "Snow Leopard" and later. You can build
universal binaries by setting CMAKE_OSX_ARCHITECTURES to "x86_64 i386", but
you will of course need universal versions of the dependencies in that case.
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, boost

Linux Specific
==============
For building OpenClonk on Linux, you need the following libraries in addition
to the ones listed above:
  - GTK+ 2.0 or 3.0 (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 libboost-dev libboost-regex-dev
  libfreetype6-dev libgl1-mesa-dev libglew-dev libgtk2.0-dev libjpeg-dev
  libpng-dev libsdl1.2-dev libsdl-mixer1.2-dev libupnp-dev libxrandr-dev
  x11proto-core-dev zlib1g-dev

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.