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-06-21 12:08:27 +03:00
parent 72b7ebdb51
commit 91a4c9102b
1 changed files with 8 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
Requirements-and-Installation.md

@@ -1,8 +1,12 @@
### Requirements
1) [REFramework](https://www.nexusmods.com/monsterhunterrise/mods/26) (v1.2 or above);
2) [REFramework Direct2D](https://www.nexusmods.com/monsterhunterrise/mods/134) (v0.4.0 or above).
2) (Windows only) [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](https://www.nexusmods.com/monsterhunterrise/mods/26) is mandatory. Without it the mod won't work.
[REFramework Direct2D](https://www.nexusmods.com/monsterhunterrise/mods/134) is optional, but the mod is designed with it in mind.
Install them accordingly to their installation guides.
* **On Windows:** It's advised to have REF Direct2D installed.
* **On Steam Deck/Linux/Wine/Proton:** REF Direct2D **MUST NOT** be installed for the mod to work.
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.
@@ -10,7 +14,8 @@ REFramework Direct2D is a REFramework plugin for drawing on-screen graphics. Whi
### Installation
1. Install [REFramework](https://www.nexusmods.com/monsterhunterrise/mods/26);
2. Install [REFramework Direct2D](https://www.nexusmods.com/monsterhunterrise/mods/134);
2. (Windows only) Install [REFramework Direct2D](https://www.nexusmods.com/monsterhunterrise/mods/134);
>**:pushpin: NOTE:** Skip this step if you are using Steam Deck/Proton/Wine/Linux. REFramework Direct2D **must not** be installed for the mod to work.
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!