Skip to content

Monster Hunter Rise Mod - Overlay mod that exposes internal game data about monsters, creatures, players, damage, buffs and debuffs.

License

Notifications You must be signed in to change notification settings

Squarelan/MHWs-YURI-Overlay

Β 
Β 

Repository files navigation

YURI Overlay

(Your Useless Rewilding Interface)

Mod for Monster Hunter Wilds


Exposes internal game data about monsters, endemic life, players, damage; and draws a highly customizable UI.

This mod is solely intended to empower players with means of self-improvement. Please don't use the information provided by this tool to make hurtful comments and actions toward other players.

Release Version Release Date
Build Nightly Version Nightly Date
Contributors Issues Issues Closed Pull Requests Pull Requests Closed
Platform Maintenance REFramework.NET Dependency .NET Dependency

Commits Last Commit Commits Since
Commit Activity (Year) Commit Activity (Month) Commit Activity (Week)

Repo Size Line Count COCOMO
Sponsors Watchers Forks Stars

Website Followers Twitter Twitch
Author License Open Source Written in

Preview

Links

Requirements

  1. REFramework
  2. REFramework.NET
  3. .NET Desktop Runtime 8.0.x

How to install:

  1. Install REFramework.NET;
  2. Install .NET Desktop Runtime 8.0.x;
  3. Download the mod:

    πŸ“Œ NOTE: Official release can be downloaded from here or Nexus Mods;
    πŸ“Œ NOTE: Nightly builds are available here and can contain broken functionality, debugging info on screen, bugs and might require the latest nightly build of REFramework.NET. Use with caution!

  4. Extract the mod from the archive and place it in /MonsterHunterWilds/ folder.

For Translators

The mod has support for localizations. If you wish to translate the mod, follow these steps:

  1. Go to \MonsterHunterWilds\reframework\data\YURI_Overlay\localizations\ folder. There should be en-US.json file. If not, launch the game once, the file will be regenerated;
  2. Copy-paste the file and give it a new name. Any format is supported but I expect it to be ISO language code for uniformity reasons;
  3. Open the file with any text editor and translate the strings;
  4. Specify Menu Font and Overlay Font (both are currently unused) and their respective Unicode glyph ranges.
  5. Make an issue/pull request, or dm me on nexus or Twitter, to submit your localization. I will check it and include it in the next release.

Important

Each localization must provide unicode glyph ranges for fonts to load. You can take the ranges here and here.

Important

Put the font you want to use in \MonsterHunterWilds\reframework\fonts\ folder. The font must be static. Only .OTF and .TTF fonts are supported.

Important

Font hot-reloading is not supported. So adding/changing a font will require game restart.

Development

  1. Install .NET SDK 8.0.x if it's not already installed;
  2. Clone the repo to your machine;
  3. Unzip *repo*\REFramework\plugins\managed\generated\REFramework.NET.application.zip. It is zipped to bypass 100MB max file size limit on github (I don't want to pay for git lfs);
  4. Open the project in Visual Studio 2022;
  5. ???
  6. PROFIT Build.

Credits

GreenComfyTea - creator of the mod and it's main contributor;
praydog - creator of REFramework, REFramework.NET;
cursey - contributor of REFramework;
squareblue - Simplified Chinese localization;
Krude - German localization.

Roadmap

  1. Large Monster Static UI;
  2. Large Monster Dynamic UI;
  3. Large Monster Stamina and Rage;
  4. Small Monster UI (Dynamic);
  5. Large Monster Map Pin + Targeted UIs;
  6. Font Management;
  7. Unicode Support (Partial by REFramework);
  8. Damage Meter UI;
  9. Image Support, Monster Icons, Weapon Icons, Crown Icons;
  10. Endemic Life UI;
  11. Large Monster UI Body Parts + Weak points;
  12. Large Monster UI Ailments;
  13. Stats UI;
  14. Player Buffs UI (Buffs, Debuffs, Song Timers).

Support

You can support me by donating! I would appreciate it! But anyway, thank you for using this mod!

Qries Qries

About

Monster Hunter Rise Mod - Overlay mod that exposes internal game data about monsters, creatures, players, damage, buffs and debuffs.

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • C# 100.0%