Release v0.30.0

.github/ISSUE_TEMPLATE/BUG-REPORT.yml

@@ -32,42 +32,15 @@ body:
         - Always
     validations:
       required: true
-  - type: textarea
-    id: operating-system
-    attributes:
-      label: What operating system are you using?
-      description: Operating system
-      placeholder: Tell us what operating system you using (Windows 11, Windows 10, etc.)
-      value: "Windows 10 21H2"
-    validations:
-      required: true
   - type: textarea
     id: version
     attributes:
       label: What version of the program are you using?
       description: Program Version
-      placeholder: Tell us what version you using (x.y.z)
+      placeholder: Tell us what version you are using (x.y.z)
       value: "Latest version"
     validations:
       required: true
-  - type: dropdown
-    id: game-version
-    attributes:
-      label: What version of the game are you using?
-      multiple: true
-      options:
-        - High-Grade Edition
-        - Non High-Grade Edition
-    validations:
-      required: true
-  - type: input
-    id: quest-id
-    attributes:
-      label: Quest ID
-      description: What is the Quest ID where the issue occurs? Enter the quest ID that you see in the overlay, enabled by going into Config -> Quest Log -> Settings. If the issue occurs in multiple quests, enter an example quest ID and tell us in the issue description that it happens in multiple quests. If the issue occurs outside quests, enter 0. 
-      placeholder: '0'
-    validations:
-      required: true
   - type: markdown
     attributes:
       value: |

.github/workflows/dotnet.yml

@@ -28,4 +28,6 @@ jobs:
       - name: Build
         run: dotnet build --configuration Release --no-restore
       - name: Test
-        run: dotnet test --no-restore --verbosity normal
+        run: |
+          cd MHFZ_OverlayTest
+          dotnet test --no-restore --verbosity normal

FAQ.md

@@ -169,6 +169,7 @@ The location of any previous settings are in the subfolders of `%LocalAppData%/D
 5. Drag and drop the file.
 6. Copy/Paste into Output Comparer the hash provided by the developer.
 7. You should get the message `The hashes are the same.`.
+8. Close DevToys.
 
 ### Command Line Interface
 
@@ -392,9 +393,12 @@ As an added bonus:
 
 - Effective HP is the HP taking into account the monster's defense rate. Burning Freezing Elzelion has 1,000,000 EHP because his True HP is 30,000 and his defense rate is 0.03.
 
-```text
-Effective HP = True HP / Defense rate
-1,000,000 = 30,000 / 0.03
+```math
+Effective HP = \frac{True HP}{DefenseRate}
+```
+
+```math
+1,000,000 = \frac{30,000}{0.03}
 ```
 
 - True HP is the HP of the monster without taking into account the monster's defense rate.

MHFZOverlayBenchmark/Comparisons/TimerComparison.cs

