mirror of
https://github.com/GreenComfyTea/MHR-Overlay.git
synced 2026-01-23 20:08:05 -08:00
155 lines
8.7 KiB
Markdown
155 lines
8.7 KiB
Markdown
<p align="center">
|
|
<h2 align="center"><b>"MHR Overlay" Mod for Monster Hunter: Rise<b/></h2>
|
|
<p align="center">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://img.shields.io/github/contributors/greencomfytea/mhr-overlay" />
|
|
</a>
|
|
<a href="https://github.com/greencomfytea/mhr-overlay/issues">
|
|
<img alt="Issues" src="https://img.shields.io/github/issues/greencomfytea/mhr-overlay" />
|
|
</a>
|
|
<a href="https://github.com/greencomfytea/mhr-overlay/issues">
|
|
<img alt="Issues Closed" src="https://img.shields.io/github/issues-closed/greencomfytea/mhr-overlay" />
|
|
</a>
|
|
<a href="https://github.com/greencomfytea/mhr-overlay/pulls">
|
|
<img alt="Pull Requests" src="https://img.shields.io/github/issues-pr/greencomfytea/mhr-overlay" />
|
|
</a>
|
|
<a href="https://github.com/greencomfytea/mhr-overlay/pulls">
|
|
<img alt="Pull Requests Closed" src="https://img.shields.io/github/issues-pr-closed/greencomfytea/mhr-overlay" />
|
|
</a>
|
|
</p>
|
|
<p align="center">
|
|
<a href="https://github.com/GreenComfyTea/MHR-Overlay/blob/main/LICENSE">
|
|
<img alt="License" src="https://img.shields.io/github/license/greencomfytea/mhr-overlay" />
|
|
</a>
|
|
<a href="https://github.com/GreenComfyTea/MHR-Overlay/releases">
|
|
<img alt="Release Version" src="https://img.shields.io/github/v/release/greencomfytea/mhr-overlay" />
|
|
</a>
|
|
<a href="https://github.com/GreenComfyTea/MHR-Overlay/releases">
|
|
<img alt="Release Date" src="https://img.shields.io/github/release-date/greencomfytea/mhr-overlay" />
|
|
</a>
|
|
<a>
|
|
<img alt="Platform" src="https://img.shields.io/badge/platform-win%20%7C%20linux%20%7C%20steam%20deck-lightgrey" />
|
|
</a>
|
|
<a>
|
|
<img alt="Maintenance" src="https://img.shields.io/maintenance/yes/2023" />
|
|
</a>
|
|
</p>
|
|
<p align="center">
|
|
<a href="https://www.nexusmods.com/monsterhunterrise/mods/26">
|
|
<img alt="REFramework Dependency" src="https://img.shields.io/badge/dependency-REFramework%20v1.503%2B-green" />
|
|
</a>
|
|
<a href="https://www.nexusmods.com/monsterhunterrise/mods/134">
|
|
<img alt="REFramework Direct2D Dependency" src="https://img.shields.io/badge/dependency-REFramework%20Direct2D%20v0.4.0%2B-yellow" />
|
|
</a>
|
|
</p>
|
|
<p align="center">
|
|
<a>
|
|
<img alt="Repo Size" src="https://img.shields.io/github/repo-size/greencomfytea/MHR-Overlay" />
|
|
</a>
|
|
<a>
|
|
<img alt="Goto Counter" src="https://img.shields.io/github/search/greencomfytea/MHR-Overlay/goto" />
|
|
</a>
|
|
<a href="https://github.com/sponsors/GreenComfyTea">
|
|
<img alt="Sponsors" src="https://img.shields.io/github/sponsors/greencomfytea" />
|
|
</a>
|
|
<a>
|
|
<img alt="Watchers" src="https://img.shields.io/github/watchers/greencomfytea/mhr-overlay" />
|
|
</a>
|
|
<a href="https://github.com/GreenComfyTea/MHR-Overlay/forks">
|
|
<img alt="Forks" src="https://img.shields.io/github/forks/greencomfytea/mhr-overlay" />
|
|
</a>
|
|
<a>
|
|
<img alt="Stars" src="https://img.shields.io/github/stars/greencomfytea/mhr-overlay" />
|
|
</a>
|
|
</p>
|
|
<p align="center">
|
|
<a href="https://github.com/GreenComfyTea/MHR-Overlay/commits/main">
|
|
<img alt="Last Commit" src="https://img.shields.io/github/last-commit/greencomfytea/mhr-overlay" />
|
|
</a>
|
|
<a href="https://github.com/GreenComfyTea/MHR-Overlay/commits/main">
|
|
<img alt="Commits Since" src="https://img.shields.io/github/commits-since/greencomfytea/mhr-overlay/latest" />
|
|
</a>
|
|
<a href="https://github.com/GreenComfyTea/MHR-Overlay/graphs/commit-activity">
|
|
<img alt="Commit Activity" src="https://img.shields.io/github/commit-activity/t/greencomfytea/mhr-overlay" />
|
|
</a>
|
|
<a href="https://github.com/GreenComfyTea/MHR-Overlay/graphs/commit-activity">
|
|
<img alt="Commit Activity (Year)" src="https://img.shields.io/github/commit-activity/y/greencomfytea/mhr-overlay" />
|
|
</a>
|
|
<a href="https://github.com/GreenComfyTea/MHR-Overlay/graphs/commit-activity">
|
|
<img alt="Commit Activity (Month)" src="https://img.shields.io/github/commit-activity/m/greencomfytea/mhr-overlay" />
|
|
</a>
|
|
<a href="https://github.com/GreenComfyTea/MHR-Overlay/graphs/commit-activity">
|
|
<img alt="Commit Activity (Week)" src="https://img.shields.io/github/commit-activity/w/greencomfytea/mhr-overlay" />
|
|
</a>
|
|
</p>
|
|
<p align="center">
|
|
<a href="https://www.nexusmods.com/monsterhunterrise/mods/50">
|
|
<img alt="Website" src="https://img.shields.io/website?down_color=red&down_message=down&up_color=green&up_message=up&url=https://www.nexusmods.com/monsterhunterrise/mods/50" />
|
|
</a>
|
|
<a href="https://github.com/GreenComfyTea?tab=followers">
|
|
<img alt="Followers" src="https://img.shields.io/github/followers/greencomfytea" />
|
|
</a>
|
|
<a href="https://twitter.com/GreenComfyTea">
|
|
<img alt="Twitter" src="https://img.shields.io/twitter/follow/GreenComfyTea" />
|
|
</a>
|
|
<a href="https://www.twitch.tv/GreenComfyTea">
|
|
<img alt="Twitch" src="https://img.shields.io/twitch/status/greencomfytea" />
|
|
</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 or above);
|
|
2. [REFramework Direct2D](https://www.nexusmods.com/monsterhunterrise/mods/134) (v0.4.0 or above) - 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>
|
|
|