romanmir/MHR-Overlay
1
0
Fork 0
mirror of https://github.com/GreenComfyTea/MHR-Overlay.git synced 2026-01-24 04:18:11 -08:00
Code Issues Packages Projects Releases Wiki Activity

Updated FAQ (markdown)

GreenComfyTea
2023-10-10 11:54:52 +03:00
parent 8b7c93bf46
commit e1d747183f
1 changed files with 42 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

69
FAQ.md

@@ -1,51 +1,62 @@
### 1. How do I install the mod?
The overlay has 2 dependencies: [REFramework](https://www.nexusmods.com/monsterhunterrise/mods/26) and (optional) [REFramework Direct2D](https://www.nexusmods.com/monsterhunterrise/mods/134).
On windows install the latest versions of both first.
On Steam Deck/Linux/Proton/Wine only install [REFramework](https://www.nexusmods.com/monsterhunterrise/mods/26). REFramework Direct2D **must not** be installed for the mod to work.
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 (optional but recommended) **[REFramework Direct2D](https://www.nexusmods.com/monsterhunterrise/mods/134)**.
1. Install **[REFramework](https://www.nexusmods.com/monsterhunterrise/mods/26)**;
2. Install **[REFramework Direct2D](https://www.nexusmods.com/monsterhunterrise/mods/134)**;
* **Windows**: Works normally.
* **Linux**: Latest Experimental Proton seems to have it working normally as well (**[cursey/reframework-d2d#5](https://github.com/cursey/reframework-d2d/issues/5)**).
* **Steam Deck**: I've seen people getting it working but I don't have the exact instructions. You will have to figure it out yourself and/or search the nexus pages for information (**[REFramework](https://www.nexusmods.com/monsterhunterrise/mods/26?tab=description)**, **[REFramework Direct2D](https://www.nexusmods.com/monsterhunterrise/mods/134)**).
3. Download the mod from **[nexusmods](https://www.nexusmods.com/monsterhunterrise/mods/50)**;
4. Extract the mod from the archive and place it in MonsterHunterRise folder. Refer to **[No. 2](https://github.com/GreenComfyTea/MHR-Overlay/wiki/FAQ/_edit#2-what-is-the-correct-location-of-the-mod)** to verify how the file hierarchy should look like if everything is done correctly.
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.
**Vortex is not supported! Vortex is known for causing problems and should be avoided at all cost! I am not responsible for any problems you encounter if you use it!**
***
### 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:
**/MonsterHunterRise/reframework/autorun/** is the correct location. Your final setup should look like on the picture below:
![image](https://github.com/GreenComfyTea/MHR-Overlay/assets/30152047/d10a9c48-5bf6-4761-a91c-ce8a46e5567a)
![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?
### 3. I also have another folder **/MonsterHunterRise/autorun/**. Can I use it instead?
No. This is the mod folder in old version of **[REFramework](https://www.nexusmods.com/monsterhunterrise/mods/26)**. Please, refrain from using it and move all your mods to a new location: **/MonsterHunterRise/reframework/autorun/**.
No. This is the mod folder in old version of [REFramework](https://www.nexusmods.com/monsterhunterrise/mods/26). 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](https://www.nexusmods.com/monsterhunterrise/mods/26)?
### 4. Can I use an older version of **[REFramework](https://www.nexusmods.com/monsterhunterrise/mods/26)**?
No. The minimal version of **[REFramework](https://www.nexusmods.com/monsterhunterrise/mods/26)** required for this mod to work is **v1.503**.
No. The minimal version of [REFramework](https://www.nexusmods.com/monsterhunterrise/mods/26) required for this mod to work is v1.503.
***
### 5. Can I use an older version of [REFramework Direct2D](https://www.nexusmods.com/monsterhunterrise/mods/134)?
### 5. Can I use an older version of **[REFramework Direct2D](https://www.nexusmods.com/monsterhunterrise/mods/134)**?
The minimal version of **[REFramework Direct2D](https://www.nexusmods.com/monsterhunterrise/mods/134)** required for this mod to work is **v0.4.0**.
The minimal version of [REFramework Direct2D](https://www.nexusmods.com/monsterhunterrise/mods/134) required for this mod to work is v0.4.0.
On Steam Deck/Linux/Proton/Wine it **must not** be installed at all for mod to work.
***
### 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.
***
### 7. Where are config files located?
The location for configs is: **/MonsterHunterRise/reframework/data/MHR Overlay/configs/**. The default config will be generated automatically after first launch.
***
### 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.
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 through all of the settings and adjust them to your liking and preference.
![image](https://github.com/GreenComfyTea/MHR-Overlay/assets/30152047/8ef136a0-bba2-4e00-89c0-522944d45521)
![image](https://user-images.githubusercontent.com/30152047/164748499-ed30644c-4334-4ccc-b04e-94beb570bd38.png)
***
### 9. Can I move the overlay to another monitor?
No, unfortunately displaying the overlay on other monitors is impossible. The overlay exists and is being drawn inside the game itself. You will have to use an external overlay like HunterPie.
No, unfortunately displaying the overlay on other monitors is impossible. The overlay exists and is being drawn inside the game itself. You will have to use an external overlay like HunterPie.
***
### 10. My FPS is low when I use this mod.
@@ -54,13 +65,17 @@ This mod retrieves a lot of data and draws a lot of graphics on the screen. Perf
* Lower "Max Update Rate" in [REFramework Direct2D](https://www.nexusmods.com/monsterhunterrise/mods/134) 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". Thou its already set to a very low number of 2 by default.
* Lower `Customization Menu -> Global Settings -> Performance -> Max Monster Updates per Tick`. Thou its already set to a very low number of 2 by default.
* Disable UIs that are not essential to you. For example, Small Monster UI or Endemic Life UI. The mod is only retrieving data if the module is visible. The only exception is Damage Meter because there is no data to retrieve, the mod has to collect it manually.
* Increase `Customization Menu -> Global Settings -> Performance -> Timer Delays`. Note that in this case the mod will update data at a lower rate.
***
### 11. Is there a way to send damage statistics in chat?
No. And it will never be implemented, because I think It can bring unnecessary toxicity to the game.
***
### 12. Damage Meter shows incorrect numbers.
@@ -81,7 +96,7 @@ Before reporting any issue - make sure it hasn't been reported already. The more
* **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 and their versions;*
* **Config file:** *Link to your config file (MonsterHunterRise/reframework/data/MHR Overlay/config.json)* (if you have it);
* **Config file:** *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.*
@@ -89,17 +104,17 @@ Before reporting any issue - make sure it hasn't been reported already. The more
***
### 14. RAM usage is high.
Update REFramework to v1.3.7.
Update REFramework to **v1.3.7** or higher.
***
### 15. How to use the mod on Gamepass version of the game?
Gamepass version is not officially supported since its outdated and doesn't even include sunbreak. I won't be doing anything to support it until it catches up with Steam version. It may circumstantially work but you will have to figure out how to make it work yourself.
Gamepass version is not officially supported it's version is behind. I won't be doing anything to support it until it catches up with Steam version. It may circumstantially work but you will have to figure out how to make it work yourself.
***
### 16. Does REFramework Direct2D work on platforms other than Windows?
Yes.
**On Linux:** Latest Experimental Proton seems to have it working normally ([cursey/reframework-d2d#5](https://github.com/cursey/reframework-d2d/issues/5)).
**Steam Deck:** I've seen people getting it working but I don't have the exact instructions. You will have to figure it out yourself and/or search the nexus pages for information ([REFramework](https://www.nexusmods.com/monsterhunterrise/mods/26?tab=description), [REFramework Direct2D](https://www.nexusmods.com/monsterhunterrise/mods/134), [MHR Overlay](https://www.nexusmods.com/monsterhunterrise/mods/50)).
* **Linux**: Latest Experimental Proton seems to have it working normally as well (**[cursey/reframework-d2d#5](https://github.com/cursey/reframework-d2d/issues/5)**).
* **Steam Deck**: I've seen people getting it working but I don't have the exact instructions. You will have to figure it out yourself and/or search the nexus pages for information (**[REFramework](https://www.nexusmods.com/monsterhunterrise/mods/26?tab=description)**, **[REFramework Direct2D](https://www.nexusmods.com/monsterhunterrise/mods/134)**).