added optional DT text popup

Author: Eisenhuth

nael/nael/Configuration.cs

@@ -14,6 +14,8 @@ public class Configuration : IPluginConfiguration
         public string Dive { get; set; } = "DIVE";
         public string MeteorStream { get; set; } = "SPREAD";
         public string Separator { get; set; } = ">";
+        public bool GimmickText { get; set; }
+        public int GimmickDuration { get; set; } = 5;
 
 
         private IDalamudPluginInterface pluginInterface;

nael/nael/NaelPlugin.cs

@@ -1,17 +1,20 @@
 namespace nael
 {
+    using System;
     using System.Collections.Generic;
     using System.IO;
+    using System.Linq;
     using System.Reflection;
     using System.Text.Json;
     using Dalamud.Game;
-    using Dalamud.Game.Text;
     using Dalamud.Game.Command;
+    using Dalamud.Game.Text;
     using Dalamud.Game.Text.SeStringHandling;
     using Dalamud.Game.Text.SeStringHandling.Payloads;
     using Dalamud.IoC;
     using Dalamud.Plugin;
     using Dalamud.Plugin.Services;
+    using FFXIVClientStructs.FFXIV.Client.UI;
     using FuzzySharp;
     using ImGuiNET;
 
@@ -33,6 +36,9 @@ public class NaelPlugin : IDalamudPlugin
         private string configDive;
         private string configMeteorStream;
         private string configSeparator;
+        
+        private bool gimmickText;
+        private int gimmickDuration;
 
         private readonly NaelQuotes naelQuotes;
         private Dictionary<string, string> naelQuotesDictionary;
@@ -48,10 +54,11 @@ public NaelPlugin(IDalamudPluginInterface dalamudPluginInterface, IChatGui chatG
 
             dalamudPluginInterface.UiBuilder.Draw += DrawConfiguration;
             dalamudPluginInterface.UiBuilder.OpenConfigUi += OpenConfig;
+            dalamudPluginInterface.UiBuilder.OpenMainUi += OpenConfig;
 
             commandManager.AddHandler(commandName, new CommandInfo(NaelCommand)
             {
-                HelpMessage = "toggle the plugin\n/nael test → print test quotes\n/nael cfg → open the configuration window",
+                HelpMessage = "toggle the translation\n/nael test → print test quotes\n/nael random → print random quote\n/nael cfg → open the configuration window",
                 ShowInHelp = true
             });
 
@@ -73,26 +80,48 @@ private void NaelCommand(string command, string args)
                     OpenConfig();
                     break;
                 case "test":
-                    TestPlugin();
+                    PrintAllQuotes();
+                    break;
+                case "random":
+                    PrintRandomQuote();
                     break;
                 default:
                 {
                     configuration.Enabled = !configuration.Enabled;
                     configuration.Save();
 
-                    var pluginStatus = configuration.Enabled ? "enabled" : "disabled";
+                    var pluginStatus = configuration.Enabled ? "translation enabled" : "translation disabled";
                     chatGui.Print($"{Name} {pluginStatus}");
                     break;
                 }
             }
         }
 
-        private void TestPlugin()
+        private void PrintAllQuotes()
         {
             foreach (var quote in naelQuotes.Quotes) 
                 chatGui.Print(NaelMessage($"{GetQuote(quote.ID)}"));
         }
 
