8 Commits

Author SHA1 Message Date
GreenComfyTea
ea29e20a2c Update README.md 2023-06-10 20:39:20 +03:00
GreenComfyTea
0a84471abc Update README.md 2023-06-10 18:49:22 +03:00
GreenComfyTea
da2af8671a Update README.md 2023-06-10 18:47:56 +03:00
GreenComfyTea
474d0b9eb8 Update README.md 2023-06-10 18:45:12 +03:00
GreenComfyTea
e4057b84f5 Update README.md 2023-06-10 18:38:57 +03:00
GreenComfyTea
3ac048aef9 Update README.md 2023-06-10 18:29:22 +03:00
GreenComfyTea
9c3085198d Update README.md 2023-06-10 18:26:27 +03:00
GreenComfyTea
ecf119dd97 Update README.md 2023-06-10 17:48:58 +03:00

118
README.md
View File

@@ -1,10 +1,111 @@
# "MHR Overlay" Mod for Monster Hunter: Rise
<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>
Exposes in-game data about monsters, creatures, players and damage. Draws a highly customizable UI.
<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 href="">
<img alt="Platform" src="https://img.shields.io/badge/platform-win%20%7C%20linux%20%7C%20steam%20deck-lightgrey" />
</a>
<a href="">
<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 href="">
<img alt="Repo Size" src="https://img.shields.io/github/repo-size/greencomfytea/mhr-overlay" />
</a>
<a href="">
<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 href="">
<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 href="">
<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>
**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.**
![50-1659789731-551420562](https://user-images.githubusercontent.com/30152047/183250401-9f2898dd-feb4-4903-802c-c9d398261f11.png)
<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)**
@@ -15,8 +116,8 @@ Exposes in-game data about monsters, creatures, players and damage. Draws a high
* **[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.
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);
@@ -33,7 +134,7 @@ Exposes in-game data about monsters, creatures, players and damage. Draws a high
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.
**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.
@@ -53,4 +154,3 @@ You can support me by donating! I would appreciate it! But anyway, thank you for
<a href="https://ko-fi.com/greencomfytea">
<img alt="Qries" src="https://panels.twitch.tv/panel-48897356-image-c2fcf835-87e4-408e-81e8-790789c7acbc">
</a>