From f1d751b4a957f2d83a2d4f47fed906bc09584165 Mon Sep 17 00:00:00 2001 From: Hugo Locurcio Date: Fri, 3 Jan 2025 18:45:37 +0100 Subject: [PATCH] Mention Vulkan and Direct3D 12 SDK install scripts in Compiling for macOS/Windows --- .../development/compiling/compiling_for_macos.rst | 2 ++ .../development/compiling/compiling_for_windows.rst | 12 ++++++++++-- 2 files changed, 12 insertions(+), 2 deletions(-) diff --git a/contributing/development/compiling/compiling_for_macos.rst b/contributing/development/compiling/compiling_for_macos.rst index 5d02b0f10..778d6795c 100644 --- a/contributing/development/compiling/compiling_for_macos.rst +++ b/contributing/development/compiling/compiling_for_macos.rst @@ -21,6 +21,8 @@ For compiling under macOS, the following is required: (or the more lightweight Command Line Tools for Xcode). - `Vulkan SDK `_ for MoltenVK (macOS doesn't support Vulkan out of the box). + The latest Vulkan SDK version can be installed quickly by running + ``misc/scripts/install_vulkan_sdk_macos.sh`` within the Godot source repository. .. note:: If you have `Homebrew `_ installed, you can easily install SCons using the following command:: diff --git a/contributing/development/compiling/compiling_for_windows.rst b/contributing/development/compiling/compiling_for_windows.rst index 982d300cc..60ee8be3d 100644 --- a/contributing/development/compiling/compiling_for_windows.rst +++ b/contributing/development/compiling/compiling_for_windows.rst @@ -148,7 +148,7 @@ the engine source code (using ``cd``) and type: .. tip:: If you are compiling Godot to make changes or contribute to the engine, - you may want to use the SCons options ``dev_build=yes`` or ``dev_mode=yes``. + you may want to use the SCons options ``dev_build=yes`` or ``dev_mode=yes``. See :ref:`doc_introduction_to_the_buildsystem_development_and_production_aliases` for more info. @@ -182,7 +182,15 @@ Compiling with support for Direct3D 12 By default, builds of Godot do not contain support for the Direct3D 12 graphics API. -To compile Godot with Direct3D 12 support you need at least the following item: +You can install the required dependencies by running +``python misc/scripts/install_d3d12_sdk_windows.py`` +in the Godot source repository. After running this script, add the ``d3d12=yes`` +SCons option to enable Direct3D 12 support. This will use the default paths for +the various dependencies, which match the ones used in the script. + +You can find the detailed steps below if you wish to set up dependencies +manually, but the above script handles everything for you (including the +optional PIX and Agility SDK components). - `godot-nir-static library `_. We compile the Mesa libraries you will need into a static library. Download it