Skip to content

Build instructions

Edgar edited this page Mar 27, 2022 · 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

Windows

Create a dir, like C:\Cytopia. Open a visual Studio Command Prompt for your Visual Studio installation.

mkdir C:\Cytopia
cd C:\Cytopia
git clone https://github.com/CytopiaTeam/Cytopia.git .
mkdir build
cd build
cmake -G "Visual Studio 16 2019" -DCMAKE_BUILD_TYPE=RelWithDebInfo ..

Now launch your .sln file or run cmake --build .

MacOS

Prerequisites:

You need following programs to build Cytopia:

Install brew first:

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"

To install the prerequisites with brew, run following commands:

brew install git cmake conan

Clone the repository

Checkout the git repository

cd Cytopia
git clone https://github.com/CytopiaTeam/Cytopia.git
cd Cytopia

Build Instructions:

Create a cmake project.

mkdir build
cd build
cmake -DCMAKE_BUILD_TYPE=RelWithDebInfo ..

Build

cmake --build .

Optional steps:

To install the project,

cmake --build . --target install

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

cmake --build . --target package