The Forge Premake

This repository contains a Premake script to generate .sln and .vcxproj files for use in Visual Studio or JetBrains Rider, which you can use to build The-Forge

Currently, all of the Examples build and run on Windows with Vulkan/DX11/DX12 enabled

However, due to lacking the required hardware, I am unable to confirm that Unit_Test 35_VariableRateShading works as intended

The repo also includes a custom module that extends premake to configure and run The-Forge's shader compiler tool as part of a VS/Rider build

Note: I am not a Premake, C++, or The-Forge expert, but if you're looking for a way to integrate The-Forge into your own premake or cmake based build system, I hope that this helps!

Prerequisites

1. VulkanSDK 1.2.162.0
2. Windows 10 SDK (10.0.17763.0)
3. VC++ 2017 version 15.9 v14.16 latest v141 tools

Make sure the VULKAN_SDK environment variable is set to the SDK location. The installer should handle this for you.

While The-Forge's README recommends these versions of the Windows SDK and toolset, I have found that most of the codebase supports higher versions. Feel free to experiment, but if you run into issues, try using the versions listed above.

Build steps

1. Clone this repo git clone https://github.com/acatxnamedvirtue/the-forge-premake.git
2. Update the submodule to pull in the source for The-Forge and Custom-Middleware git init && git submodule update
3. Run The-Forge/PRE_BUILD.bat to download assets needed for the examples
4. Run GenVS.bat to use the vendored premake5 exe, or run premake5 vs2022 from your terminal
5. Open The-Forge-Premake.sln in VS or Rider, then build and run any of the Examples

Special Thanks to a few prior art repos:

https://github.com/VoidAnchor/TheForgeTheCmake

https://github.com/rextimmy/the-forge-glfw

https://github.com/learn-computer-graphics/the-forge-sampless