BUILDING_ON_WINDOWS_WITH_VCPKG.md

Building on Windows with vcpkg

This will require more than 30GB of free space on your hard drive.

Prerequisites

1. Install Visual Studio with "Desktop development with C++"
2. Install CMake
3. Install git
4. Install vcpkg
   • git clone https://github.com/Microsoft/vcpkg.git
   • cd .\vcpkg\
   • .\bootstrap-vcpkg.bat
   • .\vcpkg integrate install
   • .\vcpkg integrate powershell
   • cd ..
5. Configure the environment variables for vcpkg.
   Check this document for more information for how to set environment variables on Windows.
   • Ensure your dependencies are built as 64-bit
     e.g. setx VCPKG_DEFAULT_TRIPLET x64-windows
     See documentation about Triplets
     default is x86-windows
   • Set VCPKG_ROOT to the vcpkg path
     e.g. setx VCPKG_ROOT <path to vcpkg>
     See VCPKG_ROOT documentation
   • Append the vcpkg path to your path
     e.g. setx PATH "%PATH%;<path to vcpkg>"
   • For more configurations, see https://learn.microsoft.com/en-gb/vcpkg/users/config-environment
6. You may need to restart your computer to ensure all your environment variables and what-not are loaded everywhere.

Building

1. Clone
   • git clone --recurse-submodules https://github.com/Chatterino/chatterino2.git
2. Install dependencies
   • cd .\chatterino2\
   • vcpkg install
3. Build
   • mkdir .\build\
   • cd .\build\
   • (cmd) cmake .. -DCMAKE_TOOLCHAIN_FILE=%VCPKG_ROOT%/scripts/buildsystems/vcpkg.cmake
   • (ps1) cmake .. -DCMAKE_TOOLCHAIN_FILE="$env:VCPKG_ROOT/scripts/buildsystems/vcpkg.cmake"
   • cmake --build . --parallel <threads> --config Release
4. Run
   • .\bin\chatterino2.exe