Add a python script to install Direct3D 12 SDK components.

[mrbbbaixue]

Supersedes #86123, This is the python version for the previous PR.

• Now the default install path is %LOCALAPPDATA%\Godot\build_deps\
• The script will try to remove previous failed download files to avoid error.
• Will output the install folder after installation is completed.
• Now CI windows build will use this script to download SDK components.

This is how it works:

Details

[1/4] DirectX Shader Compiler
Downloading DirectX Shader Compiler dxc_2023_08_14.zip ...
Removing existing local DirectX Shader Compiler installation in C:\Users\USERNAME\AppData\Local\Godot\build_deps\dxc ...
Extracting DirectX Shader Compiler dxc_2023_08_14.zip to C:\Users\USERNAME\AppData\Local\Godot\build_deps\dxc ...
DirectX Shader Compiler dxc_2023_08_14.zip installed successfully.

[2/4] Mesa NIR
Downloading Mesa NIR godot-nir-23.1.0-1-devel.zip ...
Removing existing local Mesa NIR installation in C:\Users\USERNAME\AppData\Local\Godot\build_deps\mesa ...
Extracting Mesa NIR godot-nir-23.1.0-1-devel.zip to C:\Users\USERNAME\AppData\Local\Godot\build_deps\mesa ...
Mesa NIR godot-nir-23.1.0-1-devel.zip installed successfully.

[3/4] WinPixEventRuntime
Downloading WinPixEventRuntime 1.0.231030001 ...
Removing existing local WinPixEventRuntime installation in C:\Users\USERNAME\AppData\Local\Godot\build_deps\pix ...
Extracting WinPixEventRuntime 1.0.231030001 to C:\Users\USERNAME\AppData\Local\Godot\build_deps\pix ...
WinPixEventRuntime 1.0.231030001 installed successfully.

[4/4] DirectX 12 Agility SDK
Downloading DirectX 12 Agility SDK 1.610.4 ...
Removing existing local DirectX 12 Agility SDK installation in C:\Users\USERNAME\AppData\Local\Godot\build_deps\agility_sdk ...
Extracting DirectX 12 Agility SDK 1.610.4 to C:\Users\USERNAME\AppData\Local\Godot\build_deps\agility_sdk ...
DirectX 12 Agility SDK 1.610.4 installed successfully.

All Direct3D 12 SDK components were installed to C:\Users\USERNAME\AppData\Local\Godot\build_deps successfully!
You can now build Godot with Direct3D 12 support enabled by running "scons d3d12=yes".

This makes it much faster to get started with Direct3D 12 builds, as you only need to run python .\misc\scripts\install_d3d12_sdk_windows.py then run scons d3d12=yes.
This installs DirectX Shader Compiler, Mesa NIR, WinPixEventRuntime and DirectX 12 Agility SDK.

Thanks @Calinou for the original powershell script.

[AThousandShips]

You need to add it to the dependencies on the CI workflow, in .github/workflows/static_checks.yml

See https://github.com/godotengine/godot-docs/blob/master/.github/workflows/ci.yml for how the docs repo does it

[mrbbbaixue]

You need to add it to the dependencies on the CI workflow, in .github/workflows/static_checks.yml

See https://github.com/godotengine/godot-docs/blob/master/.github/workflows/ci.yml for how the docs repo does it

Thank you! I've changed requests to built-in urllib.request instead, so no more extra packages to install. 😉

[Calinou]

Tested locally on Windows 11, it works as expected. Great work 🙂

One thing is that trying to use d3d12=yes without dependencies installed will result in a cryptic error message:

