Skip to content

Latest commit

 

History

History
101 lines (61 loc) · 5.4 KB

BUILD_WIN.md

File metadata and controls

101 lines (61 loc) · 5.4 KB
Raw

This is a stand-alone guide for creating your first High Fidelity build for Windows 64-bit.

Building High Fidelity

Note: We are now using Visual Studio 2017 and Qt 5.10.1. If you are upgrading from Visual Studio 2013 and Qt 5.6.2, do a clean uninstall of those versions before going through this guide.

Note: The prerequisites will require about 10 GB of space on your drive. You will also need a system with at least 8GB of main memory.

Step 1. Visual Studio 2017 & Python

If you don’t have Community or Professional edition of Visual Studio 2017, download Visual Studio Community 2017.

When selecting components, check "Desktop development with C++". Also on the right on the Summary toolbar, check "Windows 8.1 SDK and UCRT SDK" and "VC++ 2015.3 v140 toolset (x86,x64)". If you do not already have a python development environment installed, also check "Python Development" in this screen.

If you already have Visual Studio installed and need to add python, open the "Add or remove programs" control panel and find the "Microsoft Visual Studio Installer". Select it and click "Modify". In the installer, select "Modify" again, then check "Python Development" and allow the installer to apply the changes.

Step 1a. Alternate Python

If you do not wish to use the Python installation bundled with Visual Studio, you can download the installer from here. Ensure you get version 3.6.6 or higher.

Step 2. Installing CMake

Download and install the latest version of CMake 3.9.

Download the file named win64-x64 Installer from the CMake Website. You can access the installer on this 3.9 Version page. During installation, make sure to check "Add CMake to system PATH for all users" when prompted.

Step 3. Installing Qt

Download and install the Qt Open Source Online Installer. While installing, you only need to have the following components checked under Qt 5.10.1: "msvc2017 64-bit", "Qt WebEngine", and "Qt Script (Deprecated)".

Note: Installing the Sources is optional but recommended if you have room for them (~2GB).

Step 4. Setting Qt Environment Variable

Go to Control Panel > System > Advanced System Settings > Environment Variables > New... (or search “Environment Variables” in Start Search).

  • Set "Variable name": QT_CMAKE_PREFIX_PATH
  • Set "Variable value": C:\Qt\5.10.1\msvc2017_64\lib\cmake

Step 5. Installing vcpkg

  • Clone the VCPKG repository
  • Follow the instructions in the readme to bootstrap vcpkg
    • Note, you may need to do these in a Developer Command Prompt
  • Set an environment variable VCPKG_ROOT to the location of the cloned repository
    • Close and re-open any command prompts after setting the environment variable so that they will pick up the change

Step 6. Installing OpenSSL via vcpkg

  • In the vcpkg directory, install the 64 bit OpenSSL package with the command .\vcpkg install openssl:x64-windows
  • Once the build completes you should have a file ssl.h in ${VCPKG_ROOT}/installed/x64-windows/include/openssl

Step 7. Running CMake to Generate Build Files

Run Command Prompt from Start and run the following commands:

cd "%HIFI_DIR%"
mkdir build
cd build
cmake .. -G "Visual Studio 15 Win64"

Where %HIFI_DIR% is the directory for the highfidelity repository.

Step 8. Making a Build

Open %HIFI_DIR%\build\hifi.sln using Visual Studio.

Change the Solution Configuration (menu ribbon under the menu bar, next to the green play button) from "Debug" to "Release" for best performance.

Run from the menu bar Build > Build Solution.

Step 9. Testing Interface

Create another environment variable (see Step #4)

  • Set "Variable name": _NO_DEBUG_HEAP
  • Set "Variable value": 1

In Visual Studio, right+click "interface" under the Apps folder in Solution Explorer and select "Set as Startup Project". Run from the menu bar Debug > Start Debugging.

Now, you should have a full build of High Fidelity and be able to run the Interface using Visual Studio. Please check our Docs for more information regarding the programming workflow.

Note: You can also run Interface by launching it from command line or File Explorer from %HIFI_DIR%\build\interface\Release\interface.exe

Troubleshooting

For any problems after Step #7, first try this:

  • Delete your locally cloned copy of the highfidelity repository
  • Restart your computer
  • Redownload the repository
  • Restart directions from Step #7

CMake gives you the same error message repeatedly after the build fails

Remove CMakeCache.txt found in the %HIFI_DIR%\build directory.

CMake can't find OpenSSL

Remove CMakeCache.txt found in the %HIFI_DIR%\build directory. Verify that your VCPKG_ROOT environment variable is set and pointing to the correct location. Verify that the file ${VCPKG_ROOT}/installed/x64-windows/include/openssl/ssl.h exists.

Qt is throwing an error

Make sure you have the correct version (5.10.1) installed and QT_CMAKE_PREFIX_PATH environment variable is set correctly.