<p align="center">
	<h2 align="center"><b>"MHR Overlay" Mod for Monster Hunter: Rise</b></h2>
	<p align="center">Mod that exposes in-game data about monsters, creatures, players and damage. Draws a highly customizable UI.</p>
	<p align="center">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.</p>
</p>

<p align="center">
	<a href="https://github.com/greencomfytea/mhr-overlay/graphs/contributors">
		<img alt="Contributors" src="https://custom-icon-badges.demolab.com/github/contributors/greencomfytea/mhr-overlay?logo=person-add" />
	</a>
	<a href="https://github.com/greencomfytea/mhr-overlay/issues">
		<img alt="Issues" src="https://custom-icon-badges.demolab.com/github/issues/greencomfytea/mhr-overlay?logo=issue-opened" />
	</a>
	<a href="https://github.com/greencomfytea/mhr-overlay/issues">
		<img alt="Issues Closed" src="https://custom-icon-badges.demolab.com/github/issues-closed/greencomfytea/mhr-overlay?logo=issue-closed" />
	</a>
	<a href="https://github.com/greencomfytea/mhr-overlay/pulls">
		<img alt="Pull Requests" src="https://custom-icon-badges.demolab.com/github/issues-pr/greencomfytea/mhr-overlay?logo=git-pull-request" />
	</a>
	<a href="https://github.com/greencomfytea/mhr-overlay/pulls">
		<img alt="Pull Requests Closed" src="https://custom-icon-badges.demolab.com/github/issues-pr-closed/greencomfytea/mhr-overlay?logo=git-pull-request-closed" />
	</a>
	<br>
	<a href="https://github.com/greencomfytea/mhr-overlay/blob/main/LICENSE">
		<img alt="License" src="https://custom-icon-badges.demolab.com/github/license/greencomfytea/mhr-overlay?logo=law" />
	</a>
	<a href="https://github.com/greencomfytea/mhr-overlay/releases">
		<img alt="Release Version" src="https://custom-icon-badges.demolab.com/github/v/release/greencomfytea/mhr-overlay?logo=tag" />
	</a>
	<a href="https://github.com/greencomfytea/mhr-overlay/releases">
		<img alt="Release Date" src="https://custom-icon-badges.demolab.com/github/release-date/greencomfytea/mhr-overlay?logo=clock" />
	</a>
	<a href="">
		<img alt="Platform" src="https://custom-icon-badges.demolab.com/badge/platform-win%20%7C%20linux%20%7C%20steam%20deck-blue?logo=device-desktop" />
	</a>
	<a href="">
		<img alt="Maintenance" src="https://custom-icon-badges.demolab.com/maintenance/yes/2023?logo=tools" />
	</a>
	<br>
	<a href="https://www.nexusmods.com/monsterhunterrise/mods/26">
		<img alt="REFramework Dependency" src="https://custom-icon-badges.demolab.com/badge/dependency-REFramework%20v1.503%2B-green?logo=package-dependencies" />
	</a>
   	<a href="https://www.nexusmods.com/monsterhunterrise/mods/134">
		<img alt="REFramework Direct2D Dependency" src="https://custom-icon-badges.demolab.com/badge/dependency-REFramework%20Direct2D%20v0.4.0%2B-yellow?logo=package-dependencies" />
	</a>
	<br>
	<br>
	<a href="https://github.com/greencomfytea/mhr-overlay/commits/main">
		<img alt="Commits" src="https://custom-icon-badges.demolab.com/github/commit-activity/t/greencomfytea/mhr-overlay?logo=git-commit" />
	</a>
	<a href="https://github.com/greencomfytea/mhr-overlay/commits/main">
		<img alt="Last Commit" src="https://custom-icon-badges.demolab.com/github/last-commit/greencomfytea/mhr-overlay?logo=git-commit" />
	</a>
	<a href="https://github.com/greencomfytea/mhr-overlay/commits/main">
		<img alt="Commits Since" src="https://custom-icon-badges.demolab.com/github/commits-since/greencomfytea/mhr-overlay/latest?logo=git-commit" />
	</a>
	<br>
	<a href="https://github.com/greencomfytea/mhr-overlay/graphs/commit-activity">
		<img alt="Commit Activity (Year)" src="https://custom-icon-badges.demolab.com/github/commit-activity/y/greencomfytea/mhr-overlay?logo=pulse" />
	</a>
	<a href="https://github.com/greencomfytea/mhr-overlay/graphs/commit-activity">
		<img alt="Commit Activity (Month)" src="https://custom-icon-badges.demolab.com/github/commit-activity/m/greencomfytea/mhr-overlay?logo=pulse" />
	</a>
	<a href="https://github.com/greencomfytea/mhr-overlay/graphs/commit-activity">
		<img alt="Commit Activity (Week)" src="https://custom-icon-badges.demolab.com/github/commit-activity/w/greencomfytea/mhr-overlay?logo=pulse" />
	</a>
	<br>
	<br>
	<a href="">
		<img alt="Repo Size" src="https://custom-icon-badges.demolab.com/github/repo-size/greencomfytea/mhr-overlay?logo=database" />
	</a>
	<a href="">
		<img alt="Line Count" src="https://sloc.xyz/github/greencomfytea/mhr-overlay" />
	</a>
	<a href="">
		<img alt="COCOMO" src="https://sloc.xyz/github/greencomfytea/mhr-overlay/?category=cocomo" />
	</a>
	<a href="">
		<img alt="Goto Counter" src="https://custom-icon-badges.demolab.com/github/search/greencomfytea/mhr-overlay/goto?logo=git-compare" />
	</a>
	<br>
	<a href="https://github.com/sponsors/greencomfytea">
		<img alt="Sponsors" src="https://custom-icon-badges.demolab.com/github/sponsors/greencomfytea?logo=heart" />
	</a>
	<a href="https://github.com/GreenComfyTea/mhr-overlay/watchers">
		<img alt="Watchers" src="https://custom-icon-badges.demolab.com/github/watchers/greencomfytea/mhr-overlay?logo=eye" />
	</a>
	<a href="https://github.com/greencomfytea/mhr-overlay/forks">
		<img alt="Forks" src="https://custom-icon-badges.demolab.com/github/forks/greencomfytea/mhr-overlay?logo=repo-forked" />
	</a>
	<a href="https://github.com/greencomfytea/mhr-overlay/stargazers">
		<img alt="Stars" src="https://custom-icon-badges.demolab.com/github/stars/greencomfytea/mhr-overlay?logo=star" />
	</a>
	<a href="https://github.com/greencomfytea/mhr-overlay/graphs/traffic">
		<img alt="Hits" src="https://custom-icon-badges.demolab.com/endpoint?url=https://hits.dwyl.com/greencomfytea/mhr-overlay.json?color=blue&logo=eye" />
	</a>
	<br>
	<br>
	<a href="https://www.nexusmods.com/monsterhunterrise/mods/50">
		<img alt="Website" src="https://custom-icon-badges.demolab.com/website?down_color=red&down_message=down&up_color=brightgreen&up_message=up&logo=link&url=https://www.nexusmods.com/monsterhunterrise/mods/50" />
	</a>
	<a href="https://github.com/greencomfytea?tab=followers">
		<img alt="Followers" src="https://custom-icon-badges.demolab.com/github/followers/greencomfytea?logo=people" />
	</a>
	<a href="https://twitter.com/greencomfytea">
		<img alt="Twitter" src="https://img.shields.io/twitter/follow/greencomfytea?logo=twitter" />
	</a>
	<a href="https://www.twitch.tv/greencomfytea">
		<img alt="Twitch" src="https://img.shields.io/twitch/status/greencomfytea?logo=twitch" />
	</a>
	<br>
	<a href="https://github.com/greencomfytea">
		<img alt="Author" src="https://custom-icon-badges.demolab.com/badge/author-GreenComfyTea-green?logo=person" />
	</a>
	<a href="https://github.com/topics/open-source">
		<img alt="Open Source" src="https://img.shields.io/badge/open%20source-%20yes-brightgreen?logo=openvpn" />
	</a>
	<a href="https://cursey.github.io/reframework-book/index.html#lua-scripting">
		<img alt="Written in" src="https://custom-icon-badges.demolab.com/badge/written in-lua-000080?logo=terminal" />
	</a>
</p>

<p align="center">
	<a>
		<img align="center" src="https://user-images.githubusercontent.com/30152047/183250401-9f2898dd-feb4-4903-802c-c9d398261f11.png" />
	</a>
</p>

# 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.503+);
2. [REFramework Direct2D](https://www.nexusmods.com/monsterhunterrise/mods/134) (v0.4.0+) - Needed for Unicode Support.

# How to install:
1. Install [REFramework](https://www.nexusmods.com/monsterhunterrise/mods/26);
2. Install [REFramework Direct2D](https://www.nexusmods.com/monsterhunterrise/mods/134);
>**: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](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)).

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, mcc1** - Traditional Chinese translation.  
**etnAtker**, **sukiqwq** - Simplified Chinese translation.  
**AKILAND0214** - Japanese 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.twitch.tv/panel-48897356-image-c6155d48-b689-4240-875c-f3141355cb56">
</a>
<a href="https://ko-fi.com/greencomfytea">
  <img alt="Qries" src="https://panels.twitch.tv/panel-48897356-image-c2fcf835-87e4-408e-81e8-790789c7acbc">
</a>
