WillEngineV2

This is my second attempt at my own 3d game engine.

Table of Contents

• Prerequisites
• Getting Started
• Build Instructions
• Setting Up Symlinks
• Troubleshooting
• Contact Me

Prerequisites

• Git
• Git LFS (Large File Storage)
• CMake (3.x or later)
• Visual Studio 2022 (or newer) with MSVC Compiler
  • Required because precompiled libraries were built with MSVC
• VulkanSDK (1.3.296)

Getting Started

This engine only supports Windows at the moment and all instructions and setup will only be outlined for Windows.

1. Clone the repository (skip LFS files):

   export GIT_LFS_SKIP_SMUDGE=1
   git clone --filter=blob:none https://github.com/Williscool13/WillEngineV2.git
   

2. Navigate to the project directory:

   cd WillEngineV2
   

3. Initialize and update submodules:

   git submodule init
   git submodule update
   

4. Download LFS files:

   git lfs pull
   

Build Instructions (CMake GUI)

1. Set the source code directory to the root of the WillEngineV2 project
2. Choose a build directory (e.g., build or cmake-build-debug)
3. Click "Configure" and select your preferred generator (must be MSVC, I suggest VS2022)
4. Click "Generate"
5. Open the generated project in your IDE or build it from the command line

Setting Up Symlinks

After building the project, you need to set up symlinks for the shaders and assets directories to avoid creating unnecessary copies. For simplicity, you may simply copy the entire shaders and assets folder into your build folder instead.

Open a Command Prompt as administrator in your build directory and run:

mklink /D shaders ..\shaders
mklink /D assets ..\assets

Note: Adjust the paths if your folder structure differs.

Troubleshooting

assert(m_init) failed in VulkanBootstrap.h in Line 132

This error is typically caused by vkb failing to find a suitable GPU to use. It could be that your GPUs do not support Vulkan 1.3 or the use of some vulkan extensions (in this case Descriptor Buffers). You can verify this by checking what extensions your GPU supports at https://vulkan.gpuinfo.org/.

Unfortunately there isn't much that can be done if you get this error.

shaderc link errors

• Use git lfs pull after cloning to ensure large files are correctly downloaded. For this project, shaderc is precompiled and the binaries are stored in Git LFS.

Contact Me

If you have any troubles with the code or would like to discuss game engine/rendering architecture, please feel free to contact me at twtw40@gmail.com.