diff --git a/CHANGELOG.md b/CHANGELOG.md index bfca827f..23adfb1b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,20 @@ +## [0.37.1](https://github.com/DorielRivalet/MHFZ_Overlay/compare/v0.37.0...v0.37.1) (2024-02-28) + + +### Bug Fixes + +* game patches ([4dab1a4](https://github.com/DorielRivalet/MHFZ_Overlay/commit/4dab1a46c2b8c6af78c1431eb496a8212803dc9b)) + + +### For Developers + +* bump version ([5786589](https://github.com/DorielRivalet/MHFZ_Overlay/commit/57865899e80b0de24be75a20f46973b0ce1ecc8f)) +* update FAQ.md ([ac1918a](https://github.com/DorielRivalet/MHFZ_Overlay/commit/ac1918aac18b798e29dae3f9fddf15c3cb297199)) +* update FAQ.md ([8ba94fb](https://github.com/DorielRivalet/MHFZ_Overlay/commit/8ba94fbff3f7e845ce9d1c42e7a31af7f748b548)) +* update README.md ([873d7d7](https://github.com/DorielRivalet/MHFZ_Overlay/commit/873d7d731e6bb20117e41a5f380c32aee6e1e3d7)) + ## [0.37.0](https://github.com/DorielRivalet/MHFZ_Overlay/compare/v0.36.1...v0.37.0) (2024-02-22) diff --git a/FAQ.md b/FAQ.md index 98b346ee..3ae5d2ec 100644 --- a/FAQ.md +++ b/FAQ.md @@ -67,24 +67,24 @@ Use the preset option found in the General tab. Keep reading if you want to know Run Buffs are the buffs that you can filter by when searching for quests: -| Name | Value | -|---------------------------|-------| -| Halk | 1 | -| Poogie Item | 2 | -| Diva Song | 4 | -| Halk Pot Effect | 8 | -| Bento | 16 | -| Guild Poogie | 32 | -| Active Feature | 64 | -| Guild Food | 128 | -| Diva Skill | 256 | -| Secret Technique | 512 | -| Diva Prayer Gem | 1024 | -| Course Attack Boost | 2048 | -| All | 4095 | -| Time Attack | 183 | -| Freestyle No Secret Tech | 1527 | -| Freestyle With Secret Tech | 2039 | +| Name | Value | +| -------------------------- | ----- | +| Halk | 1 | +| Poogie Item | 2 | +| Diva Song | 4 | +| Halk Pot Effect | 8 | +| Bento | 16 | +| Guild Poogie | 32 | +| Active Feature | 64 | +| Guild Food | 128 | +| Diva Skill | 256 | +| Secret Technique | 512 | +| Diva Prayer Gem | 1024 | +| Course Attack Boost | 2048 | +| All | 4095 | +| Time Attack | 183 | +| Freestyle No Secret Tech | 1527 | +| Freestyle With Secret Tech | 2039 | If you had the old categories in your runs, these are their run buffs equivalents: @@ -94,13 +94,13 @@ If you had the old categories in your runs, these are their run buffs equivalent When you set the overlay mode to Speedrun, the run buffs value or tag will be displayed on watermark in parentheses. Tags that are submitted to leaderboard will be: -|Name|Tag|Value|Buffs| -|-|-|-|-| -|Time Attack|TA|183|Halk + Poogie Item + Diva Song + Bento + Guild Poogie + Guild Food| -|Freestyle Diva Skill|FDS|503|TA + Diva Skill + Active Feature| -|Freestyle Diva Prayer Gem|FDP|1527|FDS + Diva Prayer Gem| -|Freestyle Secret Tech|FST|2039|FDP + Secret Technique| -|Freestyle Course Attack Boost|FCA|4095|FST + Course Attack Boost + Halk Pot Effect| +| Name | Tag | Value | Buffs | +| ----------------------------- | --- | ----- | ------------------------------------------------------------------ | +| Time Attack | TA | 183 | Halk + Poogie Item + Diva Song + Bento + Guild Poogie + Guild Food | +| Freestyle Diva Skill | FDS | 503 | TA + Diva Skill + Active Feature | +| Freestyle Diva Prayer Gem | FDP | 1527 | FDS + Diva Prayer Gem | +| Freestyle Secret Tech | FST | 2039 | FDP + Secret Technique | +| Freestyle Course Attack Boost | FCA | 4095 | FST + Course Attack Boost + Halk Pot Effect | On quests where you cannot use diva skills but you use active feature, it counts as TA, making it a requirement. @@ -161,7 +161,7 @@ In the folder where `MHFZ_Overlay.exe` is (or in the `app-x.y.z` folder), there ## Does this software support other operating systems? -As detailed in the program's *about* section, this software is meant for Windows 10. It might work with other versions of Windows, but it may function with less stability. +As detailed in the program's _about_ section, this software is meant for Windows 10. It might work with other versions of Windows, but it may function with less stability. ## The software messed up my computer or my game, what should I do? @@ -204,7 +204,7 @@ If after updating at overlay startup your settings did not transfer over, try re ### Graphical User Interface 1. Download [DevToys](https://www.microsoft.com/store/apps/9PGCV4V3BK4W). -2. In *DevToys*: Go to Generators > Checksum. +2. In _DevToys_: Go to Generators > Checksum. 3. Enable Uppercase. 4. Select SHA256 as Hashing Algorithm. 5. Drag and drop the file. @@ -248,191 +248,191 @@ If DS4Windows does not work for you, you can search for alternatives, but it is ## How does this overlay compare to other Monster Hunter overlays? -| | mhf-z overlay v0.25.0 (DorielRivalet) | MHFZ_Overlay v0.1.0 (Imulion) | mhf_displayer v1.6.2 (suzaku01) | -|:----------|:---------:|:---------:|:---------:| -|Discord Rich Presence|✔️|❌|❌| -|Rich Presence Quest Name|✔️|❌|❌| -|Rich Presence Hunter Stats|✔️ Hit Count, etc.|❌|❌| -|Monster HP|✔️|✔️|✔️| -|Monster Effective HP|✔️|❌|❌| -|Monster Parts|✔️|❌|✔️| -|Monster Attack|✔️|✔️|✔️| -|Monster Defense|✔️|✔️|✔️| -|Monster Size|✔️|✔️|✔️| -|Monster Ailments|✔️|✔️|✔️| -|Timer Options|✔️|❌|✔️| -|Sharpness Number|✔️|❌|❌| -|Damage Numbers|✔️|✔️|✔️| -|Damage Numbers Options|✔️|❌|❌| -|DPS Graph|✔️|❌|❌| -|Actions per Minute Graph|✔️|❌|❌| -|True Raw Graph|✔️|❌|❌| -|Hits/s Graph|✔️|❌|❌| -|Hit Count|✔️|✔️|✔️| -|Hits/s|✔️|❌|❌| -|Block Count|✔️|❌|❌| -|Blocks/s|✔️|❌|❌| -|True Raw|✔️|✔️|✔️| -|Actions per Minute|✔️|❌|❌| -|Attempts Counter|✔️|❌|❌| -|Quest Runs Youtube Link|✔️|❌|❌| -|Personal Best Time|✔️|❌|❌| -|Personal Best Attempts|✔️|❌|❌| -|Completions Counter|✔️|❌|❌| -|Run Pace|✔️ Color|❌|❌| -|Quest Pace Graph|✔️|❌|❌| -|Player Coordinates|✔️|❌|❌| -|Settings Save on Update|✔️|❌|❌| -|Save Stats to File|✔️|❌|❌| -|Copy Stats to Clipboard|✔️|❌|❌| -|Multiplayer Stats|❌|❌|❌| -|Quest Runs Database|✔️|❌|❌| -|Database Backups|✔️ Local|❌|❌| -|Past Quests Info|✔️|❌|❌| -|Achievements|✔️|❌|❌| -|Show Quest Change|✔️|❌|❌| -|Show Area Change|✔️|❌|❌| -|KBM Layout|✔️|❌|❌| -|Gamepad Layout|✔️|❌|❌| -|Input Logs|✔️|❌|❌| -|Quest ID|✔️|❌|❌| -|Session Time|✔️|❌|❌| -|Gear Info|✔️|❌|❌| -|Map Info|✔️|❌|❌| -|Font Options|✔️|✔️|✔️| -|Localization|❌|❌|❌| -|System Tray|✔️|❌|❌| -|Auto-Close|✔️|❌|❌| -|Performance Options|✔️|❌|❌| -|Auto-Update|✔️|❌|❌| -|Hotkeys|✔️|✔️|✔️| -|Auto-Hide|✔️ Unfocused option|✔️|✔️| -|Drag and Drop|✔️|✔️|❌| -|Logging|✔️|❌|❌| -|Logging Options|✔️|❌|❌| -|Color Options|✔️|✔️|✔️| -|Buff Icons |✔️|❌|❌| -|Debuff Icons |❌|❌|❌| -|Hub Activities|❌|❌|❌| -|Settings Search|❌|❌|❌| -|Settings Presets|✔️|❌|❌| -|Settings Onboarding|✔️|❌|❌| -|Overlay Watermark|✔️|❌|❌| -|Website|❌|❌|❌| -|Branding|❌ WIP|❌|❌| -|End-User Documentation|✔️|❌|❌| -|Technical Documentation|Incomplete|❌|❌| -|License File|✔️ MIT|❌ |✔️ MIT | -|Unit Testing|❌ WIP|❌|❌| -|Changelog|✔️|❌|❌| -|GitHub Actions|✔️|❌|❌| -|Issue Template|✔️|❌|❌| -|Pull Request Template|✔️|❌|❌| -|Contributing File|✔️|❌|❌| -|GitHub Milestones|✔️|❌|❌| -|GitHub Projects|✔️|❌|❌| -|Code Analysis|✔️ [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=DorielRivalet_MHFZ_Overlay&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=DorielRivalet_MHFZ_Overlay)|❌|❌| -|Code Size|![img](https://img.shields.io/github/languages/code-size/dorielrivalet/mhfz-overlay)|![img](https://img.shields.io/github/languages/code-size/imulion/mhfz_overlay)|![img](https://img.shields.io/github/languages/code-size/suzaku01/mhf_displayer)| -|#1 Contributor Commits|DorielRivalet 593 (+523,769 -460,614)|Imulion 14 (+3,427 -5)|suzaku01 68 (+9,745 -6,084)| -|Contributors|4|1|1| -|Commits|![img](https://img.shields.io/github/commit-activity/y/dorielrivalet/mhfz-overlay)|![img](https://img.shields.io/github/commit-activity/y/imulion/mhfz_overlay)|![img](https://img.shields.io/github/commit-activity/y/suzaku01/mhf_displayer)| -|Last Commit|![img](https://img.shields.io/github/last-commit/dorielrivalet/mhfz-overlay)|![img](https://img.shields.io/github/last-commit/imulion/mhfz_overlay)|![img](https://img.shields.io/github/last-commit/suzaku01/mhf_displayer)| -|Lines of Code|74405|![img](https://vercel-tokei-git-main-dorielrivalet.vercel.app/tokei/github/imulion/mhfz_overlay)|![img](https://vercel-tokei-git-main-dorielrivalet.vercel.app/tokei/github/suzaku01/mhf_displayer)| -|Comments|4187|![img](https://vercel-tokei-git-main-dorielrivalet.vercel.app/tokei/github/imulion/mhfz_overlay?category=comments)|![img](https://vercel-tokei-git-main-dorielrivalet.vercel.app/tokei/github/suzaku01/mhf_displayer?category=comments)| +| | mhf-z overlay v0.25.0 (DorielRivalet) | MHFZ_Overlay v0.1.0 (Imulion) | mhf_displayer v1.6.2 (suzaku01) | +| :------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------: | +| Discord Rich Presence | ✔️ | ❌ | ❌ | +| Rich Presence Quest Name | ✔️ | ❌ | ❌ | +| Rich Presence Hunter Stats | ✔️ Hit Count, etc. | ❌ | ❌ | +| Monster HP | ✔️ | ✔️ | ✔️ | +| Monster Effective HP | ✔️ | ❌ | ❌ | +| Monster Parts | ✔️ | ❌ | ✔️ | +| Monster Attack | ✔️ | ✔️ | ✔️ | +| Monster Defense | ✔️ | ✔️ | ✔️ | +| Monster Size | ✔️ | ✔️ | ✔️ | +| Monster Ailments | ✔️ | ✔️ | ✔️ | +| Timer Options | ✔️ | ❌ | ✔️ | +| Sharpness Number | ✔️ | ❌ | ❌ | +| Damage Numbers | ✔️ | ✔️ | ✔️ | +| Damage Numbers Options | ✔️ | ❌ | ❌ | +| DPS Graph | ✔️ | ❌ | ❌ | +| Actions per Minute Graph | ✔️ | ❌ | ❌ | +| True Raw Graph | ✔️ | ❌ | ❌ | +| Hits/s Graph | ✔️ | ❌ | ❌ | +| Hit Count | ✔️ | ✔️ | ✔️ | +| Hits/s | ✔️ | ❌ | ❌ | +| Block Count | ✔️ | ❌ | ❌ | +| Blocks/s | ✔️ | ❌ | ❌ | +| True Raw | ✔️ | ✔️ | ✔️ | +| Actions per Minute | ✔️ | ❌ | ❌ | +| Attempts Counter | ✔️ | ❌ | ❌ | +| Quest Runs Youtube Link | ✔️ | ❌ | ❌ | +| Personal Best Time | ✔️ | ❌ | ❌ | +| Personal Best Attempts | ✔️ | ❌ | ❌ | +| Completions Counter | ✔️ | ❌ | ❌ | +| Run Pace | ✔️ Color | ❌ | ❌ | +| Quest Pace Graph | ✔️ | ❌ | ❌ | +| Player Coordinates | ✔️ | ❌ | ❌ | +| Settings Save on Update | ✔️ | ❌ | ❌ | +| Save Stats to File | ✔️ | ❌ | ❌ | +| Copy Stats to Clipboard | ✔️ | ❌ | ❌ | +| Multiplayer Stats | ❌ | ❌ | ❌ | +| Quest Runs Database | ✔️ | ❌ | ❌ | +| Database Backups | ✔️ Local | ❌ | ❌ | +| Past Quests Info | ✔️ | ❌ | ❌ | +| Achievements | ✔️ | ❌ | ❌ | +| Show Quest Change | ✔️ | ❌ | ❌ | +| Show Area Change | ✔️ | ❌ | ❌ | +| KBM Layout | ✔️ | ❌ | ❌ | +| Gamepad Layout | ✔️ | ❌ | ❌ | +| Input Logs | ✔️ | ❌ | ❌ | +| Quest ID | ✔️ | ❌ | ❌ | +| Session Time | ✔️ | ❌ | ❌ | +| Gear Info | ✔️ | ❌ | ❌ | +| Map Info | ✔️ | ❌ | ❌ | +| Font Options | ✔️ | ✔️ | ✔️ | +| Localization | ❌ | ❌ | ❌ | +| System Tray | ✔️ | ❌ | ❌ | +| Auto-Close | ✔️ | ❌ | ❌ | +| Performance Options | ✔️ | ❌ | ❌ | +| Auto-Update | ✔️ | ❌ | ❌ | +| Hotkeys | ✔️ | ✔️ | ✔️ | +| Auto-Hide | ✔️ Unfocused option | ✔️ | ✔️ | +| Drag and Drop | ✔️ | ✔️ | ❌ | +| Logging | ✔️ | ❌ | ❌ | +| Logging Options | ✔️ | ❌ | ❌ | +| Color Options | ✔️ | ✔️ | ✔️ | +| Buff Icons | ✔️ | ❌ | ❌ | +| Debuff Icons | ❌ | ❌ | ❌ | +| Hub Activities | ❌ | ❌ | ❌ | +| Settings Search | ❌ | ❌ | ❌ | +| Settings Presets | ✔️ | ❌ | ❌ | +| Settings Onboarding | ✔️ | ❌ | ❌ | +| Overlay Watermark | ✔️ | ❌ | ❌ | +| Website | ❌ | ❌ | ❌ | +| Branding | ❌ WIP | ❌ | ❌ | +| End-User Documentation | ✔️ | ❌ | ❌ | +| Technical Documentation | Incomplete | ❌ | ❌ | +| License File | ✔️ MIT | ❌ | ✔️ MIT | +| Unit Testing | ❌ WIP | ❌ | ❌ | +| Changelog | ✔️ | ❌ | ❌ | +| GitHub Actions | ✔️ | ❌ | ❌ | +| Issue Template | ✔️ | ❌ | ❌ | +| Pull Request Template | ✔️ | ❌ | ❌ | +| Contributing File | ✔️ | ❌ | ❌ | +| GitHub Milestones | ✔️ | ❌ | ❌ | +| GitHub Projects | ✔️ | ❌ | ❌ | +| Code Analysis | ✔️ [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=DorielRivalet_MHFZ_Overlay&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=DorielRivalet_MHFZ_Overlay) | ❌ | ❌ | +| Code Size | ![img](https://img.shields.io/github/languages/code-size/dorielrivalet/mhfz-overlay) | ![img](https://img.shields.io/github/languages/code-size/imulion/mhfz_overlay) | ![img](https://img.shields.io/github/languages/code-size/suzaku01/mhf_displayer) | +| #1 Contributor Commits | DorielRivalet 593 (+523,769 -460,614) | Imulion 14 (+3,427 -5) | suzaku01 68 (+9,745 -6,084) | +| Contributors | 4 | 1 | 1 | +| Commits | ![img](https://img.shields.io/github/commit-activity/y/dorielrivalet/mhfz-overlay) | ![img](https://img.shields.io/github/commit-activity/y/imulion/mhfz_overlay) | ![img](https://img.shields.io/github/commit-activity/y/suzaku01/mhf_displayer) | +| Last Commit | ![img](https://img.shields.io/github/last-commit/dorielrivalet/mhfz-overlay) | ![img](https://img.shields.io/github/last-commit/imulion/mhfz_overlay) | ![img](https://img.shields.io/github/last-commit/suzaku01/mhf_displayer) | +| Lines of Code | 74405 | ![img](https://vercel-tokei-git-main-dorielrivalet.vercel.app/tokei/github/imulion/mhfz_overlay) | ![img](https://vercel-tokei-git-main-dorielrivalet.vercel.app/tokei/github/suzaku01/mhf_displayer) | +| Comments | 4187 | ![img](https://vercel-tokei-git-main-dorielrivalet.vercel.app/tokei/github/imulion/mhfz_overlay?category=comments) | ![img](https://vercel-tokei-git-main-dorielrivalet.vercel.app/tokei/github/suzaku01/mhf_displayer?category=comments) | As an added bonus: -| | mhf-z overlay v0.34.0 (DorielRivalet) | HunterPie v2.8.0 (HunterPie) | -|:----------|:---------:|:---------:| -|Discord Rich Presence|✔️|✔️| -|Rich Presence Quest Name|✔️|❌| -|Rich Presence Hunter Stats|✔️ Hit Count, etc.|✔️ Rank Only| -|Monster HP|✔️|✔️| -|Monster Effective HP|✔️|✔️| -|Monster Parts|✔️|✔️| -|Monster Attack|✔️|❌| -|Monster Defense|✔️|❌| -|Monster Size|✔️|✔️ Crown Icon| -|Monster Ailments|✔️|✔️| -|Timer Options|✔️|❌| -|Sharpness Number|✔️|✔️| -|Damage Numbers|✔️|Built-in by Rise/World| -|Damage Numbers Options|✔️|❌| -|DPS Graph|✔️|✔️ Multiplayer| -|Actions per Minute Graph|✔️|❌| -|True Raw Graph|✔️|❌| -|Hits/s Graph|✔️|❌| -|Hit Count|✔️|❌| -|Hits/s|✔️|❌| -|Block Count|✔️|❌| -|Blocks/s|✔️|❌| -|True Raw|✔️|✔️| -|Actions per Minute|✔️|❌| -|Attempts Counter|✔️|❌| -|Quest Runs Youtube Link|✔️|❌| -|Personal Best Time|✔️|❌| -|Personal Best Attempts|✔️|❌| -|Completions Counter|✔️|❌| -|Run Pace|✔️ Color|❌| -|Quest Pace Graph|✔️|❌| -|Player Coordinates|✔️|❌| -|Settings Save on Update|✔️|✔️| -|Save Stats to File|✔️|❌| -|Copy Stats to Clipboard|✔️|❌| -|Multiplayer Stats|❌|✔️| -|Quest Runs Database|✔️|✔️| -|Database Backups|✔️ Local|✔️ Account-based| -|Past Quests Info|✔️|$5 for full feature| -|Achievements|✔️|❌| -|Show Quest Change|✔️|❌| -|Show Area Change|✔️|❌| -|KBM Layout|✔️|❌| -|Gamepad Layout|✔️|❌| -|Input Logs|✔️|❌| -|Quest ID|✔️|❌| -|Session Time|✔️|❌| -|Gear Info|✔️ Guild Card|❌| -|Map Info|✔️|Built-in by Game| -|Font Options|✔️|❌| -|Localization|❌|✔️| -|System Tray|✔️|✔️| -|Auto-Close|✔️|✔️| -|Performance Options|✔️|✔️| -|Auto-Update|✔️|✔️| -|Hotkeys|✔️|✔️| -|Auto-Hide|✔️ Unfocused option|✔️ Unfocused option| -|Drag and Drop|✔️|✔️ Designer Mode| -|Logging|✔️ File|✔️ Console| -|Logging Options|✔️|❌| -|Color Options|✔️|❌| -|Buff Icons |✔️|✔️| -|Debuff Icons |❌|✔️| -|Hub Activities|❌|✔️| -|Settings Search|❌|✔️ by Section| -|Settings Presets|✔️|Uses Widgets instead| -|Settings Onboarding|✔️|❌| -|Overlay Watermark|✔️|❌| -|Website|❌|✔️| -|Branding|❌ WIP|✔️| -|End-User Documentation|✔️|✔️| -|Technical Documentation|Incomplete|Incomplete| -|License File|✔️ MIT|✔️ MIT | -|Unit Testing|❌WIP|✔️| -|Changelog|✔️|✔️| -|GitHub Actions|✔️|✔️| -|Issue Template|✔️|❌| -|Pull Request Template|✔️|❌| -|Contributing File|✔️|❌| -|GitHub Milestones|✔️|✔️| -|GitHub Projects|✔️|✔️| -|Code Analysis|✔️ [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=DorielRivalet_MHFZ_Overlay&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=DorielRivalet_MHFZ_Overlay)|Private| -|Code Size|![img](https://img.shields.io/github/languages/code-size/dorielrivalet/mhfz-overlay)|![img](https://img.shields.io/github/languages/code-size/hunterpie/hunterpie)| -|#1 Contributor Commits|DorielRivalet 593 (+523,769 -460,614)|Haato3o 935 (+168,934 -105,956)| -|Contributors|4|17| -|Commits|![img](https://img.shields.io/github/commit-activity/y/dorielrivalet/mhfz-overlay)|![img](https://img.shields.io/github/commit-activity/y/hunterpie/hunterpie)| -|Last Commit|![img](https://img.shields.io/github/last-commit/dorielrivalet/mhfz-overlay)|![img](https://img.shields.io/github/last-commit/hunterpie/hunterpie)| -|Lines of Code|74405|![img](https://vercel-tokei-git-main-dorielrivalet.vercel.app/tokei/github/hunterpie/hunterpie)| -|Comments|4187|![img](https://vercel-tokei-git-main-dorielrivalet.vercel.app/tokei/github/hunterpie/hunterpie?category=comments)| +| | mhf-z overlay v0.34.0 (DorielRivalet) | HunterPie v2.8.0 (HunterPie) | +| :------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------: | +| Discord Rich Presence | ✔️ | ✔️ | +| Rich Presence Quest Name | ✔️ | ❌ | +| Rich Presence Hunter Stats | ✔️ Hit Count, etc. | ✔️ Rank Only | +| Monster HP | ✔️ | ✔️ | +| Monster Effective HP | ✔️ | ✔️ | +| Monster Parts | ✔️ | ✔️ | +| Monster Attack | ✔️ | ❌ | +| Monster Defense | ✔️ | ❌ | +| Monster Size | ✔️ | ✔️ Crown Icon | +| Monster Ailments | ✔️ | ✔️ | +| Timer Options | ✔️ | ❌ | +| Sharpness Number | ✔️ | ✔️ | +| Damage Numbers | ✔️ | Built-in by Rise/World | +| Damage Numbers Options | ✔️ | ❌ | +| DPS Graph | ✔️ | ✔️ Multiplayer | +| Actions per Minute Graph | ✔️ | ❌ | +| True Raw Graph | ✔️ | ❌ | +| Hits/s Graph | ✔️ | ❌ | +| Hit Count | ✔️ | ❌ | +| Hits/s | ✔️ | ❌ | +| Block Count | ✔️ | ❌ | +| Blocks/s | ✔️ | ❌ | +| True Raw | ✔️ | ✔️ | +| Actions per Minute | ✔️ | ❌ | +| Attempts Counter | ✔️ | ❌ | +| Quest Runs Youtube Link | ✔️ | ❌ | +| Personal Best Time | ✔️ | ❌ | +| Personal Best Attempts | ✔️ | ❌ | +| Completions Counter | ✔️ | ❌ | +| Run Pace | ✔️ Color | ❌ | +| Quest Pace Graph | ✔️ | ❌ | +| Player Coordinates | ✔️ | ❌ | +| Settings Save on Update | ✔️ | ✔️ | +| Save Stats to File | ✔️ | ❌ | +| Copy Stats to Clipboard | ✔️ | ❌ | +| Multiplayer Stats | ❌ | ✔️ | +| Quest Runs Database | ✔️ | ✔️ | +| Database Backups | ✔️ Local | ✔️ Account-based | +| Past Quests Info | ✔️ | $5 for full feature | +| Achievements | ✔️ | ❌ | +| Show Quest Change | ✔️ | ❌ | +| Show Area Change | ✔️ | ❌ | +| KBM Layout | ✔️ | ❌ | +| Gamepad Layout | ✔️ | ❌ | +| Input Logs | ✔️ | ❌ | +| Quest ID | ✔️ | ❌ | +| Session Time | ✔️ | ❌ | +| Gear Info | ✔️ Guild Card | ❌ | +| Map Info | ✔️ | Built-in by Game | +| Font Options | ✔️ | ❌ | +| Localization | ❌ | ✔️ | +| System Tray | ✔️ | ✔️ | +| Auto-Close | ✔️ | ✔️ | +| Performance Options | ✔️ | ✔️ | +| Auto-Update | ✔️ | ✔️ | +| Hotkeys | ✔️ | ✔️ | +| Auto-Hide | ✔️ Unfocused option | ✔️ Unfocused option | +| Drag and Drop | ✔️ | ✔️ Designer Mode | +| Logging | ✔️ File | ✔️ Console | +| Logging Options | ✔️ | ❌ | +| Color Options | ✔️ | ❌ | +| Buff Icons | ✔️ | ✔️ | +| Debuff Icons | ❌ | ✔️ | +| Hub Activities | ❌ | ✔️ | +| Settings Search | ❌ | ✔️ by Section | +| Settings Presets | ✔️ | Uses Widgets instead | +| Settings Onboarding | ✔️ | ❌ | +| Overlay Watermark | ✔️ | ❌ | +| Website | ❌ | ✔️ | +| Branding | ❌ WIP | ✔️ | +| End-User Documentation | ✔️ | ✔️ | +| Technical Documentation | Incomplete | Incomplete | +| License File | ✔️ MIT | ✔️ MIT | +| Unit Testing | ❌WIP | ✔️ | +| Changelog | ✔️ | ✔️ | +| GitHub Actions | ✔️ | ✔️ | +| Issue Template | ✔️ | ❌ | +| Pull Request Template | ✔️ | ❌ | +| Contributing File | ✔️ | ❌ | +| GitHub Milestones | ✔️ | ✔️ | +| GitHub Projects | ✔️ | ✔️ | +| Code Analysis | ✔️ [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=DorielRivalet_MHFZ_Overlay&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=DorielRivalet_MHFZ_Overlay) | Private | +| Code Size | ![img](https://img.shields.io/github/languages/code-size/dorielrivalet/mhfz-overlay) | ![img](https://img.shields.io/github/languages/code-size/hunterpie/hunterpie) | +| #1 Contributor Commits | DorielRivalet 593 (+523,769 -460,614) | Haato3o 935 (+168,934 -105,956) | +| Contributors | 4 | 17 | +| Commits | ![img](https://img.shields.io/github/commit-activity/y/dorielrivalet/mhfz-overlay) | ![img](https://img.shields.io/github/commit-activity/y/hunterpie/hunterpie) | +| Last Commit | ![img](https://img.shields.io/github/last-commit/dorielrivalet/mhfz-overlay) | ![img](https://img.shields.io/github/last-commit/hunterpie/hunterpie) | +| Lines of Code | 74405 | ![img](https://vercel-tokei-git-main-dorielrivalet.vercel.app/tokei/github/hunterpie/hunterpie) | +| Comments | 4187 | ![img](https://vercel-tokei-git-main-dorielrivalet.vercel.app/tokei/github/hunterpie/hunterpie?category=comments) | ## What does Effective HP and True HP mean? @@ -490,7 +490,7 @@ If you have any concerns or doubts about the software, we recommend [verifying t ## What is the database used for? -The overlay uses a SQLite database file for storing you past quest runs information, among other things, so that you can view graphs and statistics of your past runs. SQLite is known for being lightweight and performant, and the source code of the overlay implements various techniques to take advantage of such. See the other questions related to files and the database for more information. +The overlay uses a SQLite database file for storing your past quest runs information, among other things, so that you can view graphs and statistics of your past runs. SQLite is known for being lightweight and performant, and the source code of the overlay implements various techniques to take advantage of such. See the other questions related to files and the database for more information. To see in more detail the performance of the overlay's database, see [the documentation](./docs/performance.md). @@ -500,6 +500,8 @@ For the system requirements, see [here](./README.md#system-requirements) No. The overlay does read memory addresses, but it never writes (i.e. modifies values) to them. It is more likely that the local files of the game or the server files are affecting the game, both of which are unrelated to the overlay. +**The overlay is not a mod.** + ## My question isn't answered here, how can I contact the developers? First, you may want to check the issues that have already been reported [here](https://github.com/DorielRivalet/mhfz-overlay/issues) diff --git a/MHFZ_Overlay/MHFZ_Overlay.csproj b/MHFZ_Overlay/MHFZ_Overlay.csproj index 8b42c5b9..8b28207f 100644 --- a/MHFZ_Overlay/MHFZ_Overlay.csproj +++ b/MHFZ_Overlay/MHFZ_Overlay.csproj @@ -21,7 +21,7 @@ MHFZ Overlay Doriel Rivalet Doriel Rivalet - 0.37.0 + 0.37.1 https://github.com/DorielRivalet/mhfz-overlay https://github.com/DorielRivalet/mhfz-overlay.git git @@ -1949,7 +1949,7 @@ - + @@ -1958,7 +1958,7 @@ all runtime; build; native; contentfiles; analyzers; buildtransitive - + @@ -1967,7 +1967,7 @@ - + diff --git a/MHFZ_Overlay/Models/Collections/QuestsGamePatches.cs b/MHFZ_Overlay/Models/Collections/QuestsGamePatches.cs index 8dd142c0..c01cdecb 100644 --- a/MHFZ_Overlay/Models/Collections/QuestsGamePatches.cs +++ b/MHFZ_Overlay/Models/Collections/QuestsGamePatches.cs @@ -61,12 +61,12 @@ public static class QuestsGamePatches }, { "5B70CE51EC6F95337B615C76C8BE8A0C42B16B14ED698739ADC097C4C507503E", new Dictionary() { - { GamePatch.Vanilla, GamePatchLanguage.JA } + { GamePatch.Otyav1_1, GamePatchLanguage.JA } } }, { "1755B8C5DA0D488901BF4FC7179E0B036AC6F9C936C7CA5911C693119173F8E5", new Dictionary() { - { GamePatch.Vanilla, GamePatchLanguage.JA } + { GamePatch.Mezelounge, GamePatchLanguage.EN } } }, { "A90B90E6A66F1983C1807DB1298EF2BF94BFD05681021307C8F4213BBE31B890", new Dictionary() diff --git a/MHFZ_Overlay/Services/DatabaseService.cs b/MHFZ_Overlay/Services/DatabaseService.cs index 9c533e0a..1544f6ff 100644 --- a/MHFZ_Overlay/Services/DatabaseService.cs +++ b/MHFZ_Overlay/Services/DatabaseService.cs @@ -16491,7 +16491,6 @@ private void MigrateToSchemaFromVersion(SQLiteConnection conn, int fromVersion, // sqlite3_exec(db, "ALTER TABLE entries ADD COLUMN touched_at TEXT;", NULL, NULL, NULL); { this.PerformUpdateToVersion_0_25_0(conn); - // this.EnforceForeignKeys(conn); newVersion++; Logger.Info(CultureInfo.InvariantCulture, "Updated schema to version v0.25.0. newVersion {0}", newVersion); goto case 2; @@ -16499,14 +16498,12 @@ private void MigrateToSchemaFromVersion(SQLiteConnection conn, int fromVersion, case 2: // 0.34.0 // fix attempts and pb attempts, set partysize default to 1 for the extra attempts from 2p/3p/4p. this.PerformUpdateToVersion_0_34_0(conn); - // this.EnforceForeignKeys(conn); newVersion++; Logger.Info(CultureInfo.InvariantCulture, "Updated schema to version v0.34.0. newVersion {0}", newVersion); goto case 3; case 3: // 0.35.0 { this.PerformUpdateToVersion_0_35_0(conn, dataLoader); - // this.EnforceForeignKeys(conn); newVersion++; Logger.Info(CultureInfo.InvariantCulture, "Updated schema to version v0.35.0. newVersion {0}", newVersion); goto case 4; @@ -16514,9 +16511,16 @@ private void MigrateToSchemaFromVersion(SQLiteConnection conn, int fromVersion, case 4:// 0.37.0 { this.PerformUpdateToVersion_0_37_0(conn, dataLoader); - this.EnforceForeignKeys(conn); newVersion++; Logger.Info(CultureInfo.InvariantCulture, "Updated schema to version v0.37.0. newVersion {0}", newVersion); + goto case 5; + } + case 5: // 0.37.1 + { + this.PerformUpdateToVersion_0_37_1(conn, dataLoader); + this.EnforceForeignKeys(conn); + newVersion++; + Logger.Info(CultureInfo.InvariantCulture, "Updated schema to version v0.37.1. newVersion {0}", newVersion); break; } // case 2://v0.24.0 @@ -17953,12 +17957,16 @@ private void PerformUpdateToVersion_0_37_0(SQLiteConnection connection, DataLoad UpdateQuestsObjectiveImage(connection); UpdateQuestsMonsterDictionaries(connection, dataLoader); - FillQuestsGamePatch(connection, dataLoader); // for privacy ChangeGameFolderPath(connection); } + private void PerformUpdateToVersion_0_37_1(SQLiteConnection connection, DataLoader dataLoader) + { + FillQuestsGamePatch(connection, dataLoader); + } + private void ChangeGameFolderPath(SQLiteConnection conn) { if (string.IsNullOrEmpty(this.dataSource)) @@ -18050,6 +18058,26 @@ private void FillQuestsGamePatch(SQLiteConnection conn, DataLoader dataLoader) cmd0.ExecuteNonQuery(); } + using (var cmd0 = new SQLiteCommand(conn)) + { + cmd0.CommandText = @"DROP TABLE IF EXISTS QuestsGamePatch"; + cmd0.ExecuteNonQuery(); + } + + var sql0 = @"CREATE TABLE IF NOT EXISTS QuestsGamePatch( + QuestsGamePatchID INTEGER PRIMARY KEY AUTOINCREMENT, + mhfdatInfo TEXT NOT NULL DEFAULT '', + mhfemdInfo TEXT NOT NULL DEFAULT '', + mhfodllInfo TEXT NOT NULL DEFAULT '', + mhfohddllInfo TEXT NOT NULL DEFAULT '', + RunID INTEGER NOT NULL, + FOREIGN KEY(RunID) REFERENCES Quests(RunID) + )"; + using (var cmd = new SQLiteCommand(sql0, conn)) + { + cmd.ExecuteNonQuery(); + } + using (var cmd = new SQLiteCommand(conn)) { cmd.CommandText = "SELECT * FROM GameFolder"; diff --git a/README.md b/README.md index 76de1311..34b92831 100644 --- a/README.md +++ b/README.md @@ -8,11 +8,12 @@ --- -**[ 
 :rocket: Install 
 ](#installation)** -**[ 
 📘 Hotkeys
 ](#hotkeys)** -**[ 
 🕹 Features 
 ](#features)** +**[ 
 🚀 Install 
 ](#installation)** +**[ 
 📘 Hotkeys
 ](#hotkeys)** +**[ 
 🕹 Features 
 ](#features)** --- + - [Monster Hunter Frontier Z Overlay](#monster-hunter-frontier-z-overlay) @@ -63,7 +64,7 @@ We hope you find this overlay useful and enjoyable, and we welcome any feedback ### Minimum - OS: Windows 10 (64-bit) -- Processor: Intel® Core™ i3-4130 or Core™ i5-3470 +- 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. @@ -82,8 +83,8 @@ If you record and/or stream with the overlay, the recommended processor is Intel ## Installation -1. [Download the latest version from the *Releases*](https://github.com/DorielRivalet/mhfz-overlay/releases/latest/download/MHFZ_Overlay-win-Setup.exe). -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). +1. [Download the latest version from the _Releases_](https://github.com/DorielRivalet/mhfz-overlay/releases/latest/download/MHFZ_Overlay-win-Setup.exe). +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!](https://c.tenor.com/60Tr3Zeg6RkAAAAd/fumo-bonk.gif) 5. [Be sure to leave some feedback here!](https://forms.gle/hrAVWMcYS5HEo1v7A) @@ -147,11 +148,11 @@ As an alternative to hotkeys, you can use the system tray options by right-click - If the overlay doesn't seem to load values properly, restart it. If that didn't fix the issue, [please send information here](https://github.com/DorielRivalet/mhfz-overlay/issues). -- Additionally, if information from the overlay is wrong or inaccurate (*e.g.* monster parts labels), feel free to send an issue. +- Additionally, if information from the overlay is wrong or inaccurate (_e.g._ monster parts labels), feel free to send an issue. ## Features -- [x] Monster Effective HP Bars (*e.g.* Burning Freezing Elzelion's 1,000,000 HP!). +- [x] 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. @@ -165,7 +166,7 @@ You can also see the monster icons or renders, and there is an option for automa ![Sharpness Numbers 3](./demo/sharpness3.png) - [x] Quest Timer (Two modes: elapsed time and time left. Down to the milliseconds in accuracy!). -- [x] Hit Count (counts *Reflect*, *Stylish Up*, Heatblade, *Fencing+2* and more!). +- [x] Hit Count (counts _Reflect_, _Stylish Up_, Heatblade, _Fencing+2_ and more!). ![Player Stats](./demo/playerstat1.png) @@ -330,7 +331,7 @@ Some sections have context menus where you can save the section contents to a fi - 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. +- 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. @@ -422,10 +423,10 @@ We recommend consulting the appropriate documentation file based on your needs. ## Acknowledgements -- This project is directly inspired from the overlay created by [*suzaku01*](https://github.com/suzaku01/mhf_displayer). -- The theme and color palette used for the application is [*Catppuccin Mocha*](https://github.com/catppuccin/catppuccin). -- The design and icons used in this project are part of [*Segoe Fluent Icons*](https://learn.microsoft.com/en-us/windows/apps/design/style/segoe-fluent-icons-font) and [WPF UI](https://github.com/lepoco/wpfui). -- 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](https://www.deviantart.com/xmitsarugix/art/Monster-Hunter-Font-Type-1-and-2-380816151). +- This project is directly inspired from the overlay created by [_suzaku01_](https://github.com/suzaku01/mhf_displayer). +- The theme and color palette used for the application is [_Catppuccin Mocha_](https://github.com/catppuccin/catppuccin). +- The design and icons used in this project are part of [_Segoe Fluent Icons_](https://learn.microsoft.com/en-us/windows/apps/design/style/segoe-fluent-icons-font) and [WPF UI](https://github.com/lepoco/wpfui). +- 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](https://www.deviantart.com/xmitsarugix/art/Monster-Hunter-Font-Type-1-and-2-380816151). - Thanks to [Kairi](https://www.youtube.com/@kairi_mhfz) and [Sera](https://www.youtube.com/@Sera9145) for extensive beta testing and early support. - The combo element icons are made by [Narwhaler](https://fanonmonsterhunter.fandom.com/wiki/User:Narwhaler). - Additional icons can be found [here](https://fanonmonsterhunter.fandom.com/wiki/Category:Icon). @@ -435,4 +436,4 @@ We recommend consulting the appropriate documentation file based on your needs. Avatar Avatar Avatar -Avatar +Avatar diff --git a/package-lock.json b/package-lock.json index fdabdf71..554826cb 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "mhfz_overlay", - "version": "0.37.0", + "version": "0.37.1", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "mhfz_overlay", - "version": "0.37.0", + "version": "0.37.1", "license": "MIT", "dependencies": { "@release-it/conventional-changelog": "^8.0.1", diff --git a/package.json b/package.json index 8099ea07..f9e38080 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "mhfz_overlay", - "version": "0.37.0", + "version": "0.37.1", "description": "[![Monster Hunter Frontier Z Overlay v0.21.0 Preview](./demo/youtubepreview1.jpg)](https://www.youtube.com/watch?v=A9ffbRICqZY \"Monster Hunter Frontier Z Overlay v0.21.0 Preview\")", "main": "MHFZ_Overlay.sln", "scripts": {