Go to file
Nicolas Hake 185c82fd1c Enable cross-compilation to Darwin/Mac OS X
This set of changes make it possible to do a cross build targeting Mac
OS X 10.9 ("Mavericks") from a Linux host. Tools required for a build
(in addition to the standard build toolchain, obviously): otool,
install_name_tool, c4group.

Since CMake does not (yet?) support passing environment variables to
custom build commands, you should make sure to have the
INSTALL_NAME_TOOL and OTOOL variables set to reasonable values during
the entire build. Additionally, if you have not unpacked your OS X SDK
directly into the root directory (you probably shouldn't), you need to
set the SYSROOT environment variable to the root of the SDK (the
directory containing the "System" directory). Setting up a CMake
toolchain file is left as an exercise to the reader.
2015-01-25 01:23:20 +01:00
cmake Remove some OSX-specific hacks from the main CMakeLists 2015-01-23 17:15:56 +01:00
docs fix typo which makes docs compile again 2015-01-19 16:02:00 +01: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 DarkCastle: Fix cannoneer grabbing cannon in intro. (#1248) 2015-01-22 20:44:01 +01:00
src OSX: Fix capitalization of several imports and includes 2015-01-23 18:24:31 +01: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 OSX: Bundle libraries even when not compiling with XCode 2015-01-24 23:28:33 +01: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 OSX: Bundle libraries even when not compiling with XCode 2015-01-24 23:28:33 +01: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 OSX: Stop pretending to support 10.6 and i386 2015-01-23 23:52:46 +01:00
TRADEMARK Update copyright notices 2013-12-23 13:03:19 +01:00
Version.txt reduce version numbering from x.y.z (x does never changes) to y.z 2014-12-12 21:57:52 +01:00
config.h.cmake Merge all of the audio provider switches into one 2014-08-01 23:37:42 +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/)
  - Boost (http://www.boost.org/users/download/)

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, 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.