⚙️ AshFault

A modern game engine built with low-level power and scripting flexibility

🛠️ Build Instructions

📦 Prerequisites

Make sure you have the following installed:

• Vulkan SDK (≥ 1.3)
• CMake ≥ 3.12
• A modern C++ compiler:
  • Clang ≥ 21
  • GCC ≥ 15
  • MSVC (latest version)

⚠️ Ensure your Vulkan SDK is properly set up and environment variables are configured (VULKAN_SDK, etc.)

---

📥 Clone the Repository

This project uses submodules, so make sure to clone with:

git clone --recursive https://github.com/JacoMalan1/ashfault.git
cd ashfault

---

⚙️ Build the Engine

A helper script is provided to configure and build the project:

Debug build (default)

./scripts/build.sh

Release build

./scripts/build.sh -r

---

🪟 Windows Notes

Run the build script using a compatible shell:

• Git Bash
• MSYS2
• WSL

Alternatively, you can generate and build manually using CMake (see below).

---

🔧 Manual CMake Build (Fallback)

mkdir -p build
cd build

cmake .. -DCMAKE_BUILD_TYPE=Release
cmake --build .

---

📁 Build Output

Compiled binaries and build files will be generated in the build/ directory.