Skip to content

config_windows.md

Latest commit

 

History

History
82 lines (52 loc) · 3.84 KB

config_windows.md

File metadata and controls

82 lines (52 loc) · 3.84 KB

Building Open RV on Windows

Summary

  1. Install Microsoft Visual Studio
  2. Install Qt
  3. Install Strawberry Perl
  4. Install MSYS2
  5. Install required MSYS2 pacman packages (from an MSYS2-MinGW64 shell)

1. Install Microsoft Visual Studio

Install Microsoft Visual Studio 2017 & 2019.

Any edition of Microsoft Visual Studio 2019 should do, even the Microsoft Visual Studio 2019 Community Edition. Download it from the Microsoft older downloads page.

Make sure to select the "Desktop development with C++" and the latest SDK for Windows 10 or Windows 11 features when installing Microsoft Visual Studio.

You select the Windows SDK based on the target Windows version you plan on running the compiled application on.

Note: The current version of PySide2 required by RV (5.15.2.1) cannot be built with Microsoft Visual Studio 2019 : it can only be built with Microsoft Visual Studio 2017. Therefore, Microsoft Visual Studio 2017 needs to be installed as well.

2. Install Qt

Download the last version of Qt 5.15.x that you can get using the online installer on the Qt page. Logs, Android, iOS and WebAssembly are not required to build OpenRV.

Note: You will also need jom, and it is included with Qt Creator (available from the Qt online installer). If you do not want to install Qt Creator, you can download it from here and copy the executable and other files into the QT installation root directory under the Tools/QtCreator/bin/jom folder.

WARNING: If you fetch Qt from another source, make sure to build it with SSL support, that it contains everything required to build PySide2, and that the file structure is similar to the official package.

Note: Qt from MSYS2 is missing QtWebEngine.

3. Install Strawberry Perl

Download and install the 64-bit version of Strawberry Perl

4. Install MSYS2

Download and install the latest MSYS2.

Note that RV is NOT a mingw64 build. It is a Microscoft Visual Studio 2019 build.

RV is built with Microsoft Visual Studio 2019 via the cmake "Visual Studio 16 2019" generator.

msys2 is only used for convenience as it comes with a package manager with utility packages required for the RV build such as cmake, git, flex, bison, nasm, unzip, zip, etc.

NOTE: The Windows' WSL2 feature conflict with MSYS2. For simplicity, it is recommanded to disable Windows' WSL or WSL2 feature entirely.

Additional information can be found on the MSYS2 github.

5. Install required MSYS2 pacman packages

From an MSYS2-MinGW64 shell, install the following packages which are required to build RV:

pacman -S --needed \
        mingw-w64-x86_64-autotools \
        mingw-w64-x86_64-cmake \
        mingw-w64-x86_64-glew \
        mingw-w64-x86_64-libarchive \
        mingw-w64-x86_64-make \
        mingw-w64-x86_64-meson \
        mingw-w64-x86_64-python-pip \
        mingw-w64-x86_64-python-psutil \
        mingw-w64-x86_64-toolchain \
        bison \
        flex \
        git \
        nasm \
        p7zip \
        unzip \
        zip

To successfully build Open RV in debug on Windows, you must also install a Windows-native python3 (download page) as it is required to build the opentimelineio python wheel in debug.

This step is not required if you do not intend to build the debug version of RV.

NOTE: Even as of Windows 11, for legacy reason, a default system path length is still limited to 254 bytes long. For that reason we strongly suggest cloning OpenRV into drive's root directory e.g.: C:\