(Created page with "== Reporting Bugs == # First thing to do will be to check our [https://gitlab.com/veloren/veloren/issues gitlab issues] if this bug is already known. # If not [https://gitlab...") |
(Fixed typos and other changes.) |
||
(One intermediate revision by one other user not shown) | |||
Line 1: | Line 1: | ||
== Reporting Bugs == |
== Reporting Bugs == |
||
# |
# The first step is to check if the bug was already reported on our [https://gitlab.com/veloren/veloren/-/issues GitLab issues] list. |
||
# If not [https://gitlab.com/veloren/veloren/issues/new |
# If not, [https://gitlab.com/veloren/veloren/-/issues/new create an issue] with the <code>Bug template</code> and try to describe the bug as accurately as possible, including screenshots if possible. |
||
# Upload the log file for additional information which can help us identify the issue. See below how to get logs. |
# 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) |
#:('''Note:''' make sure no sensitive information is included in the log files) |
||
# Submit the issue |
# Submit the issue |
||
Tip: In case you do not want to create an GitLab account, you can join our Discord server and report the bug in #bugs-and-support. |
|||
and report the bug in <code>#bugs-and-support</code>.'' |
|||
== Collect Logs == |
== Collect Logs == |
||
Line 15: | Line 14: | ||
This tutorial shows you how to collect the logs, depending on your operating system, and the way you have installed Veloren. |
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 |
By default a Veloren server and the voxygen system will both produce logs. |
||
They are printed in the terminal/cmd and to a file, called <code>voxygen.log.<todays_date></code>. It even prints where the file is located to terminal/cmd: |
They are printed in the terminal/cmd and to a file, called <code>voxygen.log.<todays_date></code>. It even prints where the file is located to terminal/cmd: |
||
Line 24: | Line 23: | ||
Search for a message called <code>Tracing is successfully set to TRACE</code> to verify <code>TRACE</code> level is enabled. |
Search for a message called <code>Tracing is successfully set to TRACE</code> to verify <code>TRACE</code> level is enabled. |
||
== Linux and |
== Linux and macOS == |
||
=== Airshipper === |
=== Airshipper === |
||
# Start |
# Start Airshipper with <code>-vv</code> argument. |
||
# When the game starts it will print to the terminal the location of the log file. Check the[https://wiki.veloren.net/wiki/Airshipper_-_Veloren_Launcher Airshipper] page. |
# When the game starts it will print to the terminal the location of the log file. Check the [https://wiki.veloren.net/wiki/Airshipper_-_Veloren_Launcher Airshipper] page. |
||
=== Compiled === |
=== Compiled === |
||
Line 44: | Line 43: | ||
=== Airshipper === |
=== Airshipper === |
||
# |
# Open a console (cmd). |
||
#: > On Windows press <code>Windows key + R</code>. Then type <code>cmd</code> and hit <code>enter</code>. |
#: > On Windows press <code>Windows key + R</code>. Then type <code>cmd</code> and hit <code>enter</code>. |
||
# Type <code>airshipper run -vv</code> and hit enter. |
# Type <code>airshipper run -vv</code> and hit enter. |
||
# Run the game |
# Run the game until you encounter the problem. |
||
# The logs should be located in <code>%Appdata%/airshipper/profiles/default/userdata/voxygen/logs</code> or check the [https://wiki.veloren.net/wiki/Airshipper_-_Veloren_Launcher Airshipper] page. |
# The logs should be located in <code>%Appdata%/airshipper/profiles/default/userdata/voxygen/logs</code> or check the [https://wiki.veloren.net/wiki/Airshipper_-_Veloren_Launcher Airshipper] page. |
||
=== Compiled === |
=== Compiled === |
||
Line 54: | Line 54: | ||
-> See Linux/Compiled above |
-> See Linux/Compiled above |
||
==== |
==== cmd ==== |
||
# Open a |
# Open a console (cmd). |
||
# Go to your |
# Go to your Veloren folder with the <code>cd</code> command, e.g. <code>cd C:\Users\<Your Username>\Desktop\veloren</code>. |
||
# Write <code>set RUST_LOG=trace&& veloren-voxygen.exe</code> and hit enter (exactly like here, without whitespace before <code>&&</code>) |
# Write <code>set RUST_LOG=trace&& veloren-voxygen.exe</code> and hit enter (exactly like here, without whitespace before <code>&&</code>) |
||
# The logs will now be printed to the |
# The logs will now be printed to the Windows console and the folder <code>userdata\voxygen\logs</code> or <code>%appdata%\veloren\</code>. |
||
[[Category:Sysadmin]] |
Latest revision as of 22:18, 21 April 2023
Reporting Bugs
- The first step is to check if the bug was already reported on our GitLab issues list.
- If not, create an issue with the
Bug template
and try to describe the bug as accurately as possible, including screenshots if possible. - 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: In case you do not want to create an GitLab account, you can join our Discord server and report the bug in #bugs-and-support.
Collect Logs
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 a Veloren server and the voxygen system 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.
Linux and macOS
Airshipper
- Start Airshipper with
-vv
argument. - When the game starts it will print to the terminal the location of the log file. Check the Airshipper page.
Compiled
1. Start voxygen with TRACE
level in terminal:
RUST_LOG="trace" ./target/debug/veloren-voxygen # or RUST_LOG="trace" cargo run
2. Copy trace from terminal or the log file mentioned above.
Windows
Airshipper
- Open a console (cmd).
- > On Windows press
Windows key + R
. Then typecmd
and hitenter
.
- > On Windows press
- Type
airshipper run -vv
and hit enter. - Run the game until you encounter the problem.
- The logs should be located in
%Appdata%/airshipper/profiles/default/userdata/voxygen/logs
or check the Airshipper page.
Compiled
Git Bash
-> See Linux/Compiled above
cmd
- Open a console (cmd).
- Go to your Veloren folder with the
cd
command, e.g.cd C:\Users\<Your Username>\Desktop\veloren
. - Write
set RUST_LOG=trace&& veloren-voxygen.exe
and hit enter (exactly like here, without whitespace before&&
) - The logs will now be printed to the Windows console and the folder
userdata\voxygen\logs
or%appdata%\veloren\
.