All platforms

The Vulkan SDK is required on all platforms.

Microsoft Windows

Lysa compiles with MSVC 19+ or LLVM/MinGW 21+.

The DirectX 12 backend requires the MSVC runtime even when the compiler is LLVM: install the "Game Development with C++" part of Visual Studio 2022.

The project uses CMake. Both JetBrains CLion and Visual Studio are supported.

Linux

The required packages are llvm-21, cmake, ninja-build, and vulkan-validation-layers. The Vulkan SDK's setup-env.sh must be sourced in the shell profile so that the VULKAN_SDK variable is set for every session.

Engine and library paths

This project requires three external repositories: the engine, the Vireo RHI, and the Lysa Nodes library. All three paths are declared in a .env.cmake file at the project root:

set(LYSA_ENGINE_PROJECT_DIR "path/to/the/cloned/lysa_engine")
set(VIREO_RHI_PROJECT_DIR   "path/to/the/cloned/vireo_rhi")
set(LYSA_NODES_PROJECT_DIR  "path/to/the/cloned/lysa_nodes")

Clone the repositories before configuring:

git clone https://github.com/LysaEngine/lysa_engine
git clone https://github.com/HenriMichelon/vireo_rhi
git clone https://github.com/LysaEngine/lysa_nodes

Build commands

cmake -B build -G Ninja -DCMAKE_BUILD_TYPE=Release

cmake --build build --target myapp

The executable must be run from the project root directory so that the app:// virtual filesystem resolves app://shaders and app://res correctly.

./build/myapp # Linux

build\myapp.exe # Windows

Next : Project layout