1.2.0

- Add tooltips to tool panel. - Add localization. - Add proper licensing.
algernon-A · Dec 19, 2023 · fc4b7bc · fc4b7bc
1 parent b76f5a7
commit fc4b7bc
Show file tree

Hide file tree

Showing 25 changed files with 533 additions and 34 deletions.
diff --git a/BepInEx/Plugin.cs b/BepInEx/Plugin.cs
@@ -1,5 +1,7 @@
 // <copyright file="Plugin.cs" company="algernon (K. Algernon A. Sheppard)">
 // Copyright (c) algernon (K. Algernon A. Sheppard). All rights reserved.
+// Licensed under the Apache Licence, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
+// See LICENSE.txt file in the project root for full license information.
 // </copyright>
 
 namespace LineTool
@@ -14,7 +16,7 @@ namespace LineTool
     /// <summary>
     /// BepInEx plugin to substitute for IMod support.
     /// </summary>
-    [BepInPlugin(GUID, "Line Tool Lite", "1.1.2")]
+    [BepInPlugin(GUID, "Line Tool Lite", "1.2.0")]
     [HarmonyPatch]
     public class Plugin : BaseUnityPlugin
     {

diff --git a/BepInEx/manifest.json b/BepInEx/manifest.json
@@ -1,6 +1,6 @@
 {
   "name": "Line_Tool_Lite",
-  "version_number": "1.1.2",
+  "version_number": "1.2.0",
   "website_url": "https://github.com/algernon-A/LineToolLite",
   "description": "Place objects in lines, curves, or circles.  A variety of options and controls are availalbe to specify and fine-tune results.",
   "dependencies": [

diff --git a/Changelog.txt b/Changelog.txt
@@ -1,3 +1,8 @@
+1.2.0
+- Add tooltips to tool panel.
+- Add localization.
+- Add proper licensing.
+
 1.1.2
 - Additional updates for Tree Controller integration.
 

diff --git a/Code/LineModes/Circle.cs b/Code/LineModes/Circle.cs
@@ -1,5 +1,7 @@
 // <copyright file="Circle.cs" company="algernon (K. Algernon A. Sheppard)">
 // Copyright (c) algernon (K. Algernon A. Sheppard). All rights reserved.
+// Licensed under the Apache Licence, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
+// See LICENSE.txt file in the project root for full license information.
 // </copyright>
 
 namespace LineTool

diff --git a/Code/LineModes/LineBase.cs b/Code/LineModes/LineBase.cs
@@ -1,5 +1,7 @@
 // <copyright file="LineBase.cs" company="algernon (K. Algernon A. Sheppard)">
 // Copyright (c) algernon (K. Algernon A. Sheppard). All rights reserved.
+// Licensed under the Apache Licence, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
+// See LICENSE.txt file in the project root for full license information.
 // </copyright>
 
 namespace LineTool

diff --git a/Code/LineModes/LineMode.cs b/Code/LineModes/LineMode.cs
@@ -1,5 +1,7 @@
 // <copyright file="LineMode.cs" company="algernon (K. Algernon A. Sheppard)">
 // Copyright (c) algernon (K. Algernon A. Sheppard). All rights reserved.
+// Licensed under the Apache Licence, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
+// See LICENSE.txt file in the project root for full license information.
 // </copyright>
 
 namespace LineTool

diff --git a/Code/LineModes/PointData.cs b/Code/LineModes/PointData.cs
@@ -1,5 +1,7 @@
 // <copyright file="PointData.cs" company="algernon (K. Algernon A. Sheppard)">
 // Copyright (c) algernon (K. Algernon A. Sheppard). All rights reserved.
+// Licensed under the Apache Licence, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
+// See LICENSE.txt file in the project root for full license information.
 // </copyright>
 
 namespace LineTool

diff --git a/Code/LineModes/SimpleCurve.cs b/Code/LineModes/SimpleCurve.cs
@@ -1,5 +1,7 @@
 // <copyright file="SimpleCurve.cs" company="algernon (K. Algernon A. Sheppard)">
 // Copyright (c) algernon (K. Algernon A. Sheppard). All rights reserved.
+// Licensed under the Apache Licence, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
+// See LICENSE.txt file in the project root for full license information.
 // </copyright>
 
 namespace LineTool

diff --git a/Code/LineModes/SpacingMode.cs b/Code/LineModes/SpacingMode.cs
@@ -1,5 +1,7 @@
 // <copyright file="SpacingMode.cs" company="algernon (K. Algernon A. Sheppard)">
 // Copyright (c) algernon (K. Algernon A. Sheppard). All rights reserved.
+// Licensed under the Apache Licence, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
+// See LICENSE.txt file in the project root for full license information.
 // </copyright>
 
 namespace LineTool

diff --git a/Code/LineModes/StraightLine.cs b/Code/LineModes/StraightLine.cs
@@ -1,5 +1,7 @@
 // <copyright file="StraightLine.cs" company="algernon (K. Algernon A. Sheppard)">
 // Copyright (c) algernon (K. Algernon A. Sheppard). All rights reserved.
+// Licensed under the Apache Licence, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
+// See LICENSE.txt file in the project root for full license information.
 // </copyright>
 
 namespace LineTool

diff --git a/Code/Localization.cs b/Code/Localization.cs
@@ -0,0 +1,78 @@
+// <copyright file="Localization.cs" company="algernon (K. Algernon A. Sheppard)">
+// Copyright (c) algernon (K. Algernon A. Sheppard). All rights reserved.
+// Licensed under the Apache Licence, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
+// See LICENSE.txt file in the project root for full license information.
+// </copyright>
+
+namespace LineTool
+{
+    using System;
+    using System.Collections.Generic;
+    using System.IO;
+    using System.Linq;
+    using System.Reflection;
+    using Colossal.Localization;
+    using Colossal.Logging;
+    using Game.SceneFlow;
+
+    /// <summary>
+    /// Translation handling.
+    /// </summary>
+    public static class Localization
+    {
+        /// <summary>
+        /// Loads settings translations from tab-separated l10n file.
+        /// </summary>
+        /// <param name="log">Log to use.</param>
+        public static void LoadTranslations(ILog log)
+        {
+            try
+            {
+                // Read embedded file.
+                using StreamReader reader = new (Assembly.GetExecutingAssembly().GetManifestResourceStream("LineToolLite.l10n.csv"));
+                {
+                    List<string> lines = new ();
+                    while (!reader.EndOfStream)
+                    {
+                        // Skip empty lines.
+                        string line = reader.ReadLine();
+                        if (!string.IsNullOrWhiteSpace(line))
+                        {
+                            lines.Add(line);
+                        }
+                    }
+
+                    // Iterate through each game locale.
+                    log.Info("parsing translation file");
+                    IEnumerable<string[]> fileLines = lines.Select(x => x.Split('\t'));
+                    foreach (string localeID in GameManager.instance.localizationManager.GetSupportedLocales())
+                    {
+                        try
+                        {
+                            // Find matching column in file.
+                            int valueColumn = Array.IndexOf(fileLines.First(), localeID);
+
+                            // Make sure a valid column has been found (column 0 is the binding context and column 1 is the translation key).
+                            if (valueColumn > 1)
+                            {
+                                // Add translations to game locales.
+                                log.Debug("found translation for " + localeID);
+                                MemorySource language = new (fileLines.Skip(1).ToDictionary(x => x[0] + '.' + x[1], x => x.ElementAtOrDefault(valueColumn)));
+                                GameManager.instance.localizationManager.AddSource(localeID, language);
+                            }
+                        }
+                        catch (Exception e)
+                        {
+                            // Don't let a single failure stop us.
+                            log.Error(e, $"exception reading localization for locale {localeID}");
+                        }
+                    }
+                }
+            }
+            catch (Exception e)
+            {
+                log.Error(e, "exception reading settings localization file");
+            }
+        }
+    }
+}
diff --git a/Code/Mod.cs b/Code/Mod.cs
@@ -1,10 +1,13 @@
 // <copyright file="Mod.cs" company="algernon (K. Algernon A. Sheppard)">
 // Copyright (c) algernon (K. Algernon A. Sheppard). All rights reserved.
+// Licensed under the Apache Licence, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
+// See LICENSE.txt file in the project root for full license information.
 // </copyright>
 
 namespace LineTool
 {
     using System.IO;
+    using System.Reflection;
     using Colossal.Logging;
     using Game;
     using Game.Modding;
@@ -46,7 +49,7 @@ public void OnLoad()
             Log.effectivenessLevel = Level.Debug;
 #endif
 
-            Log.Info("loading");
+            Log.Info($"loading {ModName} version {Assembly.GetExecutingAssembly().GetName().Version}");
         }
 
         /// <summary>
@@ -57,6 +60,9 @@ public void OnCreateWorld(UpdateSystem updateSystem)
         {
             Log.Info("starting OnCreateWorld");
 
+            // Load translations.
+            Localization.LoadTranslations(Log);
+
             // Activate systems.
             updateSystem.UpdateAt<LineToolSystem>(SystemUpdatePhase.ToolUpdate);
             updateSystem.UpdateAt<LineToolUISystem>(SystemUpdatePhase.UIUpdate);

diff --git a/Code/Systems/LineToolSystem.cs b/Code/Systems/LineToolSystem.cs
@@ -1,5 +1,7 @@
 // <copyright file="LineToolSystem.cs" company="algernon (K. Algernon A. Sheppard)">
 // Copyright (c) algernon (K. Algernon A. Sheppard). All rights reserved.
+// Licensed under the Apache Licence, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
+// See LICENSE.txt file in the project root for full license information.
 // </copyright>
 
 namespace LineTool
@@ -687,6 +689,7 @@ protected override void OnStopRunning()
 
             // Clear tooltips.
             _tooltips.Clear();
+            World.GetExistingSystemManaged<LineToolUISystem>().ClearTooltip();
 
             // Disable apply action.
             _applyAction.shouldBeEnabled = false;

diff --git a/Code/Systems/LineToolTooltipSystem.cs b/Code/Systems/LineToolTooltipSystem.cs
@@ -1,5 +1,7 @@
 // <copyright file="LineToolTooltipSystem.cs" company="algernon (K. Algernon A. Sheppard)">
 // Copyright (c) algernon (K. Algernon A. Sheppard). All rights reserved.
+// Licensed under the Apache Licence, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
+// See LICENSE.txt file in the project root for full license information.
 // </copyright>
 
 namespace LineTool

diff --git a/Code/Systems/LineToolUISystem.cs b/Code/Systems/LineToolUISystem.cs
@@ -1,5 +1,7 @@
 // <copyright file="LineToolUISystem.cs" company="algernon (K. Algernon A. Sheppard)">
 // Copyright (c) algernon (K. Algernon A. Sheppard). All rights reserved.
+// Licensed under the Apache Licence, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
+// See LICENSE.txt file in the project root for full license information.
 // </copyright>
 
 namespace LineTool
@@ -48,6 +50,14 @@ internal void UpdateSpacing()
             ExecuteScript(_uiView, $"if (lineTool) {{ lineTool.spacing = {_lineToolSystem.Spacing * 10}; if (lineTool.refreshSpacing) lineTool.refreshSpacing();}}");
         }
 
+        /// <summary>
+        /// Clears any displayed tooltip.
+        /// </summary>
+        internal void ClearTooltip()
+        {
+            ExecuteScript(_uiView, "if (lineTool) {{ lineTool.hideTooltip(); }}");
+        }
+
         /// <summary>
         /// Called when the system is created.
         /// </summary>
@@ -210,11 +220,11 @@ private string ReadCSS(string fileName)
             }
             catch (Exception e)
             {
-                _log.Error(e, "exception reading CSS file " + fileName);
+                _log.Error(e, $"exception reading CSS file {fileName}");
             }
 
             // If we got here, something went wrong.; return null.
-            _log.Error("failed to read embedded CSS file " + fileName);
+            _log.Error($"failed to read embedded CSS file {fileName}");
             return null;
         }
 
@@ -240,11 +250,11 @@ private string ReadHTML(string fileName, string injectionPostfix)
             }
             catch (Exception e)
             {
-                _log.Error(e, "exception reading embedded HTML file " + fileName);
+                _log.Error(e, $"exception reading embedded HTML file {fileName}");
             }
 
             // If we got here, something went wrong.; return null.
