Skip to content

Build instructions

JimmySnails edited this page Mar 10, 2020 · 13 revisions

General

This project uses CMake to manage the build. Please make sure you have installed at least version 3.9 or later. To build the project, create a new build directory, then:

cmake <PATH_TO_REPOSITORY>

Note: If you're on windows, you might want to specify a generator for Visual Studio, like:

cmake -G "Visual Studio 15 2017 Win64"<PATH_TO_REPOSITORY>

This will download all the required dependencies and configure the build.

If you want to build the TileData editor and you don't have a QT installation, you can enable it with CONAN_QT

Note: If you want to change your install directory (per default it's set to ../install) add the definition -DCMAKE_INSTALL_PREFIX=/foo/bar to your cmake call.

Prerequisites: To build Windows MSI packages, you need to install the WiX toolset. https://wixtoolset.org/releases/

Build Instructions: Once the build is configured, you can then compile it using:

cmake --build .

To install the project,

cmake --build . --target install

Create a package (MSI, RPM, DEB, DMG, ZIP)

cmake --build . --target package

MacOS

Prerequisites: Download and install following programs:

To install the prerequisites with brew, run following commands: brew install git brew install cmake brew install conan

Build Instructions: Once the build is configured, you can then compile it using:

cmake --build .

To install the project,

cmake --build . --target install

Create a package (MSI, RPM, DEB, DMG, ZIP)

cmake --build . --target package