diff --git a/Troubleshooting.md b/Troubleshooting.md new file mode 100644 index 0000000..cec22af --- /dev/null +++ b/Troubleshooting.md @@ -0,0 +1,13 @@ +Here are some tips on how to act in case something is not working correctly. +*** +### 1. Verify the mod is installed correctly. + +The overlay has 2 dependencies: [REFramework](https://www.nexusmods.com/monsterhunterrise/mods/26) and [REFramework Direct2D](https://www.nexusmods.com/monsterhunterrise/mods/134). Install the latest versions of those first. After it is done, download the overlay and simply unzip the downloaded archive into the game's root folder. + +Refer to [Requirements and Installation](https://github.com/GreenComfyTea/MHR-Overlay/wiki/Requirements-and-Installation) page for more detailed guide. +*** +### 2. Delete the config file. +This is the first action to take if something break after an update! +Config location: **MonsterHunterRise/reframework/data/MHR Overlay/config.json**. +*** +### 3. Update [REFramework](https://www.nexusmods.com/monsterhunterrise/mods/26) and [REFramework Direct2D](https://www.nexusmods.com/monsterhunterrise/mods/134) to the latest versions.