mirror of
https://github.com/loot/loot.github.io.git
synced 2026-07-27 14:13:30 -07:00
Oliver Hamlet
c1194ac2ec
Hugo is a lot easier to work with locally (especially on Windows), and because it's not natively supported by GitHub Pages, it gets deployed using GitHub Actions, so it's also easier to keep the version of Hugo in sync between local builds and deployments. I've compared the generated _site/ and public/ folders and they look equivalent, except that Hugo also generates a sitemap: that can be disabled, but it's good to have.
82 lines
5.2 KiB
HTML
82 lines
5.2 KiB
HTML
---
|
|
layout: page
|
|
title: How To Report Issues Helpfully
|
|
weight: 2
|
|
aliases:
|
|
- How-To-Report-Issues-Helpfully.html
|
|
---
|
|
|
|
<h3>Contents</h3>
|
|
|
|
<h4><a href="#identifying-issue">Identifying The Issue</a></h4>
|
|
|
|
<h4><a href="#reporting-issue">Reporting The Issue</a></h4>
|
|
|
|
<h4><a href="#supplying-log">Supplying Debug Logs For Application Issues</a></h4>
|
|
|
|
<h3 id="identifying-issue">Identifying The Issue</h3>
|
|
|
|
<p>The first step is to identify what type of issue you're having, so that you can report it in the most appropriate place. Issues can be one of two basic types:</p>
|
|
|
|
<ol>
|
|
<li>A metadata issue. It's probably this type if LOOT displays incorrect information, such as incorrect messages and Bash Tag suggestions. It's also probably a metadata issue if LOOT sorts your mods incorrectly, as it's most likely because it's lacking some sorting metadata, or the sorting metadata it has is incorrect.</li>
|
|
<li>An application issue. It's probably this type if LOOT behaves incorrectly or unexpectedly, such as crashing or doing the wrong thing when you click on a button. Some sorting mistakes can also be due to application issues, but it's best to treat them as metadata issues unless you know otherwise.</li>
|
|
</ol>
|
|
|
|
<p>Metadata issues are also game-specific, so make a note of which game you're having the issue with.</p>
|
|
|
|
<p><strong>Mod Organiser users</strong> who are experiencing a LOOT application issue should first try to replicate it while running LOOT independently of Mod Organiser. Running LOOT through Mod Organiser is unsupported.</p>
|
|
|
|
<h3 id="reporting-issue">Reporting The Issue</h3>
|
|
|
|
<p>Once you know which type of issue yours is, it's time to report it. It's best to report issues on LOOT's issue trackers, where they can't get lost, overlooked or disorganised, but doing so requires a free GitHub account. The links below can be used to report your issue in the appropriate tracker.</p>
|
|
|
|
<ul>
|
|
<li><a href="https://github.com/loot/starfield/issues/new">Starfield metadata</a></li>
|
|
<li><a href="https://github.com/loot/morrowind/issues/new">Morrowind metadata</a></li>
|
|
<li><a href="https://github.com/loot/oblivion/issues/new">Oblivion and Nehrim metadata</a></li>
|
|
<li><a href="https://github.com/loot/skyrim/issues/new">Skyrim metadata</a></li>
|
|
<li><a href="https://github.com/loot/skyrimse/issues/new">Skyrim Special Edition and Skyrim VR metadata</a></li>
|
|
<li><a href="https://github.com/loot/enderal/issues/new">Enderal and Enderal Special Edition metadata</a></li>
|
|
<li><a href="https://github.com/loot/fallout3/issues/new">Fallout 3 metadata</a></li>
|
|
<li><a href="https://github.com/loot/falloutnv/issues/new">Fallout: New Vegas metadata</a></li>
|
|
<li><a href="https://github.com/loot/fallout4/issues/new">Fallout 4 and Fallout 4 VR metadata</a></li>
|
|
<li><a href="https://github.com/loot/loot/issues/new">LOOT application</a></li>
|
|
</ul>
|
|
|
|
<p>If you don't have a GitHub account and don't want to sign up for one, you can instead report the issue in LOOT's official forum thread.</p>
|
|
|
|
<h3 id="supplying-log">Supplying Debug Logs For Application Issues</h3>
|
|
|
|
<p>If you're experiencing an application issue, you should supply debug logs to help solve the issue. You can do this by following the instructions below.</p>
|
|
|
|
<ol>
|
|
<li>In LOOT's settings, toggle the Enable Debug Logging checkbox on.</li>
|
|
<li>Run LOOT again to replicate the issue.</li>
|
|
<li>Select "Open LOOT Data Folder" in the File menu.</li>
|
|
<li>Upload the generated <code>LOOTDebugLog.txt</code> log file contained within.</li>
|
|
</ol>
|
|
|
|
<p>If you're reporting the issue in the LOOT application issue tracker, you can attach the log files to your report by dragging and dropping them into the report's text box, as explained <a href="https://help.github.com/articles/file-attachments-on-issues-and-pull-requests/">here</a>.</p>
|
|
|
|
<p>Otherwise, <a href="http://pastie.org/">a pastebin</a> can be used for logs smaller than 512 KB, or a service such as Dropbox, Google Drive, OneDrive, etc. can be used. Please don't use filesharing websites with countdown timers or captchas.</p>
|
|
|
|
<p>Note that LOOT wipes the log each time it starts, so if you encounter an issue, don't run LOOT again without first uploading or making a copy of the log.</p>
|
|
|
|
<h4>If you can't reach the settings dialog</h4>
|
|
|
|
<p>If LOOT is crashing on startup, or you can't get to its settings dialog for some other reason, its settings file can be manually edited to enable debug logging.</p>
|
|
|
|
<ol>
|
|
<li>Open <code>settings.toml</code> in a text editor, eg. Notepad.
|
|
<ul>
|
|
<li>On Windows, <code>settings.toml</code> can be found at <code>%LOCALAPPDATA%\LOOT\settings.toml</code>.</li>
|
|
<li>On Linux, <code>settings.toml</code> can be found at <code>$HOME/.var/app/io.github.loot.loot/data/LOOT/settings.toml</code> if you have LOOT installed as a Flatpak application, or at <code>$XDG_DATA_HOME/LOOT/settings.toml</code> otherwise.</li>
|
|
<li>If you use the <code>loot-data-path</code> command-line argument, open the <code>settings.toml</code> within your custom LOOT data directory.</li>
|
|
</ul>
|
|
<li>Replace the text <code>enableDebugLogging = false</code> with <code>enableDebugLogging = true</code>.</li>
|
|
<li>Save the file.</li>
|
|
</ol>
|
|
|
|
<p>Then run LOOT and upload your debug log as detailed above.</p>
|