Build instructions without Conan
Some of our resources are stored in a git submodule.
We recommend to add the
--recursive parameter during git clone or init
To build the TileData editor, you will need a qt installation for your build environment.
For already cloned repositories, use to get the submodules.
git submodule update --init --recursive
On Windows, download and install the qt installer and select the appropriate environment during installation (e.g. mscv
and set the environment variable Qt5_DIR to your installation directory.
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:
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>
cmake -DCMAKE_BUILD_TYPE=Release -DUSE_PACKAGE_MANAGER=Off ../Cytopia/
This will configure the build. If any dependencies are missing, you will receive an error here.
If you are using Windows and have manually installed SDL2, you will need to update your PATH environment variable to point to it.
On macOS, you have to provide SDL Libraries. This can be done via brew:
- Install brew (https://brew.sh/)
- Install SDL Libraries
brew install sdl2 sdl2_image sdl2_mixer sdl2_ttf
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.
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