add an option to ignore the original countdown when drawing the custo…

…m one #56
xorus · Feb 4, 2024 · bac46f4 · bac46f4
1 parent 6b0d046
commit bac46f4
Show file tree

Hide file tree

Showing 22 changed files with 265 additions and 88 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,4 +1,8 @@
-# v2.3.1.0 - unreleased
+# v2.3.2.0
+
+- Adds 
+
+# v2.3.1.0
 
 - You can set alarms to play a game sound effect, change stopwatch color or display text at specified combat durations
 - Big code rewrite and a bit of optimization

diff --git a/Plugin/Commands/MainCommand.cs b/Plugin/Commands/MainCommand.cs
@@ -15,7 +15,7 @@
 
 using System;
 using Dalamud.Game.Command;
-using EngageTimer.Ui;
+using EngageTimer.Localization;
 
 namespace EngageTimer.Commands;
 
@@ -27,12 +27,12 @@ public sealed class MainCommand : IDisposable
     public MainCommand()
     {
         Register();
-        Plugin.Translator.LocaleChanged += OnLocaleChanged;
+        Translator.LocaleChanged += OnLocaleChanged;
     }
 
     public void Dispose()
     {
-        Plugin.Translator.LocaleChanged -= OnLocaleChanged;
+        Translator.LocaleChanged -= OnLocaleChanged;
         Unregister();
     }
 

diff --git a/Plugin/Commands/SettingsCommand.cs b/Plugin/Commands/SettingsCommand.cs
@@ -15,6 +15,7 @@
 
 using System;
 using Dalamud.Game.Command;
+using EngageTimer.Localization;
 using EngageTimer.Ui;
 
 namespace EngageTimer.Commands;

