Building For Windows
This guide builds the Windows x64 editor from an engine source checkout using PlasmaBuild. Run the commands below in PowerShell from the engine repository root.
Prerequisites
Visual Studio
Install Visual Studio with the Desktop development with C++ workload, MSVC C++ build tools, and a Windows SDK. The repository provides workspace generators for Visual Studio 2022 and Visual Studio 2026. Use Visual Studio 2026 for the current editor setup: the default Qt package is Qt6-6.11.0-vs144-x64.
The presence of a generator for another Visual Studio version does not guarantee that bundled third-party binaries match its toolchain.
.NET and Dependencies
The checkout's global.json requests .NET SDK 10.0.301, permits later patches in that feature band, and disables prerelease SDKs. Install a matching SDK for the managed C# build steps. Check installed SDKs with:
dotnet --list-sdks
Allow network access for the first build. Build helpers obtain dependencies such as Qt and pinned .NET host/runtime packages. Keep Data/Tools/Precompiled available; it contains the PlasmaBuild installer and dependency extraction tools.
The Vulkan SDK is optional for compilation. A compatible Vulkan driver is required to run the Vulkan renderer; see Vulkan.
Install PlasmaBuild
Run the bundled setup:
.\Setup.cmd
This invokes Setup.ps1 and runs the bundled PlasmaBuild installer silently. To use the setup wizard instead, run .\Setup.ps1 -Interactive.
Open a new terminal so PATH changes take effect, return to the engine repository root, and verify:
plasmabuild --help
Generating the Project Files
Build Scripts
For Visual Studio 2026:
.\GenerateWorkspace_vs2026.bat
The script runs:
plasmabuild generate workspace --workspace PlasmaEngine --ide vs2026
Open the generated PlasmaEngine.slnx in the repository root with Visual Studio 2026. Generated project files are stored under Intermediate/ProjectFiles.
GenerateWorkspace_vs2022.bat selects the Visual Studio 2022 generator. Open the solution reported by that generator with the matching IDE.
If Windows opens .slnx files in the wrong Visual Studio version, open the solution from Visual Studio 2026 or update the file association.
Other IDEs and CMake
The repository also includes GenerateWorkspace_vscode.bat, GenerateWorkspace_rider.bat, and GenerateWorkspace_cmake.bat. These select PlasmaBuild's corresponding workspace generators. PlasmaBuild remains the build backend, including for generated CMake integration. Regenerate from the rule files instead of editing generated project files.
Building
Command Line
Build the editor and its declared dependencies:
plasmabuild build PlasmaEditor --platform Windows --arch x64 --configuration Development
The initial build includes dependency preparation and can take longer than subsequent builds. After a successful build, launch:
.\Binaries\Windows_Development\PlasmaEditor.exe
Use --configuration Debug for a debug build. See Build Types for Release and Shipping.
Visual Studio
Select PlasmaEditor-Development and Windows-x64 in the generated solution, then build. The workspace invokes PlasmaBuild. Run the editor through the workspace's launch settings or use the executable above.
Regenerate the workspace after changing module, target, or workspace rules, or when updating to an engine revision that changes them.
Troubleshooting
| Problem | What to check |
|---|---|
plasmabuild is not recognized | Run setup, then open a new terminal. Use Get-Command plasmabuild to check which installation is selected. |
| Compiler or Windows SDK is missing | Check the C++ workload and individual components in Visual Studio Installer. Finish any pending installation or restart. |
| .NET SDK resolution fails | Compare dotnet --list-sdks with global.json; a runtime installation alone is insufficient. |
| Qt preparation fails | Check network access and Data/Tools/Precompiled/7z.exe. If QTDIR is set, it must point to a compatible, complete Qt installation; remove an unintended override. |
Release is absent or rejected | Check that PlasmaBuild supports the current engine rules, then regenerate the workspace. Older tool versions may expose only three configurations. |
| The editor cannot load a DLL or companion process | Check that the full editor target completed and launch from the matching Binaries/Windows_<Configuration> directory. |
| Vulkan initialization fails | Check GPU driver and runtime support. Installing build headers does not provide a working graphics driver. |
Read the first failing build step in the output. For additional detail, repeat the build command with --verbose.