- First thing to do will be to check our gitlab issues if this bug is already known.
- If not create an issue with the
Bug templateand try to describe the bug as good as possible, include screenshots if needed.
- Upload the log file for additional information which can help us identify the issue. See below how to get logs. (Note: make sure no sensitive information is included in the log files)
- Submit the issue
Tip: Incase you do not want to create an gitlab account you can join our discord
and report the bug in
If you encounter problems with Veloren, we might ask you for logs or a trace. This tutorial shows you how to collect the logs, depending on your operating system, and the way you have installed Veloren.
By default Veloren server and Voxygen will both produce logs.
They are printed in the terminal/cmd and to a file, called
voxygen.log.<todays_date>. It even prints where the file is located to terminal/cmd:
Nov 25 01:40:14.388 INFO veloren_voxygen::logging: Setup terminal and file logging. logdir="/mnt/games/cargo-build/debug/userdata/voxygen/logs"
By default the granularity is
INFO, but please provide logs on
TRACE level (as shown below).
Search for a message called
Tracing is successfully set to TRACE to verify
TRACE level is enabled.
- Start airshipper with
- When the game starts it will print to the terminal the location of the log file. Check Airshipper page.
- Start voxygen with
TRACElevel in terminal:
RUST_LOG="trace" ./target/debug/veloren-voxygen # or RUST_LOG="trace" cargo run
- Copy trace from terminal or the log file mentioned above.
- Opening a CMD.
On Windows press
Windows key + R. Then type
airshipper run -vvand hit enter.
- Run the game (till you encounter the problem).
- The logs should be located in
%Appdata%/airshipper/profiles/default/userdata/voxygen/logsOr check Airshipper page.
-> See Linux/Compiled above
- Open a CMD.
- Go to your veloren folder with the
cd C:\Users\<Your Username>\Desktop\veloren.
set RUST_LOG=trace&& veloren-voxygen.exeand hit enter (exactly like here, without whitespace before
- The logs will now be printed to the CMD and the folder
Sometimes it can be useful to collect extra information when debugging graphics issues. This info is not always needed so this mainly serves as a reference to point users to when the information would be helpful.
- Create a folder that to hold the trace. (e.g.
- Run the game with the envionment variable
WGPU_TRACE_DIRset to the new folder.
(the path can be absolute or relative)
WGPU_TRACE_DIR="./wgpu-trace" airshipper start
set "WGPU_TRACE_DIR=./wgpu-trace" airshipper start
- Reproduce the bug/crash and then exit the game (the trace will be larger if this takes a while).
- Zip up the trace folder for easy sharing.
For more details about wgpu's API tracing see https://github.com/gfx-rs/wgpu/wiki/Debugging-wgpu-Applications#tracing-infrastructure
First, check that you are using the dx12 or dx11 graphics backend.
- Install visual studio https://visualstudio.microsoft.com/downloads/.
- Force the debug layer on for Voxygen (Note: if you compiled the game yourself without
--releasethen this step can be skipped):
- Open visual studio.
- Go to Debug > Graphics > Directx control panel.
- Click the
veloren-voxygen.exeto the list (be sure to remove this when finished).
- Change the Debug Layer setting to Force On.
- Click apply and exit the control panel.
- Open the Voxygen executable as a project (original instructions):
- In visual studio: File > Open > Project.
- Navigate to veloren-voxygen.exe, select it, and click open.
- Run the project (green arrow and or option under the Debug menu).
- Reproduce the issue.
- Visual studio will have a section labeled "Output" with the output of the graphics debug layer and other random stuff (this can be shared via copy-paste).