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
2023-10-10 11:57:37 +03:00
parent e1d747183f
commit 7b4f8a4530
1 changed files with 13 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
Requirements-and-Installation.md

@@ -1,30 +1,27 @@
### Requirements
1) [REFramework](https://www.nexusmods.com/monsterhunterrise/mods/26) (v1.3.6 or above);
2) (Windows only) [REFramework Direct2D](https://www.nexusmods.com/monsterhunterrise/mods/134) (v0.4.0 or above).
1) **[REFramework](https://www.nexusmods.com/monsterhunterrise/mods/26)** (v1.503 or above);
2) (Optional) **[REFramework Direct2D](https://www.nexusmods.com/monsterhunterrise/mods/134)** (v0.4.0 or above).
[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.
**[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.
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. (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.
1. Install **[REFramework](https://www.nexusmods.com/monsterhunterrise/mods/26)**;
2. (Windows only) Install **[REFramework Direct2D](https://www.nexusmods.com/monsterhunterrise/mods/134)**;
* **Windows**: Works normally.
* **Linux**: Latest Experimental Proton seems to have it working normally as well (**[cursey/reframework-d2d#5](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](https://www.nexusmods.com/monsterhunterrise/mods/26?tab=description)**, **[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.
* 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.
Final paths should be like this:
MonsterHunterRise/reframework/autorun/MHR_Overlay.lua
MonsterHunterRise/reframework/autorun/MHR_Overlay/
![image](https://user-images.githubusercontent.com/30152047/164744647-068a9ef0-f753-4235-91d8-e3f8c73aadf8.png)
![image](https://user-images.githubusercontent.com/30152047/273835703-d10a9c48-5bf6-4761-a91c-ce8a46e5567a.png)
***