How to Submit a Bug Report - hakasapl/PGPatcher GitHub Wiki

Please include any and all relevant information in your bug report as outlined below. We can help figure out how to fix a bug (if it is confirmed to be one) much faster if you follow this page.

Verification

  1. Make sure PG plugins are the last thing in your loose file order and plugin order except for dyndolod/texgen.
  2. Make sure the issue you are experiencing is actually due to PG by disabling the PG output and checking if it still happens or not.

Diagnostic File

First check Advanced Options. Then check the Enable Diagnostics option. After generating, you will now have a ParallaxGen_DIAG.json file. Please provide this file. Zipping it up might make it much smaller.

Mesh Identification

If the issue is with a specific mesh in-game, it is important to note which mesh it is in your bug report. You can find this information using the mod More Informative Console. When you click on an object in-game it will tell you the mesh in the top left corner. Please include this mesh file from the PG output if it exists in your bug report and specify the full path of the NIF in your report as well. Remember that PG sometimes duplicates meshes. You should hold shift while hovering over the NIF file in more informative console and it will give you the full path.

For Crash-To-Desktop (CTD) issues of PG

If yes, make sure to attach the crash dump that should have generated in the log folder to your bug report.

For Crash-To-Desktop (CTD) issues IN-GAME caused by PG

First, validate that PG is indeed the issue by disabling the output mod and verifying that the issue no longer occurs in-game.

Please generate a crash dump using this mod. Open the crash log and search for any reference to .nif. It may take a few crashes for a relevant .nif entry to show up in the crash dump. If you can find the model (.nif file) in the crash dump, please submit a bug report here with both the crash log and any models that are referenced in the crash dump. CTDs are almost never user-error and most likely would need to be investigated by PG authors. There is no need to continue this guide if this is the case.

Minimum Reproducible

Sometimes you might be asked to provide a minimum reproducible is the issue cannot be reproduced by PG developers. In this case you can follow this procedure to find a reproducible as quickly as possible.

You should define a minimum set of mods, if any, that are required to reproduce the bug you are reporting on. We can't hunt through your load orders here. A good technique to finding out which mod is causing the bug is to use the binary search method:

  1. Disable half your mods
  2. If the bug occurs, disable the other half instead
  3. If the bug doesn't occur, re-enable half the mods you had disabled
  4. Keep going until you are left with a single mod or a minimum set of mods

Even with a 1000 mod list, this will only require 10 iterations so it is relatively quick to do.