GithubHelp home page GithubHelp logo

dorielrivalet / mhfz-overlay Goto Github PK

View Code? Open in Web Editor NEW

This project forked from imulion/mhfz_overlay

19.0 2.0 2.0 302.7 MB

A simple, customizable overlay with Discord Rich Presence integration for Monster Hunter Frontier Z on Windows

License: MIT License

C# 99.50% Shell 0.01% JavaScript 0.10% Ruby 0.15% Python 0.17% Lua 0.07% Makefile 0.01%
monster-hunter-frontier wpf-application game-overlay rich-presence game-statistics monster-hunter game-wiki damage-calculation damage-calculator sqlite-database mhf catppuccin speedrun-timer speedrun-tool speedrun speedrunning

mhfz-overlay's Introduction

Monster Hunter Frontier Z Overlay

GitHub all releases

Monster Hunter Frontier Z Overlay v0.21.0 Preview

About

This project aims to provide a simple, customizable overlay for Monster Hunter Frontier Z on Windows, with the added bonus of Discord Rich Presence integration. The overlay allows players to keep track of their in-game stats and progress, as well as providing a convenient way to access various tools and resources.

The overlay is highly configurable, with a wide range of options available to suit the needs of individual players and speedrunners alike. It is also constantly being updated and improved, so be sure to check back for the latest features and fixes.

We hope you find this overlay useful and enjoyable, and we welcome any feedback or suggestions you may have. Happy hunting!

System Requirements

Minimum

  • OS: Windows 10 (64-bit)
  • Processor: Intel® Core™ i3-4130 or Core™ i5-3470
  • Memory: 6 GB RAM
  • Storage: 500 MB available space
  • Additional Notes: 1080p/30fps when refresh rate is set to 1. System requirements subject to change during software development.

Recommended

  • OS: Windows 10 (64-bit)
  • Processor: Intel® Core™ i5-4460 or better
  • Memory: 6 GB RAM
  • Storage: 500 MB available space
  • Additional Notes: 1080p/30fps when refresh rate is set to 30. System requirements subject to change during software development.

Please note that these system requirements are estimates and may vary based on your specific hardware configuration. If you encounter any performance issues or have different hardware specifications, please provide feedback or send an issue for assistance. We appreciate your input in helping us improve the overlay's compatibility with a wider range of hardware setups.

If you record and/or stream with the overlay, the recommended processor is Intel® Core™ i7 or better.

