Skip to content

Updating build instructions for VCPKG #44

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
DevGeniusCode merged 1 commit into from
Apr 29, 2025
Merged

Updating build instructions for VCPKG #44

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 40 additions & 4 deletions SourceCode/Builds/build_with_msvc22.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,15 @@ For build using solutions and more advanced build configurations, see below.
- [Build through CMake target view](#build-through-cmake-target-view)
- [Build using command line](#build-using-command-line)
- [Build using solutions](#build-with-solutions)
- [Build with VCPKG](#build-with-vcpkg)
- [Troubleshooting](#troubleshooting)

## Prerequisites

1. **Visual Studio 2022**

- Ensure that the necessary C++ development components, **including MFC**, are installed.
- For _vcpkg_ builds, you also must have **vcpkg** installed, which you can find under individual components.

>[!NOTE]
> You must have the MFC components installed to compile the source code. You can find it in Visual Studio Installer.
Expand All @@ -39,10 +41,14 @@ For build using solutions and more advanced build configurations, see below.
### 2. Build the Project

- Select the appropriate build configuration:
- `Build Windows build` for a release build.
- `Build Windows Debug build` for a debug build.
- `Build Windows Internal build` for an internal build.
- `Build Windows Profile build` for a profile build.
- `Build Windows 32bit build` for a release build.
- `Build Windows 32bit Debug build` for a debug build.
- `Build Windows 32bit Internal build` for an internal build.
- `Build Windows 32bit Profile build` for a profile build.
- `Build Windows 32bit VCPKG build` for a release build with the VCPKG package manager.
- `Build Windows 32bit VCPKG Debug build` for a debug build with the VCPKG package manager.
- `Build Windows 32bit VCPKG Internal build` for an internal build with the VCPKG package manager.
- `Build Windows 32bit VCPKG Profile build` for a profile build with the VCPKG package manager.

![image](https://github.com/user-attachments/assets/2bc0aa26-3342-4aac-ae5b-6cf91db21214)

Expand Down Expand Up @@ -126,6 +132,36 @@ For more CMake options, see the [CMake Guide](cmake_guide).

---

## Build with VCPKG

To build configurations that make use of VCPKG you must set the environment variable `VCPKG_ROOT` to the location
where the VCPKG is found. If you have installed Visual Studio 2022 with the VCPKG component, you will most likely
find it in one of these paths:

- `C:\Program Files\Microsoft Visual Studio\2022\Community\VC\vcpkg`
- `C:\Program Files\Microsoft Visual Studio\2022\Professional\VC\vcpkg`
- `C:\Program Files\Microsoft Visual Studio\2022\Enterprise\VC\vcpkg`

If you use the stand-alone version of VCPKG, you need to use the folder you installed it in.

### Set environment variable in command prompt

You can set the environment variable in the command prompt. You will have to set it again if you (re)open the prompt:

- `set VCPKG_ROOT=<path_to_vcpkg>`

### Set environment variable in Windows

You can also permanently set the environment variable in Windows

- Search for `edit the system environment variables` in Windows Search or Control Panel
- Choose `Environment Variables`
- Add a new user variable
- Set the variable name to `VCPKG_ROOT`
- Set the variable value to the VCPKG path.

---

## Troubleshooting

- **Missing DLLs?** Ensure that all required dependencies are installed.
Expand Down