From 9925e50cdae7c2f1c41a03fb3e53c690a7574ed0 Mon Sep 17 00:00:00 2001 From: GreenComfyTea Date: Fri, 22 Apr 2022 18:16:25 +0300 Subject: [PATCH] Updated Requirements and Installation (markdown) --- Requirements-and-Installation.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/Requirements-and-Installation.md b/Requirements-and-Installation.md index 23fa7d3..aa1d56f 100644 --- a/Requirements-and-Installation.md +++ b/Requirements-and-Installation.md @@ -1 +1,16 @@ -k \ No newline at end of file +### 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. \ No newline at end of file