Installation

  1. Download the latest version from the Releases.
  2. Make sure Windows or your antivirus did not delete the file (because it reads the game's memory, Windows might detect it as a trojan, so you might have to get it out of quarantine).
  3. Run MHFZ_Overlay-win-Setup.exe as Administrator.
  4. Bonk monsters!
  5. Be sure to leave some feedback here!

Note

It's recommended to start the overlay when you are done loading into Mezeporta.

View CHANGELOG.md.

View Release Statistics.

DISCLAIMER

If you obtained the mhfz-overlay software from any source other than GitHub releases, please be aware that there are no guarantees that the program has the same code as the version in this repository, nor that it was created by the same individual(s), or that it represents the latest version.

We strongly recommend that you verify the authenticity and integrity of the software by comparing the SHA-256 checksum we provide against the checksum of the software you have obtained. The SHA-256 checksum can be found in the GitHub release notes and can be used to ensure that the software you are using matches the code in this repository. We assume no responsibility for any issues or problems that may arise from the use of software obtained from other sources.

How to check the downloaded file hashes.

Misconceptions

  1. Is the overlay malware?
  2. Does X overlay feature slow down my computer?
  3. Does the overlay affect the game?
  4. Does this monster really have 30,000 HP?
  5. Does the database slow down my computer?

Hotkeys

  • Shift+F1 Open Configuration.
  • Shift+F5 Restart Overlay.
  • Shift+F6 Exit.

As an alternative to hotkeys, you can use the system tray options by right-clicking the icon.

System Tray options

Quick Troubleshooting

  • Use the Configuration Preset option for quickly setting up your configuration.

Preset

  • If you have slow performance, lower the refresh rate from 30 to 1.

  • If the monster HP shown is less than what its actual values should be, restart both the game and the overlay. If the HP shows 0/1 then change area for it to load. If the issue still occurs, change the Effective HP Corrector's minimum and maximum thresholds or disable Effective HP.

  • If you are having issues with the damage numbers when hitting the monster, change Damage Numbers Mode from Automatic to True Damage.

  • If you want the overlay to use the least memory possible, you can decide to not open the configuration window. If you want to change settings, then open the configuration window, edit settings, click save and restart the overlay.

  • Press Alt+Enter if your screen resolution got lowered.

  • If you have screen issues when starting the overlay, first press Alt+Enter in-game, load the overlay, then press Alt+Enter in-game again. Also make sure that the UAC prompts do not cause issues in your computer, and that you have the correct operating system permissions.

  • If you are having performance issues, lower the overlay resolution and refresh rate. Also try setting Rendering Mode to Software or Hardware.

  • If you are playing on multiplayer, keep in mind that is not fully supported.

  • Fully reinstalling the game or .NET dependencies may fix some bugs.

  • If the overlay doesn't seem to load values properly, restart it. If that didn't fix the issue, please send information here.

  • Additionally, if information from the overlay is wrong or inaccurate (e.g. monster parts labels), feel free to send an issue.

Features

  • Monster Effective HP Bars (e.g. Burning Freezing Elzelion's 1,000,000 HP!).

You can also see the monster icons or renders, and there is an option for automatic bar colors depending on the monster. You can adjust the font size, color, family and weight; in addition to that you can hide/show any sub-component. Includes Hardcore and Unlimited icons.

Monster HP Bars 1 Monster HP Bars 2

  • Sharpness Numbers (colorized by current sharpness tier!).

Sharpness Numbers 1 Sharpness Numbers 2 Sharpness Numbers 3

  • Quest Timer (Two modes: elapsed time and time left. Down to the milliseconds in accuracy!).
  • Hit Count (counts Reflect, Stylish Up, Heatblade, Fencing+2 and more!).

Player Stats

Includes icons!

Player Stats Icons

  • Player Input (KBM + Gamepad).

Player Input

Gamepad Input

  • Player Stats Graphs (Actions per Minute, Damage Per Second, Hits per Second and True Raw!).

Player APM Player Graphs

  • Player True Raw (currently highest value shown in red!).

Player Attack

  • Monster Stats + Icons (attack multiplier, defense rate and size!).

Monster Stats Monster Stats Icons

  • Monster Status Ailments + Icons (Poison, Sleep, Paralysis, Blast, Stun!).

Monster Ailments Monster Ailments Icons

  • Monster Body Parts (up to 10 parts!).

Monster Body Parts

  • Damage Numbers (dynamic colors and size!).

Damage Numbers

Buffs with Timers

  • Diva Song and Guild Food timers. Keep track of your buffs!

Discord Rich Presence Discord Rich Presence

Discord Rich Presence

Discord Rich Presence

Discord Rich Presence

  • Run Category Watermarks and Personal Best Times for your speedrun videos!

Watermarks

  • Quest Runs Database (check weapon usage, set YouTube URLs, view past statistics, etc.!)

Weapon Usage

Compendium of Personal Statistics

Calendar

Top 20

Gear

Graphs

Most Recent

YouTube

Quest Pace

Inventories

  • Also includes personal best times by date and by attempts! The total frames elapsed are shown in the graph.

Personal Best by Attempts

Important: It is recommended to make a backup of the MHFZ_Overlay.sqlite file periodically. The file is located inside the database folder, which is inside your game folder.

Configuration Preview

These images don't show everything, find out what's missing by pressing Shift+F1!

Hunter Sets (Text)

Config1

Hunted Logs

Config2

Monster Speedruns, Hitzones and Wiki

Config3

Ferias

Config4

Guild Card

Config5

Hunter Sets (Image)

Config6

Damage Calculator

Config7

Achievements

achievements

Context Menus

Some sections have context menus where you can save the section contents to a file or copy to clipboard as either an image or text. In order to view the context menus you have to right click on the section contents. To see if a section has these context menus, hover over the section contents and a tooltip will show, saying "Right-click for more options".

contextmenu1 contextmenu2

contextmenu3 contextmenu4 contextmenu5

Features not yet implemented

  • Choose which player to load data from.
  • Auto detect which player is playing.
  • Selecting monsters for body parts and monster status.
  • Allow lock-on to be used to select monsters.
  • Add shortcut for saving.
  • Automatically set default positions according to screen resolution.
  • Global damage number labels.
  • Attach user interface to game window option.
  • Sharpness graph.
  • Language options.
  • PvP addresses.
  • Handle multiple objectives information.
  • Zenith information in Road.
  • Raviente Support Part Info.
  • Armor Set Website links.
  • Sky Corridor.
  • Drag and Drop multiple selection.
  • Sharpness tables.
  • Gear rarity colors in hunter info stats.

Check more possible future features here.

Bugs

  • Monster stats are sometimes outside of the screen (if they don't show at all even if you open the config menu, this is probably your issue).
  • With Monster EHP enabled, if you cart, the max EHP turns into the current EHP, along with some other stats max values.
  • Sometimes when exiting Drag and Drop the monster HP information disappears.
  • Spawning in the same area as the monster doesn't load the information properly. Fix: re-enter area.
  • Duremudira/Road/Raviente HP not showing. Fix: enable Always Show Monster Info, load another quest showing the HP bars (not just the numbers), then retry.
  • Monster size values not shown correctly.
  • Monster HP values are less than the actual values when not loading properly.
  • Damage numbers over 1000 not working.
  • Yamas and Berukyurosu information not working.

Check more bugs here.

Frequently Asked Questions

FAQ.

How to Uninstall

  1. Go to Apps & Features.
  2. Search Monster Hunter Frontier Z Overlay.
  3. Click Uninstall. You can also delete the Desktop shortcut and Start Menu icon after uninstalling.

Changelog

Learn about the latest improvements.

Documentation

This repository includes two main documentation files:

  • FAQ.md: This file is meant for end-users and provides information about how to use and troubleshoot the software. If you're new to the software, we recommend starting here.

  • docs/README.md: This file is meant for developers and technical users who are contributing to the project or working on the codebase. It contains information about the software's intricacies, as well as instructions for deploying the project.

We recommend consulting the appropriate documentation file based on your needs. If you have any questions or issues, feel free to contact us for support.

Contributing

Learn about how to contribute.

Project Development

GitHub Projects.

Code Analysis

SonarCloud

Code Smells Lines of Code Coverage Technical Debt Quality Gate Status Reliability Rating Duplicated Lines (%) Vulnerabilities Bugs Security Rating Maintainability Rating

CodeFactor

Repository Overview

Build Status CircleCI GitHub code size in bytes GitHub repo size wakatime

Automate Git Stats

Repository Commits Stats 1

Repository Commits Stats 2

Repository Commits Stats 3

Repository Commits Stats 4

Generated thanks to the following scripts

Ruby Python Lua

Feedback

Google Forms.

License

MIT.

Acknowledgements

  • This project is directly inspired from the overlay created by suzaku01.
  • The theme and color palette used for the application is Catppuccin Mocha.
  • The design and icons used in this project are part of Segoe Fluent Icons and WPF UI.
  • The fonts used is the in-game one, MS Gothic. For monospaced, the application uses Source Code Pro and MesloLGM NF. This project also uses Font Awesome's fonts. The Monster Hunter font made by XMitsarugiX comes from here.
  • Thanks to Kairi and Sera for extensive beta testing and early support.
  • The combo element icons are made by Narwhaler.
  • Additional icons can be found here.

Avatar Avatar Avatar Avatar Avatar Avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.