Dependencies

Lysa supports Microsoft Windows and Linux (X11 & Wayland) and need the following dependencies :

A C++23 compiler with std module support (for windows : MSVC 19+, LLVM+MingW 21+, for Linux : LLVM 21+).
CMake 3.29+ with a build tool like Ninja
Vulkan SDK (1.3+)
Vireo RHI

For Linux the following additional packages are needed :

vulkan-validation-layers
libc++
You need manually install the last version of the Vulkan SDK and execute the setup-env.sh script from the Vulkan installation directory to set the VULKAN_SDK environment variable.

Integration

Lysa Engine is intended to be used as a submodule or a CMake subdirectory.

To use Lysa Engine in your project, you need to set the VIREO_RHI_PROJECT_DIR variable, usually in a .env.cmake file at your project root.

# .env.cmake

set(VIREO_RHI_PROJECT_DIR "path/to/vireo_rhi")

Then, add it via CMake:

set(LUA_BINDING ON)
set(DIRECTX_BACKEND ON)
set(FORWARD_RENDERER ON)
set(DEFERRED_RENDERER ON)
set(PHYSIC_ENGINE_JOLT ON)
set(PHYSIC_ENGINE_PHYSX OFF)
add_subdirectory(path/to/lysa_engine)
target_link_libraries(your_target PUBLIC lysa_engine)

then build your project with cmake -B build -G ninja and cmake --build build