wofsauge / IsaacDocs

API Documentation for "The Binding of Isaac: Repentance" Link: https://wofsauge.github.io/IsaacDocs/
https://docs.moddingofisaac.com
94 stars 110 forks source link

An interactive faq to fix common installation and bug report issues #379

Closed wofsauge closed 1 year ago

wofsauge commented 1 year ago

Because of an increase in people failing to install and properly reporting issues, here a new feature idea.

A web page with a simple questionnaire style ui, where you find quick fixes for common mod problems.

Example:

Issue: "Mod not working" Questions:

Can you see the mod in the mods menu?

The goal is to guide the user thru the debug process easily and understandable

jsgnextortex commented 1 year ago

Here is a simplified flowchart that should cover a lot of cases, it will direct to the next question unless the answer is the one with the --, then it will just stop there.

  1. Can you see a Mods menu in your main menu screen? --No: You Need AB+ at least

  2. Does the mod in question appear on the mods menu? --No: Make sure you properly subscribe to the mod and then relaunch the game. If you dont own the game on steam then head to the folder where the game is installed and check if your mod is properly copied into the "mods" folder, if its not there then copy it.

3- Is the name of the mod in question faint color and washed out in the mods list? --Yes: Press tab on the mod's list until mods become dark, if the mod in question is still faint then scroll down and press space on it until its dark.

  1. Most of your current mods also wont work?. If so, Have you tried verifying the game files? --No: Verify the game files and try again.

  2. Do you see any errors in the console or log? Yes: Make sure to copy these errors (including the numbers after the :) or screenshot them, then share them with the mod author.

  3. Do you have the debug console on or do you know where the log file is? --No: and the lod file is in Documents/Tboi Repentance/log.txt.

  4. In case you checked the log, was the game opened between you finding the issue and you checking the log? --Yes: Dont do that, try to replicate the issue and then immediately check the log after it happens(if the game crashes dont open it again until you check the log).

  5. Report your issue to the author and be as explicit as possible. If you have a way to replicate the issue, please explain it step by step.

wofsauge commented 1 year ago

Feature was added to the FAQ section now :)