romanmir/MHR-Overlay
1
0
Fork 0
mirror of https://github.com/GreenComfyTea/MHR-Overlay.git synced 2026-01-24 04:18:11 -08:00
Code Issues Packages Projects Releases Wiki Activity

Updated Requirements and Installation (markdown)

GreenComfyTea
2022-04-22 18:16:25 +03:00
parent 567ed6da17
commit 9925e50cda
1 changed files with 16 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
Requirements-and-Installation.md

@@ -1 +1,16 @@
k
### Requirements:
1) [REFramework](https://www.nexusmods.com/monsterhunterrise/mods/26) (v1.1.4 or above);
2) [REFramework Direct2D](https://www.nexusmods.com/monsterhunterrise/mods/134) (v0.4.0 or above).
Both requirements are mandatory. Without them the mod won't work. 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:
1. Install [REFramework](https://www.nexusmods.com/monsterhunterrise/mods/26);
2. Install [REFramework Direct2D](https://www.nexusmods.com/monsterhunterrise/mods/134);
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.