This section covers building Veloren from rust source with
cargo and running it.
Note: all commands need to be run from the repository.
On Windows you will need to install the following programs:
Fortunately, there's a quick way to install most of these
- Download and run Visual Studio Build Tools and install "C++ tools" and "Windows 10 SDK", you won't actually be needing Visual Studio itself.
- Open Powershell (you should have it installed by default) and run the following commands:
The first line installs the Scoop package manager and the second line installs CMake, Ninja and Python through Scoop in one go.
iwr -useb get.scoop.sh | iex scoop install cmake ninja python
On Linux you will need to have installed GTK3, Python and CMake.
On Debian systems additional libraries may need to be downloaded, below is a non-exhaustive list:
And a one liner to download and install them all:
sudo apt install libglib2.0-dev libasound2-dev libcairo2-dev libpango1.0-dev libatk1.0-dev libgtk-3-dev libxcb-shape0-dev libxcb-xfixes0-dev libudev-dev libxkbcommon-x11-dev libxcb-xkb-dev
On Fedora you can follow this awesome guide.
Note: Feel free to open an issue incase these dependencies are incorrect.
Run this in a terminal to compile and run Veloren:
To compile without running, use
cargo build instead.
Note: The initial compilation will take from 5min up to 30min therefore grab a tea and some snacks and come back later.
cargo run --bin veloren-server-cli
tracing to collect logs. They can be filtered by setting the
RUST_LOG environment variable to the respective level (
For all available filtering options visit the docs.
Tip: this works both for the server and client
By default debug builds are created which compile faster but run a bit slower than optimized release builds. Unlike many other projects, we've set them up so they're fast enough to be playable. If you want to get optimized builds, add the
--release flag when calling
cargo. Keep in mind that compiling release might be very slow!
If you want get familiar with cargo we recommend the Cargo Book.