Go to file
Tobias Zwick a04a1b697b fix game does not initialize when OS runs for longer than 30 days or so.
Special thanks to Yshxod for having the patience and debugging the game with me!
2014-01-28 00:04:31 +07:00
cmake Update copyright notices 2013-12-23 13:03:19 +01:00
docs fix some documentation bugs 2014-01-22 14:00:05 +07: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 register new version at masterserver: fix php script 2014-01-27 22:09:00 +07:00
planet Remove triangles from windmills in Windmill.ocs. 2014-01-26 17:39:11 +01:00
src fix game does not initialize when OS runs for longer than 30 days or so. 2014-01-28 00:04:31 +07:00
tests cmake: properly removed gtest from the all target 2013-01-30 13:06:22 +01:00
thirdparty Fix timsort so that it compiles with Visual Studio 2012-02-01 23:03:29 +01:00
tools cmake: Insert hacks and hardcoded paths to make mac version compilable using Unix make 2014-01-27 14:22:22 +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 Fix line endings broken by 71b3afb 2013-11-08 01:11:14 +01:00
CMakeLists.txt cmake: Insert hacks and hardcoded paths to make mac version compilable using Unix make 2014-01-27 14:22:22 +01:00
COPYING Update copyright notices 2013-12-23 13:03:19 +01:00
Credits.txt update credits screen 2014-01-24 15:33:47 +07:00
README Replace ancient README files with a not quite as ancient one 2013-12-25 22:18:43 +01:00
TRADEMARK Update copyright notices 2013-12-23 13:03:19 +01:00
Version.txt correct version to 5.4.0 2014-01-27 00:24:16 +07:00
config.h.cmake Remove remains of Direct3D support 2013-11-02 21:39:34 +01: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/openclonk/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:
  - libxpm
  - libGL
  - 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)
Most distributions should provide these dependencies via their packaging
system. For Debian based distributions, you will need these packages:
    build-essential cmake libx11-dev libxxf86vm-dev libxrandr-dev libxpm-dev
    libglew-dev libgl1-mesa-dev libpng12-dev libsdl1.2-dev
    libsdl-mixer1.2-dev libgtk2.0-dev libjpeg8-dev zlib1g-dev libboost-dev
(This list was compiled on Debian 7.0 "Wheezy". More recent distributions may
provide packages with a higher version number.)

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/). makensis needs to be in the PATH, and
the DLLs used by openclonk must be in the build directory. To create the
installer, build the "setup" target.