Building on Windows

This is the guide for building on Windows using either Visual Studio 2015 or Qt Creator

Tools

git

Install git.

Visual Studio

Install Microsoft Visual Studio 2015 or later, then install the latest updates.

Qt

Install Qt for Windows 64-bit (VS 2015) 5.8 or later

Add system environment variable named QTPATH and point it to the location of the Qt folder. On a default install, this will be something like:

C:\Qt\5.8\msvc2015_64

Wix

To build the installer, you must have Wix installed. If you are unconcerned with it, you can skip this step and just dismiss the warning that shows when opening the solution later. It’s recommended you ignore the installer since official builds are provided on this page.

Obtaining source

This project

Open up the Visual Studio x64 Native Tools Command Prompt.

Create a new folder in your development area named fractorium:

mkdir fractorium
cd fractorium
git clone https://mfeemster@bitbucket.org/mfeemster/fractorium.git

Prerequisites

There are six prerequisite dependencies. Two of them must be downloaded manually:

libjpeg

tbb (Intel provides executable only releases in addition to open source releases. You must get the open source release)

Extract them into the folder you created such that they are arranged like so:

[fractorium]
 │
 ├─libjpeg
 ├─tbb

Go into the fractorium folder and run this script which will get the rest of the prerequisites from git and build them:

cd fractorium
makedeps.bat

This will download and build

glm libpng libxml zlib

You will have a folder structure like this:

[fractorium]
│ 
├─glm
├─libjpeg
├─libpng
├─libxml2
├─tbb
└─fractorium
 │
 ├─Deps
 │
 ├─libjpeg.lib
 ├─libpng.lib
 ├─libxml2.lib
 ├─libxml2.dll
 ├─tbb.dll
 ├─tbb.lib
 ├─zlib.lib

Building with Qt Creator or Visual Studio

Begin build with Qt Creator

Open the Qt Project fractorium/main.pro using Qt Creator with the default configuration of Desktop Qt [version] MSVC2015 64bit.

Make sure Shadow build in Edit build configuration for both Debug and Release is unchecked.

Switch to the Release configuration.

Under Build Steps, add an additional argument of install to the make command to force all dependencies to be copied to the output folder. The final make command should look like:

jom.exe install in /path/to/fractorium

Ensure all projects are in the Release configuration and build main.pro.

The outputs will be placed in fractorium/Bin/release several minutes later if no error occurs.

Begin build with Visual Studio

Visual Studio Qt Addon

Install the Visual Studio Qt Addon.

Run Visual Studio and verify there is a menu item named Qt5. Click on it and click Qt Options.

Add a new Qt version to the list with the exact name of "Qt5", and set its path to the same as $QTPATH, which will be something like:

C:\Qt\5.8\msvc2015_64

The name "Qt5" must match exactly and this step must be completed before the Fractorium solution is opened. If not, the Qt add-in will completely ruin all solution and project files that use Qt.

Set the default version to the newly created Qt version and click Ok.

Open the file Fractorium.sln under Builds/MSVC/2015

Set the configuration to Release, and build all.

Outputs

The outputs will be the same whether Visual Studio or Qt Creator was used, however their locations will be different.

Qt Creator will place its outputs in:

fractorium/Bin/Release

and Visual Studio will place its outputs in:

fractorium/Bin/x64/Release

The output contents will be:

boxtail_pack_02.gradient
boxtail_pack_03_triangle.gradient
boxtail_pack_04_mineshack.gradient
dark.qss
ember.dll
ember.exp
ember.lib
emberanimate.exe
embercl.dll
embercl.exp
embercl.lib
embergenome.exe
emberrender.exe
fardareismai_pack_01_variety_number_128.gradient
fardareismai_pack_02_b_sides.gradient
fardareismai_pack_03_old_and_new.gradient
fardareismai_pack_04_hoard.gradient
flam3-palettes.xml
fractaldesire_pack_01.gradient
fractorium.exe
libxml2.dll
Qt5Core.dll
Qt5Gui.dll
Qt5Widgets.dll
rce_ordinary_pack_01_colornation.gradient
tatasz_pack_01.gradient
tatasz_pack_02_colder.gradient
tatasz_pack_02_dark.gradient
tatasz_pack_02_warmer.gradient
tatasz_pack_03.gradient
tbb.dll
platforms\qwindows.dll

Double click fractorium.exe to run it, and use the command line to run the others.

To run on a computer without Visual Studio 2015, these files also need to be in the folder:

MSVC2015\VC\redist\x64\Microsoft.VC140.CRT\msvcp140.dll
MSVC2015\VC\redist\x64\Microsoft.VC140.CRT\vcruntime140.dll
MSVC2015\VC\redist\x64\Microsoft.VC140.CRT\vccorlib140.dll
MSVC2015\VC\redist\x64\Microsoft.VC140.CRT\concrt140.dll

or you can install Visual C++ Redistributable Packages for Visual Studio 2015 (64 bit)

Final file structure for distribution

[YOUR FOLDER]
 │
 ├─ boxtail_pack_02.gradient
 ├─ boxtail_pack_03_triangle.gradient
 ├─ boxtail_pack_04_mineshack.gradient
 ├─ dark.qss
 ├─ ember.dll
 ├─ emberanimate.exe
 ├─ embercl.dll
 ├─ embergenome.exe
 ├─ emberrender.exe
 ├─ fardareismai_pack_01_variety_number_128.gradient
 ├─ fardareismai_pack_02_b_sides.gradient
 ├─ fardareismai_pack_03_old_and_new.gradient
 ├─ fardareismai_pack_04_hoard.gradient
 ├─ flam3-palettes.xml
 ├─ fractaldesire_pack_01.gradient
 ├─ fractorium.exe
 ├─ libxml2.dll
 ├─ Qt5Core.dll
 ├─ Qt5Gui.dll
 ├─ Qt5Widgets.dll
 ├─ rce_ordinary_pack_01_colornation.gradient
 ├─ tatasz_pack_01.gradient
 ├─ tatasz_pack_02_colder.gradient
 ├─ tatasz_pack_02_dark.gradient
 ├─ tatasz_pack_02_warmer.gradient
 ├─ tatasz_pack_03.gradient
 ├─ tbb.dll
 │
 ├─ msvcp140.dll (optional)
 ├─ vcruntime140.dll (optional)
 ├─ vccorlib140.dll (optional)
 ├─ concrt140.dll (optional)
 │
 └─platforms
 │
 ├─qwindows.dll