@@ -0,0 +1,149 @@
+// © 2023 The mhfz-overlay developers.
+// Use of this source code is governed by a MIT license that can be
+// found in the LICENSE file.
+
+namespace MHFZOverlayBenchmark.Comparisons;
+
+using BenchmarkDotNet.Attributes;
+using System;
+using System.Collections.Generic;
+using System.Globalization;
+using System.Linq;
+using System.Runtime.Intrinsics.Arm;
+using System.Security.Cryptography;
+using System.Text;
+using System.Threading.Tasks;
+
+public enum TimerFormat
+{
+    MinutesSeconds,
+    MinutesSecondsMilliseconds,
+    HoursMinutesSeconds,
+}
+
+public enum TimerMode
+{
+    TimeLeft,
+    Elapsed,
+}
+
+// TODO optimize
+[RPlotExporter]
+[MedianColumn, MinColumn, MaxColumn]
+[UnicodeConsoleLogger]
+[MemoryDiagnoser]
+[ExceptionDiagnoser]
+public class TimerComparison
+{
+    public const decimal FramesPerSecond = 30;
+
+    public string TimeLeftPercentNumber = " (100%)";
+
+    [Params(120 * 60 * 30)]
+    public int TimeDefInt;
+
+    [Benchmark]
+    public string BenchmarkSimpleTimer()
+    {
+        string s = string.Empty;
+        for (int i = TimeDefInt; i > 0; i--)
+        {
+            s = SimpleTimer(i, TimerFormat.MinutesSecondsMilliseconds, true, TimeDefInt, true, TimeLeftPercentNumber, TimerMode.Elapsed);
+        };
+
+        return s;
+    }
+
+    [Benchmark]
+    public string BenchmarkTimeSpanTimer()
+    {
+        string s = string.Empty;
+        for (int i = TimeDefInt; i > 0; i--)
+        {
+            s = TimeSpanTimer(i, TimerFormat.MinutesSecondsMilliseconds, true, TimeDefInt, true, TimeLeftPercentNumber, TimerMode.Elapsed);
+        };
+
+        return s;
+    }
+
+    [Benchmark]
+    public string BenchmarkStringBuilderTimer()
+    {
+        string s = string.Empty;
+        for (int i = TimeDefInt; i > 0; i--)
+        {
+            s = StringBuilderTimer(i, TimerFormat.MinutesSecondsMilliseconds, true, TimeDefInt, true, TimeLeftPercentNumber, TimerMode.Elapsed);
+        };
+
+        return s;
+    }
+
+    public string SimpleTimer(decimal timeInt, TimerFormat timerFormat, bool isFrames = true, decimal timeDefInt = 0, bool timeLeftPercentShown = false, string timeLeftPercentNumber = "", TimerMode timerMode = TimerMode.Elapsed)
+    {
+        // TODO wrong conditionals for timeint >= timedefint?
+        decimal time = timerMode == TimerMode.Elapsed && timeInt <= timeDefInt ? time = timeDefInt - timeInt : time = timeInt;
+        decimal framesPerSecond = isFrames ? FramesPerSecond : 1;
+        decimal milliseconds = time / framesPerSecond * 1000;
+        decimal totalMinutes = Math.Floor(milliseconds / 60000);
+        decimal minutes = totalMinutes >= 60 ? totalMinutes : Math.Floor(milliseconds / 60000);
+        decimal seconds = Math.Floor((milliseconds - (minutes * 60000)) / 1000);
+        decimal remainingMilliseconds = milliseconds - (minutes * 60000) - (seconds * 1000);
+        var timeLeftPercent = timeLeftPercentShown ? timeLeftPercentNumber : string.Empty;
+
+        return timerFormat switch
+        {
+            TimerFormat.MinutesSeconds => $"{minutes:00}:{seconds:00}" + timeLeftPercent,
+            TimerFormat.MinutesSecondsMilliseconds => $"{minutes:00}:{seconds:00}.{remainingMilliseconds:000}" + timeLeftPercent,
+            _ => $"{minutes:00}:{seconds:00}.{remainingMilliseconds:000}" + timeLeftPercent,
+        };
+    }
+
+    public string StringBuilderTimer(decimal timeInt, TimerFormat timerFormat, bool isFrames = true, decimal timeDefInt = 0, bool timeLeftPercentShown = false, string timeLeftPercentNumber = "", TimerMode timerMode = TimerMode.Elapsed)
+    {
+        decimal time = timerMode == TimerMode.Elapsed && timeInt <= timeDefInt ? time = timeDefInt - timeInt : time = timeInt;
+        decimal framesPerSecond = isFrames ? FramesPerSecond : 1;
+        decimal totalSeconds = time / framesPerSecond;
+        decimal totalMinutes = Math.Floor(totalSeconds / 60);
+        decimal minutes = totalMinutes >= 60 ? totalMinutes : Math.Floor(totalSeconds / 60);
+        decimal seconds = Math.Floor(totalSeconds % 60);
+        decimal milliseconds = Math.Round((time % framesPerSecond) * (1000M / framesPerSecond));
+        var timeLeftPercent = timeLeftPercentShown ? timeLeftPercentNumber : string.Empty;
+
+        StringBuilder sb = new StringBuilder();
+        switch (timerFormat)
+        {
+            default:
+                sb.AppendFormat(CultureInfo.InvariantCulture, "{0:00}:{1:00}.{2:000}", minutes, seconds, milliseconds);
+                break;
+            case TimerFormat.MinutesSeconds:
+                sb.AppendFormat(CultureInfo.InvariantCulture, "{0:00}:{1:00}", minutes, seconds);
+                break;
+            case TimerFormat.MinutesSecondsMilliseconds:
+                sb.AppendFormat(CultureInfo.InvariantCulture, "{0:00}:{1:00}.{2:000}", minutes, seconds, milliseconds);
+                break;
+        }
+
+        sb.Append(timeLeftPercent);
+        return sb.ToString();
+    }
+
+    public string TimeSpanTimer(decimal timeInt, TimerFormat timerFormat, bool isFrames = true, decimal timeDefInt = 0, bool timeLeftPercentShown = false, string timeLeftPercentNumber = "", TimerMode timerMode = TimerMode.Elapsed)
+    {
+        decimal time = timerMode == TimerMode.Elapsed && timeInt <= timeDefInt ? time = timeDefInt - timeInt : time = timeInt;
+        decimal framesPerSecond = isFrames ? FramesPerSecond : 1;
+        decimal timeInSeconds = time / framesPerSecond;
+        TimeSpan timeInSecondsSpan = TimeSpan.FromSeconds((double)timeInSeconds);
+        int roundedMilliseconds = (int)(Math.Round(timeInSecondsSpan.TotalMilliseconds) % 1000);
+        var totalMinutes = Math.Floor(timeInSecondsSpan.TotalSeconds / 60);
+        var minutes = totalMinutes >= 60 ? totalMinutes : timeInSecondsSpan.Minutes;
+        var timeLeftPercent = timeLeftPercentShown ? timeLeftPercentNumber : string.Empty;
+
+        // Format the TimeSpan object as a string
+        return timerFormat switch
+        {
+            TimerFormat.MinutesSeconds => $"{minutes:00}:{timeInSecondsSpan.Seconds:00}" + timeLeftPercent,
+            TimerFormat.MinutesSecondsMilliseconds => $"{minutes:00}:{timeInSecondsSpan.Seconds:00}.{roundedMilliseconds:000}" + timeLeftPercent,
+            _ => $"{minutes:00}:{timeInSecondsSpan.Seconds:00}.{roundedMilliseconds:000}" + timeLeftPercent,
+        };
+    }
+}

