Updated Troubleshooting (markdown)

GreenComfyTea
2023-10-10 11:59:07 +03:00
parent 7b4f8a4530
commit 47949d8e2c

@@ -1,23 +1,29 @@
Here are some tips on how to act in case something is not working correctly.
***
### 1. Verify that 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.
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.
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.
### 2. Delete the config files.
This is the first action to take if something break after an update!
Config location: **MonsterHunterRise/reframework/data/MHR Overlay/config.json**.
Config location: **MonsterHunterRise/reframework/data/MHR Overlay/configs/**.
***
### 3. Update.
* Update the [mod](https://www.nexusmods.com/monsterhunterrise/mods/50).
* Update the dependencies [REFramework](https://www.nexusmods.com/monsterhunterrise/mods/26) and [REFramework Direct2D](https://www.nexusmods.com/monsterhunterrise/mods/134) to the latest versions. You can try using [REFramework Nightly Build](https://github.com/praydog/REFramework-nightly/releases).
* Update the **[mod](https://www.nexusmods.com/monsterhunterrise/mods/50)**.
* Update the dependencies **[REFramework](https://www.nexusmods.com/monsterhunterrise/mods/26)** and **[REFramework Direct2D](https://www.nexusmods.com/monsterhunterrise/mods/134)** to the latest versions. You can try using **[REFramework Nightly Build](https://github.com/praydog/REFramework-nightly/releases)**.
* Update your GPU drivers, Windows, etc.
***
### 4. Verify integrity of the game files.
***
### 5. Uninstall all other mods.
***
If nothing helped and you are sure it's the mod fault, you can create a bug report in this repo or leave a post on Nexus Mods. Please, provide as much info as possible.
@@ -26,7 +32,7 @@ If nothing helped and you are sure it's the mod fault, you can create a bug repo
* **PC Specs:** *Your CPU, amount of RAM, Graphics Card etc.*
* **Your in-game settings:** *Provide at least your display settings*
* **Other mods:** *List of other mods you are using*
* **Config file:** *link to your config file (MonsterHunterRise/reframework/data/MHR Overlay/config.json)* (if you have it)
* **Config files:** *link to your config files (MonsterHunterRise/reframework/data/MHR Overlay/configs/)* (if you have it)
* **Log file:** *link to the log file (MonsterHunterRise/re2_framework_log.txt)*
* **Crash dump file:** *link to the crash dump file (MonsterHunterRise/reframework_crash.dmp)* (if you have it)
* **Screenshots:** *provide as many as possible, maybe even make a video*