+        private void PrintRandomQuote()
+        {
+            var number = new Random().Next(0, naelQuotes.Quotes.Count);
+            var quote = naelQuotes.Quotes[number].ID;
+            chatGui.Print(NaelMessage($"{GetQuote(quote)}"));
+        }
+        
+        private static bool CheckForNael(string name)
+        {
+            var names = new string[]
+            {
+                "Nael deus Darnus", //EN/DE/FR
+                "ネール・デウス・ダーナス", //JA
+                "奈尔·神·达纳斯", //CN
+            };
+
+            return names.Contains(name);
+        }
+
         private static XivChatEntry NaelMessage(string message)
         {
             var entry = new XivChatEntry
@@ -107,19 +136,25 @@ private static XivChatEntry NaelMessage(string message)
 
         private void OnChatMessage(XivChatType type, int timestamp, ref SeString sender, ref SeString message, ref bool handled)
         {
-            if (!configuration.Enabled) 
-                return;
-
             if (type != XivChatType.NPCDialogueAnnouncements)
                 return;
 
             foreach (var payload in message.Payloads)
                 if (payload is TextPayload { Text: not null } textPayload)
-                {
-                    textPayload.Text = NaelIt(textPayload.Text);
+                { 
+                    if (configuration.Enabled) 
+                        textPayload.Text = NaelIt(textPayload.Text);
+                    
+                    if (gimmickText && CheckForNael(sender.TextValue))
+                        ShowTextGimmick(textPayload.Text, gimmickDuration);
                 }
         }
 
+        private static unsafe void ShowTextGimmick(string message, int durationInSeconds)
+        {
+            RaptureAtkModule.Instance()->ShowTextGimmickHint(message, RaptureAtkModule.TextGimmickHintStyle.Warning, durationInSeconds * 10);
+        }
+        
         /// <summary>
         /// checks the chat message for any Nael quote and replaces it with the mechanics
         /// </summary>
@@ -197,7 +232,23 @@ private void DrawConfiguration()
             ImGui.Text($"Nael deus Darnus: {configBeam} {configSeparator} {configChariot}");
             ImGui.Text($"Nael deus Darnus: {configDynamo} {configSeparator} {configDive} {configSeparator} {configMeteorStream}");
 
-            ImGui.Separator();        
+            ImGui.Separator();
+
+            ImGui.Checkbox("Show Dawntrail Mechanic Text", ref gimmickText);
+            ImGui.SliderInt("Display Duration", ref gimmickDuration, 1, 10);
+            
+            ImGui.Separator();       
+            
+            if (ImGui.Button("Test random quote"))
+                PrintRandomQuote();
+            
+            ImGui.SameLine();
+
+            if (ImGui.Button("Test all quotes"))
+                PrintAllQuotes();
+            
+            
+            ImGui.Separator();
 
             if (ImGui.Button("Save and Close"))
             {
@@ -206,12 +257,6 @@ private void DrawConfiguration()
                 drawConfiguration = false;
             }
 
-            ImGui.SameLine();
-            
-            if (ImGui.Button("Test all quotes"))
-            {
-                TestPlugin();
-            }
 
             ImGui.End();
         }
@@ -229,6 +274,8 @@ private void LoadConfiguration()
             configDive = configuration.Dive;
             configMeteorStream = configuration.MeteorStream;
             configSeparator = configuration.Separator;
+            gimmickText = configuration.GimmickText;
+            gimmickDuration = configuration.GimmickDuration;
         }
 
         private void SaveConfiguration()
@@ -239,6 +286,8 @@ private void SaveConfiguration()
             configuration.Dive = configDive;
             configuration.MeteorStream = configMeteorStream;
             configuration.Separator = configSeparator;
+            configuration.GimmickText = gimmickText;
+            configuration.GimmickDuration = gimmickDuration;
 
             PluginInterface.SavePluginConfig(configuration);
         }

nael/nael/NaelPlugin.json

@@ -3,7 +3,7 @@
   "Name": "Nael'd it for UCOB",
   "Description": "Translates Nael's quotes into mechanics.",
   "Punchline": "because reading chat is not a mechanic",
-  "Changelog": "- updated for Dalamud api11",
+  "Changelog": "- added optional Dawntrail Text popup",
   "InternalName": "NaelPlugin",
   "Tags": ["ui"],
   "RepoUrl": "https://github.com/Eisenhuth/dalamud-nael",

nael/nael/nael.csproj

@@ -9,7 +9,7 @@
         <AppendTargetFrameworkToOutputPath>false</AppendTargetFrameworkToOutputPath>
         <OutputPath>$(AppData)\Eisenhuth\DalamudDevPlugins\NaelPlugin\</OutputPath>
         <ProduceReferenceAssembly>false</ProduceReferenceAssembly>
-        <AssemblyVersion>1.4.6.0</AssemblyVersion>
+        <AssemblyVersion>1.5.0.0</AssemblyVersion>
         <CopyLocalLockFileAssemblies>true</CopyLocalLockFileAssemblies>
         <RestorePackagesWithLockFile>true</RestorePackagesWithLockFile>
         <PackageProjectUrl>https://github.com/Eisenhuth/dalamud-nael</PackageProjectUrl>
@@ -41,16 +41,20 @@
     </ItemGroup>
 
     <PropertyGroup>
-        <DalamudLibPath>$(appdata)\XIVLauncher\addon\Hooks\dev\</DalamudLibPath>
+        <DalamudLibPath>$(appdata)\XIVLauncher\addon\Hooks\dev</DalamudLibPath>
     </PropertyGroup>
 
     <ItemGroup>
         <Reference Include="Dalamud">
-            <HintPath>$(DalamudLibPath)Dalamud.dll</HintPath>
+            <HintPath>$(DalamudLibPath)\Dalamud.dll</HintPath>
             <Private>false</Private>
         </Reference>
         <Reference Include="ImGui">
-            <HintPath>$(DalamudLibPath)ImGui.NET.dll</HintPath>
+            <HintPath>$(DalamudLibPath)\ImGui.NET.dll</HintPath>
+            <Private>false</Private>
+        </Reference>
+        <Reference Include="FFXIVClientStructs">
+            <HintPath>$(DalamudLibPath)\FFXIVClientStructs.dll</HintPath>
             <Private>false</Private>
         </Reference>
     </ItemGroup>