Reporting Bugs: Difference between revisions

From Veloren Wiki
Content added Content deleted
VisualWikitext
mNo edit summary
(Fixed typos and other changes.)
 
Line 1: Line 1:
== Reporting Bugs ==
== 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.
# 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?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 as possible, include screenshots if needed.
# 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:''' ''Incase you do not want to create an gitlab account you can join our [https://discord.gg/BvQuGze discord]
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 Voxygen will both produce logs.
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 MacOS ==
== Linux and macOS ==


=== Airshipper ===
=== Airshipper ===


# Start airshipper with <code>-vv</code> argument.
# 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 ===


# Opening a CMD.
# 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 (till you encounter the problem).
# 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 ====
==== cmd ====


# Open a CMD.
# Open a console (cmd).
# Go to your veloren folder with the <code>cd</code> command, e.g. <code>cd C:\Users\<Your Username>\Desktop\veloren</code>.
# 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 CMD and the folder <code>userdata\voxygen\logs</code> or <code>%appdata%\veloren\</code>.
# 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]]
[[Category:Sysadmin]]

Latest revision as of 22:18, 21 April 2023

Reporting Bugs

  1. The first step is to check if the bug was already reported on our GitLab issues list.
  2. If not, create an issue with the Bug template and try to describe the bug as accurately as possible, including screenshots if possible.
  3. 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)
  4. 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

  1. Start Airshipper with -vv argument.
  2. 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

  1. Open a console (cmd).
    > On Windows press Windows key + R. Then type cmd and hit enter.
  2. Type airshipper run -vv and hit enter.
  3. Run the game until you encounter the problem.
  4. 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

  1. Open a console (cmd).
  2. Go to your Veloren folder with the cd command, e.g. cd C:\Users\<Your Username>\Desktop\veloren.
  3. Write set RUST_LOG=trace&& veloren-voxygen.exe and hit enter (exactly like here, without whitespace before &&)
  4. The logs will now be printed to the Windows console and the folder userdata\voxygen\logs or %appdata%\veloren\.
Retrieved from "https://wiki.veloren.net/wiki/Reporting_Bugs?oldid=18691"
Last modified
This page was last edited on 21 April 2023, at 22:18.
Copyright
Content is available under Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) unless otherwise noted.
Cookies help us deliver our services. By using our services, you agree to our use of cookies.
More information