Skip to content

README.md

Latest commit

 

History

History
executable file
·
33 lines (22 loc) · 1.32 KB

README.md

File metadata and controls

executable file
·
33 lines (22 loc) · 1.32 KB

Lorr

License

A toy Vulkan-based renderer with bleeding edge features. Works on both Linux and Windows.

Requirements

If you are willing to help development, make sure you have the latest Vulkan SDK installed.

To build, you would need clang-18 or latest MSVC compiler with proper C++23 support. Lorr uses xmake build tool, you can install it from here.

Notes

  • Vulkan SDK still does not support timeline semaphores, most of the validation errors are related to that.
  • Lorr uses SDL3 as window manager. On Linux, both Wayland and X11 should be supported.

Getting Started

To build, simply run xmake on project root directory.

If you want to see more verbose build output, you can run build it with xmake -v instead.

You can configure your toolchain using xmake f --toolchain=clang|msvc|gcc --mode=debug|release --policies=package.precompiled:n before running building. Make sure to run xmake install -o ./build to get third party binaries.

Example configuration for clang:

xmake f --toolchain=clang --runtimes=c++_static --ldflags='-fuse-ld=lld' -m debug --policies=package.precompiled:n
xmake build

License

This project is licensed under the MIT License - see the LICENSE file for details.