-            _log.Error("failed to read embedded HTML file " + fileName);
+            _log.Error($"failed to read embedded HTML file {fileName}");
             return null;
         }
 
@@ -269,11 +279,11 @@ private string ReadJS(string fileName)
             }
             catch (Exception e)
             {
-                _log.Error(e, "exception reading embedded JavaScript file " + fileName);
+                _log.Error(e, $"exception reading embedded JavaScript file {fileName}");
             }
 
             // If we got here, something went wrong; return null.
-            _log.Error("failed to read embedded JavaScript file " + fileName);
+            _log.Error($"failed to read embedded JavaScript file {fileName}");
             return null;
         }
 
@@ -295,7 +305,7 @@ private string ReadUIFile(string fileName)
             }
             catch (Exception e)
             {
-                _log.Error(e, "exception reading embedded UI file " + fileName);
+                _log.Error(e, $"exception reading embedded UI file {fileName}");
             }
 
             return null;

diff --git a/Config/References.csproj b/Config/References.csproj
@@ -16,6 +16,9 @@
 		<Reference Include="Colossal.UI.Binding">
 			<Private>false</Private>
 		</Reference>
+		<Reference Include="Colossal.Localization">
+			<Private>false</Private>
+		</Reference>
 		<Reference Include="Colossal.Logging">
 			<Private>false</Private>
 		</Reference>

diff --git a/GlobalSuppressions.cs b/GlobalSuppressions.cs
@@ -1,5 +1,7 @@
 // <copyright file="GlobalSuppressions.cs" company="algernon (K. Algernon A. Sheppard)">
 // Copyright (c) algernon (K. Algernon A. Sheppard). All rights reserved.
+// Licensed under the Apache Licence, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
+// See LICENSE.txt file in the project root for full license information.
 // </copyright>
 
 using System.Diagnostics.CodeAnalysis;