MHFZOverlayBenchmark/MHFZOverlayBenchmark.csproj

@@ -0,0 +1,14 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <OutputType>Exe</OutputType>
+    <TargetFramework>net6.0</TargetFramework>
+    <ImplicitUsings>enable</ImplicitUsings>
+    <Nullable>enable</Nullable>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="BenchmarkDotNet" Version="0.13.7" />
+  </ItemGroup>
+
+</Project>

MHFZOverlayBenchmark/Program.cs

@@ -0,0 +1,18 @@
+// © 2023 The mhfz-overlay developers.
+// Use of this source code is governed by a MIT license that can be
+// found in the LICENSE file.
+
+// See https://aka.ms/new-console-template for more information
+using BenchmarkDotNet.Running;
+using System.Management;
+using MHFZOverlayBenchmark.Comparisons;
+using BenchmarkDotNet.Configs;
+using BenchmarkDotNet.Reports;
+using Perfolizer.Horology;
+using BenchmarkDotNet.Columns;
+
+var summary = BenchmarkRunner.Run<TimerComparison>(
+    DefaultConfig.Instance.WithSummaryStyle(
+        SummaryStyle.Default
+            .WithTimeUnit(TimeUnit.Millisecond)
+            .WithSizeUnit(SizeUnit.MB)));

MHFZ_Overlay.sln

@@ -7,6 +7,8 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "MHFZ_Overlay", "MHFZ_Overla
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "MHFZ_OverlayTest", "MHFZ_OverlayTest\MHFZ_OverlayTest.csproj", "{13ED7686-F93C-4DBC-9258-061DE45FFC60}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "MHFZOverlayBenchmark", "MHFZOverlayBenchmark\MHFZOverlayBenchmark.csproj", "{7A166AB3-8381-45A7-A827-AD42A9EDD863}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -21,6 +23,10 @@ Global
 		{13ED7686-F93C-4DBC-9258-061DE45FFC60}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{13ED7686-F93C-4DBC-9258-061DE45FFC60}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{13ED7686-F93C-4DBC-9258-061DE45FFC60}.Release|Any CPU.Build.0 = Release|Any CPU
+		{7A166AB3-8381-45A7-A827-AD42A9EDD863}.Debug|Any CPU.ActiveCfg = Release|Any CPU
+		{7A166AB3-8381-45A7-A827-AD42A9EDD863}.Debug|Any CPU.Build.0 = Release|Any CPU
+		{7A166AB3-8381-45A7-A827-AD42A9EDD863}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{7A166AB3-8381-45A7-A827-AD42A9EDD863}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE

MHFZ_Overlay/App.config

@@ -689,7 +689,7 @@
                 <value>180</value>
             </setting>
             <setting name="ShowDiscordRPCOverlayMode" serializeAs="String">
-                <value>True</value>
+                <value>False</value>
             </setting>
             <setting name="QuestAttemptsShown" serializeAs="String">
                 <value>False</value>
@@ -954,6 +954,42 @@
             <setting name="BingoProgressShown" serializeAs="String">
                 <value>False</value>
             </setting>
+            <setting name="VolumeMain" serializeAs="String">
+                <value>0.5</value>
+            </setting>
+            <setting name="VolumeAchievementUnlock" serializeAs="String">
+                <value>1</value>
+            </setting>
+            <setting name="VolumeChallengeUnlock" serializeAs="String">
+                <value>1</value>
+            </setting>
+            <setting name="VolumeChallengeStart" serializeAs="String">
+                <value>1</value>
+            </setting>
+            <setting name="VolumeHover" serializeAs="String">
+                <value>1</value>
+            </setting>
+            <setting name="VolumeGachaUnlock" serializeAs="String">
+                <value>1</value>
+            </setting>
+            <setting name="VolumeGachaTrial" serializeAs="String">
+                <value>1</value>
+            </setting>
+            <setting name="VolumeSelect" serializeAs="String">
+                <value>1</value>
+            </setting>
+            <setting name="VolumeGachaRare" serializeAs="String">
+                <value>1</value>
+            </setting>
+            <setting name="OverlayWatermarkMode" serializeAs="String">
+                <value>Final</value>
+            </setting>
+            <setting name="DiscordOverlayMode" serializeAs="String">
+                <value>Automatic</value>
+            </setting>
+            <setting name="QuestToggleMonsterModeShown" serializeAs="String">
+                <value>True</value>
+            </setting>
         </MHFZ_Overlay.Settings>
     </userSettings>
 </configuration>

MHFZ_Overlay/App.xaml

@@ -162,7 +162,7 @@
             https://stackoverflow.com/questions/3425720/xaml-the-property-resources-is-set-more-than-once#3425956
             -->
             <ResourceDictionary.MergedDictionaries>
-                <ui:ThemesDictionary Theme="Dark" />
+                <ui:ThemesDictionary ApplicationTheme="Dark" />
                 <ui:ControlsDictionary />
                 <ResourceDictionary Source="./Assets/Themes/CatppuccinMocha.xaml" />
                 <!--<materialDesign:CustomColorTheme BaseTheme="Dark" PrimaryColor="#a6e3a1" SecondaryColor="#b4befe" />-->

MHFZ_Overlay/App.xaml.cs

@@ -11,9 +11,11 @@ namespace MHFZ_Overlay;
 using System.Globalization;
 using System.IO;
 using System.Reflection;
+using System.Threading;
 using System.Threading.Tasks;
 using System.Windows;
 using System.Windows.Interop;
+using System.Windows.Markup;
 using System.Windows.Media;
 using System.Windows.Threading;
 using MHFZ_Overlay.Models.Constant;
@@ -93,12 +95,26 @@ protected override void OnStartup(StartupEventArgs e)
 
         // Start the stopwatch
         stopwatch.Start();
+
+        // https://stackoverflow.com/questions/12729922/how-to-set-cultureinfo-invariantculture-default
+        CultureInfo culture = CultureInfo.InvariantCulture;
+
+        Thread.CurrentThread.CurrentCulture = culture;
+        Thread.CurrentThread.CurrentUICulture = culture;
+
+        CultureInfo.DefaultThreadCurrentCulture = culture;
+        CultureInfo.DefaultThreadCurrentUICulture = culture;
+
+        FrameworkElement.LanguageProperty.OverrideMetadata(
+            typeof(FrameworkElement),
+            new FrameworkPropertyMetadata(XmlLanguage.GetLanguage(CultureInfo.CurrentCulture.Name)));
+
         var loggingRules = NLog.LogManager.Configuration.LoggingRules;
         var s = (Settings)Current.TryFindResource("Settings");
         loggingRules[0].SetLoggingLevels(LoggingService.GetLogLevel(s.LogLevel), NLog.LogLevel.Fatal);
         Logger.Info(CultureInfo.InvariantCulture, "Started WPF application");
         Logger.Trace(CultureInfo.InvariantCulture, "Call stack: {0}", new StackTrace().ToString());
-        Logger.Debug("OS: {0}, is64BitOS: {1}, is64BitProcess: {2}, CLR version: {3}", Environment.OSVersion, Environment.Is64BitOperatingSystem, Environment.Is64BitProcess, Environment.Version);
+        Logger.Debug(CultureInfo.InvariantCulture, "OS: {0}, is64BitOS: {1}, is64BitProcess: {2}, CLR version: {3}", Environment.OSVersion, Environment.Is64BitOperatingSystem, Environment.Is64BitProcess, Environment.Version);
 
         // TODO: test if this doesnt conflict with squirrel update
         CurrentProgramVersion = $"v{GetAssemblyVersion}";
@@ -143,14 +159,14 @@ protected override void OnStartup(StartupEventArgs e)
     private static void App_DispatcherUnhandledException(object sender, DispatcherUnhandledExceptionEventArgs e) =>
 
         // Log/inspect the inspection here
-        Logger.Error("Unhandled exception\n\nMessage: {0}\n\nStack Trace: {1}\n\nHelp Link: {2}\n\nHResult: {3}\n\nSource: {4}\n\nTarget Site: {5}", e.Exception.Message, e.Exception.StackTrace, e.Exception.HelpLink, e.Exception.HResult, e.Exception.Source, e.Exception.TargetSite);
+        Logger.Error(CultureInfo.InvariantCulture, "Unhandled exception\n\nMessage: {0}\n\nStack Trace: {1}\n\nHelp Link: {2}\n\nHResult: {3}\n\nSource: {4}\n\nTarget Site: {5}", e.Exception.Message, e.Exception.StackTrace, e.Exception.HelpLink, e.Exception.HResult, e.Exception.Source, e.Exception.TargetSite);
 
     private static void SetRenderingMode(string renderingMode)
     {
         RenderOptions.ProcessRenderMode = renderingMode == "Hardware"
             ? RenderMode.Default
             : RenderMode.SoftwareOnly;
-        Logger.Info($"Rendering mode: {renderingMode}");
+        Logger.Info(CultureInfo.InvariantCulture, $"Rendering mode: {renderingMode}");
     }
 
     // https://github.com/Squirrel/Squirrel.Windows/issues/198#issuecomment-299262613