Installation

Requirements

🦀 Cargo

Cargo (the Rust compiler) 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.

🌋 Vulkan

You can download Vulkan for every major platform here.

OS-specific

🐧 Notes on Linux

On Linux you can likely install Vulkan through your package manager, which will make the installation a lot simpler.

🪟 Notes on Windows

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

• CMake
• Ninja
• Git
• Python3

I would highly recommend installing these through a package manager like choco or scoop, since it saves you a lot of manual configuration.

e.g.:

choco install ninja python3 git cmake --installargs 'ADD_CMAKE_TO_PATH=System'

🍎 Notes on MacOS

None

Compiling

You can compile Korangar by running:

cargo build --release

🪲 Debug tools

There are extensive tools for debugging implemented in the client. To enable them you can run:

cargo build --release --features debug

If you are using a terminal that supports unicode characters, you might want to enable this feature for some nicer terminal output:

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

Running

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