FAQ - GreenComfyTea/MHR-Overlay GitHub Wiki

1. How do I install the mod?

The overlay has 2 dependencies: REFramework and (optional but recommended) REFramework Direct2D.

  1. Install REFramework;
  2. Install REFramework Direct2D;

:pushpin: Windows: Works normally.

:pushpin: Linux: Latest Experimental Proton seems to have it working normally as well (https://github.com/cursey/reframework-d2d/issues/5).

:pushpin: 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, REFramework Direct2D, MHR Overlay).

  1. Download the mod from nexusmods;
  2. Extract the mod from the archive and place it in MonsterHunterRise folder. Refer to No. 2 to verify how the file hierarchy should look like if everything is done correctly.

Refer to 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:

image

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.503.

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 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 through all of the settings and adjust them to your liking and preference.

image

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.

10. 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. I do everything within my capabilities to optimize the mod and improve performance. 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. 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.

The game doesn't store damage values. They are collected manually and locally. There is no synchronization between mod users. Different numbers are expected.

  • The game has it's limitations. Damage is calculated on host. "Basically, your damage will always be accurate since you're the local player (unless you desync with the host), but other peoples damage will seem lower for you because the game doesn't send every hit damage to everyone in the party" (c) Haato.
  • Your PC specs, network quality and load, the mod performance, REFramework performance, the game performance, the game's networking logic etc. are affecting the damage hooking.

13. I encountered an issue but deleting the config didn't work. I want to report about the issue or ask for help.

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.

  • Description: Describe your problem, provide as much information as possible;
  • Reproduction steps: Step by step describe how the issue can be reproduced on a regular basis;
  • OS, version and build: For ex., Windows 10 Professional Version 21H1 Build 19043.1466;
  • Game version: Version of the game;
  • REFramework version: Version of REFramework;
  • 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 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.

14. RAM usage is high.

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. 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.

  • Linux: Latest Experimental Proton seems to have it working normally as well (cursey/reframework-d2d#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, REFramework Direct2D).