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 14:31:31 +03:00
parent 7e38e56a86
commit 907fb43b97
1 changed files with 5 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
Requirements-and-Installation.md

@@ -13,9 +13,11 @@ REFramework Direct2D is a REFramework plugin for drawing on-screen graphics. Whi
### Installation
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)**).
>**:pushpin: Windows:** Works normally.
>**:pushpin: Linux:** Latest Experimental Proton seems to have it working normally as well (https://github.com/cursey/reframework-d2d/issues/5).
>**:pushpin: 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)**, **[MHR Overlay](https://www.nexusmods.com/monsterhunterrise/mods/50)**).
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!