Requirements

Cargo (the Rust package manager) can best be installed and managed through Rustup.

Note that Korangar requires Rust nightly to compile. If you need help configuring Rustup accordingly, please read this stackoverflow issue.

OS-specific

On Windows you will need the following additional dependencies to be installed:

Slangc is also part of the VulkanSDK and can be installed with it. You can also use the windows packet manager winget to download the dependencies.

e.g.:

winget install --id Git.Git -e --source winget
winget install --id KhronosGroup.VulkanSDK -e --source winget

There is a flake.nix in the repository that exposes a dev shell with all dependencies for testing and running Korangar on Linux and MacOS.

You can compile Korangar by running:

cargo build --release

To gain access to Korangar's built-in developer tools, explicitly enable the debug feature:

cargo build --release --features debug

If your terminal supports Unicode, you might want to enable the unicode feature as well:

cargo build --release --features "debug unicode"

For information on how to use Korangar, please take a look at the wiki page called Running.