# Monster Hunter Rise Overlay Mod
**This mod is solely intended to empower players with means of self-improvement. Please don't use the information provided by this tool to make hurtful comments and actions toward other players.**

# Links
* **[Nexus Mods](https://www.nexusmods.com/monsterhunterrise/mods/50)**  
* **[Wiki](https://github.com/GreenComfyTea/MHR-Overlay/wiki)**  
* **[FAQ](https://github.com/GreenComfyTea/MHR-Overlay/wiki/FAQ)**  
* **[Requirements and Installation](https://github.com/GreenComfyTea/MHR-Overlay/wiki/Requirements-and-Installation)**  
* **[Features](https://github.com/GreenComfyTea/MHR-Overlay/wiki/Features)**  
* **[Troubleshooting](https://github.com/GreenComfyTea/MHR-Overlay/wiki/Troubleshooting)**  

# Requirements
1. [REFramework](https://www.nexusmods.com/monsterhunterrise/mods/26)﻿ (v1.2.7 or above);
2. [REFramework Direct2D](https://www.nexusmods.com/monsterhunterrise/mods/134) (v0.4.0 or above).

# How to install:
1. Install [REFramework](https://www.nexusmods.com/monsterhunterrise/mods/26)﻿;
2. (Windows only) Install [REFramework Direct2D](https://www.nexusmods.com/monsterhunterrise/mods/134);
>**:pushpin: NOTE:**  Skip this step if you are using Steam Deck/Proton/Wine/Linux. REFramework Direct2D **must not** be installed for the mod to work.
3. Download the mod:
    * Official release can be downloaded from [Nexus Mods](https://www.nexusmods.com/monsterhunterrise/mods/50);
    * Nightly builds are available in [this repo](https://github.com/GreenComfyTea/MHR-Overlay) and can contain broken functionality, debugging info on screen, bugs and might require the latest [nightly build](https://github.com/praydog/REFramework-nightly/releases) of [REFramework](https://www.nexusmods.com/monsterhunterrise/mods/26). Use with caution!
4. Extract the mod from the archive and place it in MonsterHunterRise folder. Refer to [FAQ](https://github.com/GreenComfyTea/MHR-Overlay/wiki/FAQ) to verify how the file hierarchy should look like if everything is done correctly.

# Credits
**GreenComfyTea** - creator of the mod and it's main contributor.
**cursecat** - creator of [REFramework](https://www.nexusmods.com/monsterhunterrise/mods/26), [REFramework Direct2D](https://www.nexusmods.com/monsterhunterrise/mods/134) plugin and [Monster Has HP Bar](https://www.nexusmods.com/monsterhunterrise/mods/43) mod, which provided an example on how to retrieve monster HP data.  
**praydog2** - creator of [REFramework](https://www.nexusmods.com/monsterhunterrise/mods/26). Contributed huge improvements to the performance of the mod.  
**coavins** - creator of [coavins damage meter](https://www.nexusmods.com/monsterhunterrise/mods/68) mod.  
  
**neatnet** - Korean translation.  
**s9000008** - Traditional Chinese translation.  
**etnAtker** - Simplified Chinese translation.
***
# Support

You can support me by donating! I would appreciate it! But anyway, thank you for using this mod!

 <a href="https://streamelements.com/greencomfytea/tip">
  <img alt="Qries" src="https://panels-images.twitch.tv/panel-48897356-image-c6155d48-b689-4240-875c-f3141355cb56">
</a>
<a href="https://ko-fi.com/greencomfytea">
  <img alt="Qries" src="https://panels-images.twitch.tv/panel-48897356-image-c2fcf835-87e4-408e-81e8-790789c7acbc">
</a>