diff --git a/Plugin/Configuration/CountdownConfiguration.cs b/Plugin/Configuration/CountdownConfiguration.cs
@@ -24,14 +24,14 @@ namespace EngageTimer.Configuration;
 public class CountdownConfiguration
 {
     public static readonly string[] BundledTextures =
-        { "default", "yellow", "wow", "awk", "tall", "misaligned", "pixel", "moire", "mspaint" };
+        {"default", "yellow", "wow", "awk", "tall", "misaligned", "pixel", "moire", "mspaint"};
 
     // Countdown
     [AutoField("Settings_CountdownTab_Enable")]
     public bool Display { get; set; } = true;
 
-    [AutoField("Settings_CountdownTab_HideOriginalCountDown"), Help("Settings_CountdownTab_HideOriginalCountDown_Help")]
     public bool HideOriginalAddon { get; set; } = false;
+    public bool IgnoreOriginalAddon { get; set; } = false;
 
     [AutoField("Settings_CountdownTab_Audio_Enable")]
     public bool EnableTickingSound { get; set; } = false;

diff --git a/Plugin/EngageTimer.csproj b/Plugin/EngageTimer.csproj
@@ -8,7 +8,7 @@
         <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
         <AppendTargetFrameworkToOutputPath>false</AppendTargetFrameworkToOutputPath>
         <ProduceReferenceAssembly>false</ProduceReferenceAssembly>
-        <AssemblyVersion>2.3.1.1</AssemblyVersion>
+        <AssemblyVersion>2.3.2.0</AssemblyVersion>
         <Deterministic>false</Deterministic>
         <AutoGenerateBindingRedirects>true</AutoGenerateBindingRedirects>
         <AllowUnsafeBlocks>true</AllowUnsafeBlocks>

diff --git a/Plugin/Localization/Extensions.cs b/Plugin/Localization/Extensions.cs
@@ -0,0 +1,37 @@
+// This file is part of EngageTimer
+// Copyright (C) 2024 Xorus <xorus@posteo.net>
+// 
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as published
+// by the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+// 
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU Affero General Public License for more details.
+// You should have received a copy of the GNU Affero General Public License
+// along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+namespace EngageTimer.Localization;
+
+/**
+ * For the lazy dogs out there (me)
+ */
+public static class Extensions
+{
+    public static string Tr(this string id)
+    {
+        return Translator.Tr(id);
+    }
+
+    public static string TrId(this string id)
+    {
+        return Translator.TrId(id);
+    }
+
+    public static string TrYesNo(this bool yesNo, string yes, string no)
+    {
+        return yesNo ? Tr(yes) : Tr(no);
+    }
+}
diff --git a/Plugin/Ui/Translator.cs → Plugin/Localization/Translator.cs b/Plugin/Ui/Translator.cs → Plugin/Localization/Translator.cs
@@ -17,23 +17,23 @@
 using System.Globalization;
 using EngageTimer.Properties;
 
-namespace EngageTimer.Ui;
+namespace EngageTimer.Localization;
 
-public sealed class Translator : IDisposable
+public static class Translator
 {
-    public Translator()
+    public static event EventHandler? LocaleChanged;
+
+    public static void Register()
     {
         Plugin.PluginInterface.LanguageChanged += ConfigureLanguage;
         ConfigureLanguage();
     }
 
-    public void Dispose()
+    public static void Unregister()
     {
         Plugin.PluginInterface.LanguageChanged -= ConfigureLanguage;
     }
 
-    public event EventHandler? LocaleChanged;
-
     public static string TrId(string id)
     {
         return $"{Resources.ResourceManager.GetString(id, Resources.Culture) ?? id}###EngageTimer_{id}";
@@ -61,7 +61,7 @@ public static string Tr(string id, params string[] replacements)
         return str;
     }
 
-    private void ConfigureLanguage(string? langCode = null)
+    private static void ConfigureLanguage(string? langCode = null)
     {
         var lang = (langCode ?? Plugin.PluginInterface.UiLanguage) switch
         {
@@ -72,6 +72,6 @@ private void ConfigureLanguage(string? langCode = null)
             _ => "en"
         };
         Resources.Culture = new CultureInfo(lang ?? "en");
-        LocaleChanged?.Invoke(this, EventArgs.Empty);
+        LocaleChanged?.Invoke(null, EventArgs.Empty);
     }
 }
diff --git a/Plugin/Plugin.cs b/Plugin/Plugin.cs
@@ -20,6 +20,7 @@
 using EngageTimer.Commands;
 using EngageTimer.Configuration;
 using EngageTimer.Game;
+using EngageTimer.Localization;
 using EngageTimer.Status;
 using EngageTimer.Ui;
 using JetBrains.Annotations;
@@ -43,7 +44,6 @@ public sealed class Plugin : IDalamudPlugin
     [PluginService] public static IToastGui ToastGui { get; private set; } = null!;
     public static ConfigurationFile Config { get; private set; } = null!;
     public static State State { get; private set; } = null!;
-    public static Translator Translator { get; private set; } = null!;
     public static PluginUi PluginUi { get; private set; } = null!;
     public static NumberTextures NumberTextures { get; set; } = null!;
     public static string PluginPath { get; private set; } = null!;
@@ -57,9 +57,9 @@ public Plugin(DalamudPluginInterface pluginInterface)
     {
         PluginPath = PluginInterface.AssemblyLocation.DirectoryName ??
                      throw new InvalidOperationException("Cannot find plugin directory");
+        Translator.Register();
         Config = ConfigurationLoader.Load();
         State = new State();
-        Translator = new Translator();
         FrameworkThings = new FrameworkThings();
         MainCommand = new MainCommand();
         SettingsCommand = new SettingsCommand();
@@ -70,12 +70,12 @@ public Plugin(DalamudPluginInterface pluginInterface)
 
     void IDisposable.Dispose()
     {
+        Translator.Unregister();
         PluginInterface.SavePluginConfig(Config);
         CombatAlarm.Dispose();
         PluginUi.Dispose();
         FrameworkThings.Dispose();
         MainCommand.Dispose();
         SettingsCommand.Dispose();
-        Translator.Dispose();
     }
 }
diff --git a/Plugin/Properties/Resources.Designer.cs b/Plugin/Properties/Resources.Designer.cs
diff --git a/Plugin/Properties/Resources.resx b/Plugin/Properties/Resources.resx
@@ -617,4 +617,16 @@ help text for the /eg settings command</comment>
     <data name="CombatAlarm_ImportedEmpty" xml:space="preserve">
       <value>An empty or invalid alarm list was imported</value>
     </data>
+    <data name="Settings_CountdownTab_IgnoreOriginalCountDown" xml:space="preserve">
+      <value>Draw even if original countdown is visible</value>
+    </data>
+    <data name="Settings_CountdownTab_IgnoreOriginalCountDown_Help" xml:space="preserve">
+      <value>Allows you to have the vanilla countdown showing on your game but still use the custom one in a corner or overlaping if you like chaos. Useful if you setup your OBS to not capture addons and want to look unmodified.</value>
+    </data>
+    <data name="Settings_CountdownTab_DefaultOriginalCountDown" xml:space="preserve">
+      <value>Don't overlap with game countdown (default)</value>
+    </data>
+    <data name="Settings_CountdownTab_DefaultOriginalCountDown_Help" xml:space="preserve">
+      <value>Hides the custom countdown under 5 to prevent overlapping with the vanilla one.</value>
+    </data>
 </root>
diff --git a/Plugin/Status/CombatAlarm.cs b/Plugin/Status/CombatAlarm.cs
@@ -22,6 +22,7 @@
 using Dalamud.Plugin.Services;
 using EngageTimer.Configuration;
 using EngageTimer.Game;
+using EngageTimer.Localization;
 using EngageTimer.Ui;
 using Newtonsoft.Json;
 

diff --git a/Plugin/Ui/Components.cs b/Plugin/Ui/Components.cs
@@ -20,6 +20,7 @@
 using Dalamud.Interface.Colors;
 using Dalamud.Interface.Components;
 using EngageTimer.Attributes;
+using EngageTimer.Localization;
 using ImGuiNET;
 
 namespace EngageTimer.Ui;

diff --git a/Plugin/Ui/CountDown.cs b/Plugin/Ui/CountDown.cs
@@ -18,7 +18,6 @@
 using System.Globalization;
 using System.Numerics;
 using Dalamud.Interface.Animation;
-using Dalamud.Interface.Animation.EasingFunctions;
 using EngageTimer.Configuration;
 using EngageTimer.Game;
 using EngageTimer.Ui.CustomEasing;
@@ -30,14 +29,9 @@ public sealed class CountDown : IDisposable
 {
     private const float BaseNumberScale = 1f;
     private const int GameCountdownWidth = 60; // just trust in the magic numbers
-    private const float AnimationSize = .7f;
 
-    private readonly Easing _easing = new OutCubic(new TimeSpan(0, 0, 0, 0, 1000));
-
-    private readonly Easing _easingOpacity = new OpacityEasing(
-        new TimeSpan(0, 0, 0, 0, 1000),
-        1, -0.02, .71, 1
-    );
+    private readonly Easing _easing = new NumberEasing();
+    private readonly Easing _easingOpacity = new OpacityEasing();
 
     private bool _accurateMode;
     private const string WindowTitle = "EngageTimer Countdown";
@@ -76,13 +70,12 @@ private void ConfigurationOnOnSave(object? sender, EventArgs e)
      */
     private void UpdateFromConfig()
     {
-        _accurateMode = Plugin.Config.Countdown.HideOriginalAddon && Plugin.Config.Countdown.AccurateMode;
+        _accurateMode = Plugin.Config.Countdown.AccurateMode &&
+                        (Plugin.Config.Countdown.HideOriginalAddon || Plugin.Config.Countdown.IgnoreOriginalAddon);
     }
 
     private void FirstDraw()
     {
-        if (!_firstDraw) return;
-
         var visible = true;
         var flags = ImGuiWindowFlags.NoTitleBar
                     | ImGuiWindowFlags.NoScrollbar | ImGuiWindowFlags.NoTitleBar
@@ -119,10 +112,11 @@ public void Draw()
 //         ImGui.End();
 // #endif
 
-        FirstDraw();
+        if (_firstDraw) FirstDraw();
         if (!Plugin.Config.Countdown.Display || !Plugin.State.CountingDown) return;
 
-        var showMainCountdown = Plugin.State.CountDownValue > 5 || Plugin.Config.Countdown.HideOriginalAddon;
+        var showMainCountdown = Plugin.Config.Countdown.HideOriginalAddon ||
+                                Plugin.Config.Countdown.IgnoreOriginalAddon || Plugin.State.CountDownValue > 5;
         if (showMainCountdown && Plugin.Config.Countdown.EnableDisplayThreshold &&
             Plugin.State.CountDownValue > Plugin.Config.Countdown.DisplayThreshold)
             return;
@@ -136,7 +130,7 @@ public void Draw()
 
             if (Plugin.Config.Countdown.Animate)
             {
-                var second = (int)Plugin.State.CountDownValue;
+                var second = (int) Plugin.State.CountDownValue;
                 if (_lastSecond != second)
                 {
                     _easing.Restart();
@@ -148,8 +142,8 @@ public void Draw()
                 _easingOpacity.Update();
                 if (Plugin.Config.Countdown.AnimateScale)
                 {
-                    maxNumberScale = numberScale + AnimationSize;
-                    numberScale += AnimationSize * (1 - (float)_easing.Value);
+                    maxNumberScale = numberScale + NumberEasing.StartSize;
+                    numberScale += NumberEasing.StartSize * (1 - (float) _easing.Value);
                 }
             }
         }
@@ -196,7 +190,7 @@ public void Draw()
                     ImGui.GetWindowPos(),
                     ImGui.GetWindowPos() + ImGui.GetWindowSize(),
                     ImGui.GetColorU32(ImGuiCol.Text), 0f, ImDrawFlags.None,
-                    7f + (float)Math.Sin(ImGui.GetTime() * 2) * 5f);
+                    7f + (float) Math.Sin(ImGui.GetTime() * 2) * 5f);
                 d.AddRect(
                     ImGui.GetWindowPos(),
                     ImGui.GetWindowPos() + ImGui.GetWindowSize(),
@@ -208,7 +202,7 @@ public void Draw()
             DrawCountdown(showMainCountdown, numberScale, negativeMargin, false);
             if (Plugin.Config.Countdown.Animate && Plugin.Config.Countdown.AnimateOpacity)
             {
-                ImGui.PushStyleVar(ImGuiStyleVar.Alpha, (float)_easingOpacity.Value);
+                ImGui.PushStyleVar(ImGuiStyleVar.Alpha, (float) _easingOpacity.Value);
                 DrawCountdown(showMainCountdown, numberScale, negativeMargin, true);
                 ImGui.PopStyleVar();
             }