# Building for Windows


 > * [Requirements](#requirements)
 > * [Locations and Environment Variables](#locs_and_envs)
 > * [Building](#features)
 > * [Using with QtCreator](#qt_creator)
 > * [Using with Visual Studio](#visual_studio)

<a name="requirements"></a>
## Requirements

For compiling:

1. Microsoft Visual Studio (tested on 2017 Community)
2. Qt Framework (tested on 5.10 and 5.11)

Additionally, for fully building portable and installer release versions:
3. 7zip
4. Nullsoft Scriptable Install System (NSIS)

<a name="locs_and_envs"></a>
## Locations and Environment Variables

The following environmental variables are relevant for building the project.

| Environment Variable  | Purpose |
| --------------------  | ------------- |
| `QT_LOC`              | Path to your Qt `\bin\` folder.    |
| `VS_LOC`              | Path to your Visual Studio `vcvarsall.bat` file.  |
| `JOM_LOC`             | Path to an `.exe` of `jom.exe`. Usually installed with Qt. `jom` is a wrapper around `nmake` allowing more threads to be used. It is not required, but using `nmake`is slower. If `JOM_LOC` isn't defined, or the `.exe` can't be found `nmake` will be used by default.   |
| `ZIP_LOC`             | Path to your 7zip `.exe`. Both portable and installer will work.  |
| `NSIS_LOC`            | Path to your installation of NSIS containing the `makensis` file. Both portable and installer will work. |

If an environment variable isn't set a default value will be provided. The default values are shown in the table below.

| Environment Variable  | Default Value |
| --------------------  | ------------- |
| `QT_LOC`              | `"C:\Qt\5.11.1\msvc2017_64\bin\"`    |
| `VS_LOC`              | `"C:\Program Files (x86)\Microsoft Visual Studio\2017\Community\VC\Auxiliary\Build\vcvarsall.bat"`  |
| `JOM_LOC`             | `"C:\Qt\Tools\QtCreator\bin\jom.exe"`|
| `ZIP_LOC`             | `"C:\Program Files\7-Zip\7z.exe"`    |
| `NSIS_LOC`            | `"C:\Program Files (x86)\NSIS\"`     |

Additionally, these optional environment variables are supported.

| Environment Variable  | Purpose |
| --------------------  | ------------- |
| `BUILD_DEBUG`         | If set, a debug version will be built. The packaging script will not run with this var set.   |
| `BUILD_VSPROJ`        | If set, Visual Studio project files will be built.  |

Remember that there's a difference between an unset variable and a variable set to an empty string. `SET BUILD_DEBUG=""` does not unset the variable. You need to write `SET BUILD_DEBUG=`.

The `.dll` files necessary for a release build differ from those needed by a debug build. Therefore you need to make sure you run all scripts with `BUILD_DEBUG` either defined or undefined, depending on your needs.

<a name="building"></a>
## Building

With the programs above installed and environment variables set, go into the root folder of the repository and run `build_windows.cmd`. Compiled binaries along with everything needed to run portable will output to `.\bin\win64\AdvancedSettings\`.

<a name="qt_creator"></a>
## Using with QtCreator

Run `build_windows.cmd` once and fully build (packaging not necessary) the application. Open the `.pro` file in Qt Creator. A build and toolchain option should be marked in Qt Creator, with all others unmarked. If it isn't, set the directory to be the root repo directory. You should now be able to compile and run in Qt Creator without issues.

Notice that you may need to redeploy library files if you make large changes (run `build_scripts\win\deploy.cmd`).

Additionally, you can set Qt Creator to run `build_scripts\win\deploy.cmd` on compilation in order to ensure that the correct libraries are present. Remember to set or unset `BUILD_DEBUG` depending on your needs.

<a name="visual_studio"></a>
## Using with Visual Studio

Run `build_windows.cmd` once and fully build (packaging not necessary) the application with the `BUILD_VSPROJ` environment variable set. Open the newly created project file. If you compiled a release build (`BUILD_DEBUG` not set) change the build type to release in Visual Studio. You should be able to compile and run with Visual Studio without issues.

Notice that any new files you add or compiler settings you change will not be backported to the `.pro` file. Hence it is necessary to manually change the `.pro` file.

Notice that you may need to redeploy library files if you make large changes (run `build_scripts\win\deploy.cmd`).

Additionally, you can set Visual Studio to run `build_scripts\win\deploy.cmd` on compilation in order to ensure that the correct libraries are present. Remember to set or unset `BUILD_DEBUG` depending on your needs.