Updated FAQ (markdown)

GreenComfyTea
2022-04-22 18:42:27 +03:00
parent d692f3ff98
commit 4d78d21582

59
FAQ.md

@@ -1 +1,58 @@
...
**1. How do I install the mod?**
The overlay has 2 dependencies: REFramework and REFramework Direct2D. 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.
***
**2. What is the correct location of the mod?**
MonsterHunterRise/reframework/autorun is the correct location. Your final setup should look like on the picture below:
![image](https://user-images.githubusercontent.com/30152047/164744647-068a9ef0-f753-4235-91d8-e3f8c73aadf8.png)
***
**3. I also have another folder MonsterHunterRise/autorun. Can I use it instead?**
No. This is the mod folder in old version of REFramework. Please, refrain from using it and move all your mods to a new location: **MonsterHunterRise/reframework/autorun**.
***
**4. Can I use an older version of REFramework?**
No. The minimal version of REFramework required for this mod to work is v1.1.4.
***
**5. Can I use an older version of REFramework Direct2D?**
The minimal version of REFramework Direct2D required for this mod to work is v0.4.0.
***
**6. If I update the mod do I have to remake my config from zero?**
The mod has a limited support of old configs. It means that the mod will try to use your old config but remember that it may lead to errors and bugs. If you encountered something unusual after update, **deleting the config is the first thing to do**.
***
**7. Where is the config located?**
The config's location is: **MonsterHunterRise/reframework/data/MHR Overlay/config.json**. It will be generated automatically after first change of any parameters in the customization menu.
***
**8. I don't like the look of the mod. Can I change this thing and that thing?**
Yes. The mod features a broad set of customization options. Open REFramework menu (Insert key by default). Expand "Script Generated UI" and click on "MHR Overlay" button. The overlay's customization menu will open. Feel free to go thru all of the settings and adjust them to your liking and preference.
![image](https://user-images.githubusercontent.com/30152047/164748499-ed30644c-4334-4ccc-b04e-94beb570bd38.png)
***
**9. My FPS is low when I use this mod.**
This mod retrieves a lot of data and draws a lot of graphics on the screen. Performance impact is inevitable. You can sorta control it:
* Lower "Max Update Rate" in REFramework Direct2D menu. This will make it so graphics are being drawn at lower frame rate. Note that this will lead to severe jitter of dynamically drawn elements (dynamically positioned large monster UI, small monster UI and endemic life UI) if the value is lower than your monitor frequency;
* Lower "Customization Menu -> Global Settings -> Performance -> Max Monster Updates per Tick". This will make retrieving data from the game slower. Default is 2. Which is already pretty low.
***
**10. I encountered an issue but deleting the config didn't work. I want to report about the issue.**
Before reporting any issue - make sure it hasn't been reported already. The more info you provide the higher are the chances that I will be able to reproduce and fix it.
Things that will be helpful:
* **Description:** *Describe your problem, your actions and provide as much information as possible.*
* **OS, version and build:** *For ex., Windows 10 Professional Version 21H1 Build 19043.1466*
* **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*
* **Log file:** *link to the log file (MonsterHunterRise/re2_framework_log.txt)*
* **Screenshots:** *provide as many as possible, maybe even make a video*