$ scons platform=windows progress=no d3d12=yes -j20
scons: Reading SConscript files ...
Found MSVC version 14.3, arch x86_64
Building for platform "windows", architecture "x86_64", target "editor".
FileNotFoundError: [Errno 2] No such file or directory: 'C:\\Users\\Hugo\\AppData\\Local\\Godot\\build_deps\\mesa\\godot-mesa\\VERSION':
  File "C:\Users\Hugo\Documents\Git\godotengine\godot\SConstruct", line 991:
    SConscript("drivers/SCsub")
  File "C:\Users\Hugo\scoop\apps\python\current\Lib\site-packages\SCons\Script\SConscript.py", line 662:
    return method(*args, **kw)
  File "C:\Users\Hugo\scoop\apps\python\current\Lib\site-packages\SCons\Script\SConscript.py", line 598:
    return _SConscript(self.fs, *files, **subst_kw)
  File "C:\Users\Hugo\scoop\apps\python\current\Lib\site-packages\SCons\Script\SConscript.py", line 285:
    exec(compile(scriptdata, scriptname, 'exec'), call_stack[-1].globals)
  File "C:\Users\Hugo\Documents\Git\godotengine\godot\drivers\SCsub", line 29:
    SConscript("d3d12/SCsub")
  File "C:\Users\Hugo\scoop\apps\python\current\Lib\site-packages\SCons\Script\SConscript.py", line 662:
    return method(*args, **kw)
  File "C:\Users\Hugo\scoop\apps\python\current\Lib\site-packages\SCons\Script\SConscript.py", line 598:
    return _SConscript(self.fs, *files, **subst_kw)
  File "C:\Users\Hugo\scoop\apps\python\current\Lib\site-packages\SCons\Script\SConscript.py", line 285:
    exec(compile(scriptdata, scriptname, 'exec'), call_stack[-1].globals)
  File "C:\Users\Hugo\Documents\Git\godotengine\godot\drivers\d3d12\SCsub", line 118:      
    ("PACKAGE_VERSION", '\\"' + mesa_ver.read_text().strip() + '\\"'),
  File "C:\Users\Hugo\scoop\apps\python\current\Lib\pathlib.py", line 1027:
    with self.open(mode='r', encoding=encoding, errors=errors) as f:
  File "C:\Users\Hugo\scoop\apps\python\current\Lib\pathlib.py", line 1013:
    return io.open(self, mode, buffering, encoding, errors, newline)

We should check for the file's presence and display an error message telling the user to run the dependencies installation script.

[mrbbbaixue]

One thing is that trying to use d3d12=yes without dependencies installed will result in a cryptic error message:
We should check for the file's presence and display an error message telling the user to run the dependencies installation script.

It seems like the default value caused the problem. 🤔 should be easy to fix.
My idea is to make SCons's compilation script call the download script automatically when enabling d3d12 compilation but cannot find the corresponding dependencies. Do you think it's necessary? If we do so, the advantage is that for users, downloading dependencies is a one-click operation. If you think it's "too automatic", then I will only add a error message.

[Calinou]

My idea is to make SCons's compilation script call the download script automatically when enabling d3d12 compilation but cannot find the corresponding dependencies. Do you think it's necessary? If we do so, the advantage is that for users, downloading dependencies is a one-click operation. If you think it's "too automatic", then I will only add a error message.

I'd only add an error message for now, as it's easier to implement and some users tend to dislike buildsystems automatically connecting to the Internet.

[mrbbbaixue]

Not really sure how to write warning message and check logic. but, it just works™ and ready for review now.

[Calinou]

Looks great!

[akien-mga]

Looks good to me!

[akien-mga]

Had to fix things up to be able to compile things on Linux with MinGW installed, see #87609.

[bruvzg]

A bit too late but DXC is not required for building. Mesa libs is the only requirement.

[bruvzg]

Also, I do not think we should enable PIX by default (or enable it only for debug builds only), it's a debugging tool, and unnecessary for release templates.

[akien-mga]

I could add changes to #87609, but it's maybe better if you do a follow-up directly to handle making PIX opt-in / debug only.

[bruvzg]

I'll do a follow-up later.

[mrbbbaixue]

OK, Contact me if there is anything that needs me to do🫡