How to Report a Bug

+ --------------------+
| How to Report a Bug |
+---------------------+

Did you find a bug in Racing+ or another Binding of Isaac mod? This guide is for you.

First off, thank you for reporting the bug. By taking the time to investigate and report bugs, you make the mod better for everybody.

Before reporting a bug, it's essential that you do some investigation first in order to narrow down the problem. Perform the following steps.



Step 1 - Save the Log

- When you play the game, Isaac writes information to a file called "log.txt". By default, it is located at:
  C:\Users\[username]\Documents\My Games\Binding of Isaac Repentance\log.txt
- As soon as the bug happens, back up the log.txt file. This is because as soon as you reopen the game, the log.txt will be deleted.
- The log.txt file can contain useful information to identify what the actual bug was, like a specific error message or a reference to the line number of the code that the error happened on.
- When you report the bug, provide the log.txt to the developer.

Step 2 - Reproduce the Bug

- In the log file, you can find the seed of the run that you were playing when the bug happened. The corresponding line will look something like this:
  [INFO] - RNG Start Seed: H7YQ 8ZRB (814190760) [New, 1]
- Start a new run from scratch and replay the seed. Perform all of the same steps that you did again EXACTLY.
- Does the bug happen again?
  - If yes, then move on to step 3.
  - If no, then it will be difficult for the developer to fix the problem. Try to perform some more investigation and experimentation, using the debug console as needed, to try and replicate the bug in a different way. You can also check the log.txt file to see if there are any errors in it. (Do a Ctrl + f for "error".) If there are no errors in the log and you cannot replicate the bug whatsoever, there you can still report the error to the developer, but there's probably nothing at that they can do.

Step 3 - Reproduce the Bug Again Minimally

- Isaac comes with a debug console so that you can easily give yourself any item, warp to any room, warp to any floor, and so on. See the wiki for more details on how to use the debug console.
- Using the debug console, reproduce the bug again, but now instead of following the EXACT steps from your original run, just warp directly there and try to reproduce the bug.
- Does the bug happen again?
  - If yes, then try to remove one part of the setup to see if that part is actually necessary for the bug to happen.
  - If no, then try to add one part of the setup from before to see if that part is actually necessary for the bug to happen.
- This goal is to find the ABSOLUTE MINIMUM amount of steps that is necessary to reproduce the bug.
- If you are using the console, compile all of the console commands together so that the mod developer can copy paste those commands into their own console.

Step 4 - Provide the Minimal Steps to Reproduce

- Provide the minimal steps to reproduce to the mod developer, along with the copy of the log.txt.
- If you are reporting a bug for Racing+, then do it in the #bugs channel on the Isaac speedrunning discord: https://discord.gg/JzbhWQb