polycode-engine/BUILD.md

Building Polycode and dependencies

Polycode uses a CMake build generator for automatically downloading and building required 3rd party packages and Polycode itself. Polycode is setup for preferring custom static libraries over system ones, so please use the dependency build system even if you have all of the dependencies installed on your computer.

The first dependency is CMake. It can be downloaded from http://cmake.org/cmake/resources/software.html or installed using apt or rpm on most Linux distributions. CMake 2.8.4 or greater is recommended.

Building dependencies

Polycode depends on a number of third party packages that are not included in the Polycode source tree:

• Lua
• Freetype
• zlib
• libpng
• PhysicsFS
• Ogg Vorbis
• OpenAL
• SDL
• Box2D
• Bullet Physics
• Assimp

The CMake dependency build system will download and install static version of these libraries into the Polycode source tree. It will NOT attempt to install any of these packages into your system.

All dependenices will be installed into the Polycode source tree under

Release/<Platform>/Framework/

Instructions describe using CMake on the command line, you may prefer to use the CMake GUI if unfamiliar with CMake.

Mac OS X and Xcode

To generate an Xcode project for building Polycode dependencies, perform the following steps in the Polycode directory from a terminal:

cd Dependencies
mkdir Build
cd Build
cmake -G Xcode ..

This generates a PolycodeDependencies Xcode project in the Build directory. Building this project in Xcode will download, build and install the dependencies (make sure you build the ALL_BUILD target). Note that you need to build both Debug and Release in Xcode

Note: Release is "Build for Archiving" in Xcode4.

Windows and Visual Studio

To generate a Microsoft Visual Studio (any version) project for building Polycode dependencies, perform the following steps in the Polycode directory from a command prompt (for VS2010):

cd Dependencies
mkdir Build
cd Build
cmake -G "Visual Studio 10" ..

This generates a PolycodeDependencies.sln in the Build directory. Building this project in Visual Studio will download, build and install the dependencies. Note that you need to build both Debug and Release in Visual Studio.

Unix Makefiles

To generate and build Debug and Release builds with Unix Makefiles perform the following steps in the Polycode directory from a terminal:

cd Dependencies
mkdir Build
cd Build
mkdir Debug
cd Debug
cmake -G "Unix Makefiles" -DCMAKE_BUILD_TYPE=Debug ../..
make
cd ..
mkdir Release
cd Release
cmake -G "Unix Makefiles" -DCMAKE_BUILD_TYPE=Release ../..
make

Building Polycode

The Polycode CMake build will look for dependencies installed on the system and by the above dependency build step.

CMake variables

There are a number of CMake variables that can be used to control what is built. These can be passed into CMake on the comment line as -D= or edited in the CMake GUI. Things should build without setting any options, but not that some things (Lua bindings, for example) are disabled by default.

• POLYCODE_BUILD_BINDINGS
• POLYCODE_BUILD_EXAMPLES
• POLYCODE_BUILD_MODULES
• POLYCODE_BUILD_PLAYER
• POLYCODE_BUILD_TOOLS
• POLYCODE_INSTALL_FRAMEWORK
• POLYCODE_INSTALL_PLAYER

Mac OS X and Xcode

To generate an Xcode project for building Polycode, perform the following steps in the Polycode directory from a terminal:

mkdir Build
cd Build
cmake -G Xcode ..

This generates a Polycode Xcode project in the Build directory.

Build the "ALL_BUILD" target in this project in both Debug and Release and then build the "install" target, also in Debug and Release. This will install Polycode into the Release//Framework directory, which should mirror the binary download from the website and contain templates and examples that will build out of the box.

Windows and Visual Studio

To generate a Microsoft Visual Studio project for building Polycode, perform the following steps in the Polycode directory from a command prompt:

mkdir Build
cd Build
cmake -G "Visual Studio 10" ..

This generates a Polycode.sln in the Build directory.

Unix Makefiles

To generate and build Debug and Release builds with Unix Makefiles perform the following steps in the Polycode directory from a terminal:

mkdir Build
cd Build
mkdir Debug
cd Debug
cmake -G "Unix Makefiles" -DCMAKE_BUILD_TYPE=Debug ../..
make
cd ..
mkdir Release
cd Release
cmake -G "Unix Makefiles" -DCMAKE_BUILD_TYPE=Release ../..
make

TODO

It would be good to create a CMake build template for people to create new Polycode applications with.