Files

scawful ed299300e3 Update build instructions and enhance Windows development setup

- Revised build instructions to include comprehensive Windows support with automated setup scripts and Visual Studio integration.
- Added detailed sections for Windows development, including recommended setup scripts and manual options for vcpkg integration.
- Improved clarity on build commands and troubleshooting steps for CMake and Visual Studio issues.
- Introduced new scripts for testing CMake configuration and streamlined project generation processes.

2025-09-28 00:00:12 -04:00

3.2 KiB

Raw Blame History

vcpkg Integration for Windows Builds

Note

: This document provides detailed vcpkg information. For the most up-to-date build instructions, see Build Instructions.

This document describes how to use vcpkg for Windows builds in Visual Studio with YAZE.

Overview

vcpkg is Microsoft's C++ package manager that simplifies dependency management for Windows builds. YAZE now includes full vcpkg integration with manifest mode support for automatic dependency resolution.

Features

Manifest Mode: Dependencies are automatically managed via vcpkg.json
Visual Studio Integration: Seamless integration with Visual Studio 2019+
CMake Presets: Pre-configured build presets for Windows
Automatic Setup: Setup scripts for easy vcpkg installation

Quick Start

1. Setup vcpkg

Run the automated setup script:

# Command Prompt
scripts\setup-vcpkg-windows.bat

# PowerShell
.\scripts\setup-vcpkg-windows.ps1

2. Build with vcpkg

Use the Windows presets in CMakePresets.json:

# Debug build
cmake --preset windows-debug
cmake --build build --preset windows-debug

# Release build
cmake --preset windows-release
cmake --build build --preset windows-release

Configuration Details

vcpkg.json Manifest

The vcpkg.json file defines all dependencies:

{
  "name": "yaze",
  "version": "0.3.1",
  "dependencies": [
    "zlib",
    "libpng", 
    "sdl2",
    "abseil",
    "gtest"
  ]
}

CMake Configuration

vcpkg integration is handled in several files:

CMakeLists.txt: Automatic toolchain detection
cmake/vcpkg.cmake: vcpkg-specific settings
CMakePresets.json: Windows build presets

Build Presets

Available Windows presets:

windows-debug: Debug build with vcpkg
windows-release: Release build with vcpkg

Dependencies

vcpkg automatically installs these dependencies:

zlib: Compression library
libpng: PNG image support
sdl2: Graphics and input handling
abseil: Google's C++ common libraries
gtest: Google Test framework (with gmock)

Environment Variables

Set VCPKG_ROOT to point to your vcpkg installation:

set VCPKG_ROOT=C:\path\to\vcpkg

Troubleshooting

Common Issues

vcpkg not found: Ensure VCPKG_ROOT is set or vcpkg is in the project directory
Dependencies not installing: Check internet connection and vcpkg bootstrap
Visual Studio integration: Run vcpkg integrate install from vcpkg directory

Manual Setup

If automated setup fails:

git clone https://github.com/Microsoft/vcpkg.git
cd vcpkg
.\bootstrap-vcpkg.bat
.\vcpkg.exe integrate install

Benefits

Consistent Dependencies: Same versions across development environments
Easy Updates: Update dependencies via vcpkg.json
CI/CD Friendly: Reproducible builds
Visual Studio Integration: Native IntelliSense support
No Manual Downloads: Automatic dependency resolution

Advanced Usage

Custom Triplets

Override the default x64-windows triplet:

cmake --preset windows-debug -DVCPKG_TARGET_TRIPLET=x86-windows

Static Linking

For static builds, modify cmake/vcpkg.cmake:

set(VCPKG_LIBRARY_LINKAGE static)
set(VCPKG_CRT_LINKAGE static)

3.2 KiB Raw Blame History