Reporting Bugs: Difference between revisions

Content added Content deleted

Inline

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 type cmd and hit enter.
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\.

Revision as of 09:39, 27 September 2022 (view source) Ajima (talk \| contribs) mNo edit summary Tag: Visual edit ← Older edit		Latest revision as of 22:18, 21 April 2023 (view source) Walpo (talk \| contribs) (Fixed typos and other changes.)
Line 1: == Reporting Bugs == # ~~First~~The ~~thing~~first step is to docheck ~~will~~if bethe tobug ~~check~~was already reported on our [https://gitlab.com/veloren/veloren/-/issues ~~gitlab~~GitLab issues] ~~if this bug is already known~~list. # If not, [https://gitlab.com/veloren/veloren/-/issues/new~~?issue%5Bassignee_id%5D=&issue%5Bmilestone_id%5D=~~ create an issue] with the <code>Bug template</code> and try to describe the bug as ~~good~~accurately as possible, ~~include~~including screenshots if ~~needed~~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:~~'''~~ ~~''Incase~~In case you do not want to create an ~~gitlab~~GitLab account, you can join our ~~[https://discord.gg/BvQuGze~~Discord ~~discord]~~server and report the bug in #bugs-and-support. ~~and report the bug in <code>#bugs-and-support</code>.''~~ == Collect Logs == Line 15 ⟶ 14: 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 ~~Voxygen~~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: Line 24 ⟶ 23: Search for a message called <code>Tracing is successfully set to TRACE</code> to verify <code>TRACE</code> level is enabled. == Linux and ~~MacOS~~macOS == === Airshipper === # Start ~~airshipper~~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. === Compiled === Line 44 ⟶ 43: === Airshipper === # ~~Opening~~Open a ~~CMD~~console (cmd). #: > 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. # Run the game ~~(till~~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. === Compiled === Line 54: -> See Linux/Compiled above ==== ~~Cmd~~cmd ==== # Open a ~~CMD~~console (cmd). # Go to your ~~veloren~~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>) # The logs will now be printed to the ~~CMD~~Windows console and the folder <code>userdata\voxygen\logs</code> or <code>%appdata%\veloren\</code>. [[Category:Sysadmin]]