vcpkg-registry

CCP Games' public vcpkg registry for developing its Carbon engine

This registry is intended to be used in addition to the official Microsoft vcpkg registry.

Contributing to this registry

• Place your contributions in a branch
• Either follow the Steps 3 and 4 as mentioned in the documentation
• Or use the provided update_ports.py utility to achieve the same result, e.g.: python tools/update_ports.py.
  • The utility expects that VCPKG_ROOT has been set up correctly.
• Open a PR from your branch onto main.

Custom toolchains and triplets

This registry provides a set of custom vcpkg triplets and toolchains. These are to ensure that all Carbon components are compiled correctly for supported target platforms, and build configurations.

One thing that may seem odd about the custom toolchains is that they are split in two files, one suffixed with -carbon and the other with -triplet. This split is done to avoid unnecessarily including vcpkg's very own platform-specific toolchain files when building a component as a top-level project. At the time of this writing, such an include would be unproblematic, but it does introduce a possible failure point that can strike at inopportune moments.

In order to make use of the triplet files inside triplets/, the environment variable PATH_TO_VCPKG_ROOT must be defined as the absolute path to the root of a valid VCPKG installation.

This is needed because recent changes in the vcpkg-tool removed the ability to access the VCPKG_ROOT environment variable from inside the VCPKG build environment, while VCPKG_LOAD_VCVARS_ENV is set to ON.

Carbon components should contain vcpkg as a submodule, and set PATH_TO_VCPKG_ROOT in CMakePresets.json:

  "configurePresets": [
    {
      "toolchainFile": "${sourceDir}/vendor/github.com/microsoft/vcpkg/scripts/buildsystems/vcpkg.cmake",
      ...
      "environment": {
        "PATH_TO_VCPKG_ROOT": "${sourceDir}/vendor/github.com/microsoft/vcpkg"
      }
    },