Requirements
- REFramework (v1.503 or above);
- (Optional) REFramework Direct2D (v0.4.0 or above).
REFramework is mandatory. Without it the mod won't work.
REFramework Direct2D is optional, but the mod is designed with it in mind.
Install them accordingly to their installation guides.
REFramework is a modding tool/framework that exposed in-game values and functions. It also runs the Lua scripting system, for which this mod was written for.
REFramework Direct2D is a REFramework plugin for drawing on-screen graphics. While the framework already has such functionality built-in, this plugin looks better imo and has unicode font support necessary for korean/japanese/chinese/etc.
Installation
- Install REFramework;
- (Windows only) Install REFramework Direct2D;
📌 Windows: Works normally.
📌 Linux: Latest Experimental Proton seems to have it working normally as well (https://github.com/cursey/reframework-d2d/issues/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, MHR Overlay).
- Download the mod:
- Official release can be downloaded from Nexus Mods;
- Nightly builds are available in this repo and can contain broken functionality, debugging info on screen, bugs and might require the latest nightly build of REFramework. Use with caution!
- Extract the mod from the archive and place it in MonsterHunterRise folder.
Final paths should be like this:
