Feature: Add support for generating Windows Store listing data.

.gitignore

@@ -1 +1,5 @@
 steam/
+/winstore/obj
+/winstore/bin
+.vs
+winstore-output*

lang/afrikaans.txt

@@ -0,0 +1 @@
+##plural 0

lang/basque.txt

@@ -0,0 +1 @@
+##plural 0

lang/belarusian.txt

@@ -0,0 +1 @@
+##plural 0

lang/catalan.txt

@@ -0,0 +1 @@
+##plural 0

lang/croatian.txt

@@ -0,0 +1 @@
+##plural 0

lang/estonian.txt

@@ -0,0 +1 @@
+##plural 0

lang/gaelic.txt

@@ -0,0 +1 @@
+##plural 0

lang/galician.txt

@@ -0,0 +1 @@
+##plural 0

lang/hebrew.txt

@@ -0,0 +1 @@
+##plural 0

lang/icelandic.txt

@@ -0,0 +1 @@
+##plural 0

lang/indonesian.txt

@@ -0,0 +1 @@
+##plural 0

lang/irish.txt

@@ -0,0 +1 @@
+##plural 0

lang/latvian.txt

@@ -0,0 +1 @@
+##plural 0

lang/lithuanian.txt

@@ -0,0 +1 @@
+##plural 0

lang/luxembourgish.txt

@@ -0,0 +1 @@
+##plural 0

lang/malay.txt

@@ -0,0 +1 @@
+##plural 0

lang/norwegian_nynorsk.txt

@@ -0,0 +1 @@
+##plural 0

lang/serbian.txt

@@ -0,0 +1 @@
+##plural 0

lang/slovak.txt

@@ -0,0 +1 @@
+##plural 0

lang/slovenian.txt

@@ -0,0 +1 @@
+##plural 0

lang/tamil.txt

@@ -0,0 +1 @@
+##plural 0

lang/welsh.txt

@@ -0,0 +1 @@
+##plural 0

winstore/Program.cs

@@ -0,0 +1,271 @@
+using CsvHelper;
+using System.Globalization;
+using System.IO.Compression;
+using System.Text;
+
+namespace convert_to_winstore
+{
+    /// <summary>
+    /// Class representing an OpenTTD language.
+    /// </summary>
+    internal class Language
+    {
+        /// <summary>
+        /// Language filename base (e.g. "english");
+        /// </summary>
+        public string LangFile { get; }
+
+        /// <summary>
+        /// Windows Store language code (e.g. "en-gb");
+        /// </summary>
+        public string StoreCode { get; }
+
+        /// <summary>
+        /// Loaded strings for substitution.
+        /// </summary>
+        private Dictionary<string, string> strings;
+
+        /// <summary>
+        /// Creates a new instance of the Language class.
+        /// </summary>
+        /// <param name="langFile">Language filename base.</param>
+        /// <param name="storeCode">Windows Store language code.</param>
+        public Language(string langFile, string storeCode)
+        {
+            LangFile = langFile;
+            StoreCode = storeCode;
+        }
+
+        /// <summary>
+        /// Replaces $VARIABLES$ within the specified string with translated strings.
+        /// </summary>
+        /// <param name="langPath">Path to the 'lang' folder.</param>
+        /// <param name="stringToSubstitute">String to work on.</param>
+        /// <returns>The substituted string.</returns>
+        public string Substitute(string langPath, string stringToSubstitute)
+        {
+            if (strings == null)
+            {
+                strings = new Dictionary<string, string>(StringComparer.Ordinal);
+                string path = Path.Combine(langPath, Path.ChangeExtension(LangFile, ".txt"));
+
+                if (!File.Exists(path))
+                {
+                    // TODO: For now, substitute the English version.
+                    path = Path.Combine(langPath, "english.txt");
+                }
+
+                using (FileStream fs = File.Open(path, FileMode.Open, FileAccess.Read, FileShare.Read))
+                {
+                    using (StreamReader sr = new StreamReader(fs, Encoding.UTF8))
+                    {
+                        while (!sr.EndOfStream)
+                        {
+                            string? line = sr.ReadLine();
+
+                            if (string.IsNullOrWhiteSpace(line) || line.StartsWith('#'))
+                            {
+                                continue;
+                            }
+
+                            int firstColon = line.IndexOf(':');
+
+                            if (firstColon < 0)
+                            {
+                                continue;
+                            }
+
+                            string key = $"${line.Substring(0, firstColon).Trim()}$";
+                            string value = line.Substring(firstColon + 1).Trim();
+
+                            strings[key] = value;
+                        }
+                    }
+                }
+            }
+
+            foreach (KeyValuePair<string, string> kvp in strings)
+            {
+                stringToSubstitute = stringToSubstitute.Replace(kvp.Key, kvp.Value, StringComparison.Ordinal);
+            }
+
+            return stringToSubstitute;
+        }
+    }
+
+    internal class Program
+    {
+        /// <summary>
+        /// List of supported languages.
+        /// </summary>
+        private static readonly List<Language> languageMappings =
+        [
+            new Language("arabic_egypt", "ar-eg"),
+            new Language("bulgarian", "bg-bg"),
+            new Language("simplified_chinese", "zh-cn"),
+            new Language("traditional_chinese", "zh-tw"),
+            new Language("bulgarian", "bg-bg"),
+            new Language("czech", "cs-cz"),
+            new Language("danish", "da-dk"),
+            new Language("dutch", "nl-nl"),
+            new Language("finnish", "fi-fi"), // Not currently selected for OpenTTD on the Windows Store
+            new Language("french", "fr-fr"),
+            new Language("german", "de-de"),
+            new Language("greek", "el-gr"),
+            new Language("hungarian", "hu-hu"),
+            new Language("italian", "it-it"),
+            new Language("japanese", "ja-jp"),
+            new Language("korean", "ko-kr"),
+            new Language("norwegian_bokmal", "nb-no"),
+            new Language("polish", "pl-pl"),
+            new Language("portuguese", "pt-pt"),
+            new Language("brazilian_portuguese", "pt-br"),
+            new Language("romanian", "ro-ro"),
+            new Language("russian", "ru-ru"),
+            new Language("spanish", "es-es"),
+            new Language("spanish_MX", "es-mx"),
+            new Language("swedish", "sv-se"),
+            new Language("thai", "th-th"),
+            new Language("turkish", "tr-tr"),
+            new Language("ukrainian", "uk-ua"),
+            new Language("vietnamese", "vi-vn"),
+
+            // The following languages are supported by the Store, but not currently translated
+            new Language("afrikaans", "af-za"),
+            new Language("basque", "eu-es"),
+            new Language("belarusian", "be-by"),
+            new Language("catalan", "ca-es"),
+            new Language("croatian", "hr-hr"),
+            new Language("estonian", "et-ee"),
+            new Language("gaelic", "gd-gb"),
+            new Language("galician", "gl-es"),
+            new Language("hebrew", "he-il"),
+            new Language("icelandic", "is-is"),
+            new Language("indonesian", "id-id"),
+            new Language("irish", "ga-ie"),
+            new Language("latvian", "lv-lv"),
+            new Language("lithuanian", "lt-lt"),
+            new Language("luxembourgish", "lb-lu"),
+            new Language("malay", "ms-my"),
+            new Language("norwegian_nynorsk", "no-no"),
+            new Language("serbian", "sr-latn-rs"),
+            new Language("slovak", "sk-sk"),
+            new Language("slovenian", "sl-si"),
+            new Language("tamil", "ta-in"),
+            new Language("welsh", "cy-gb")
+        ];
+
+        /// <summary>
+        /// English language variants (except "en-gb", which is included in the template).
+        /// </summary>
+        private static readonly string[] languageEnglishVariants =
+        {
+            "en-au",
+            "en-us"
+        };
+
+        /// <summary>
+        /// The English (UK) base translation.
+        /// </summary>
+        private static readonly Language englishGb = new Language("english", "en-gb");
+
+        static void Main(string[] args)
+        {
+            // Either search the current directory for our data, or allow the path to be passed on the command line
+            string rootPath = (args.Length > 0) ? args[0] : Directory.GetCurrentDirectory();
+
+            string templatePath = Path.Combine(rootPath, "winstore-template.csv");
+            string langPath = Path.Combine(rootPath, "lang");
+            string outputPath = Path.Combine(rootPath, "winstore-output.csv");
+
+            using (StreamWriter writer = new StreamWriter(outputPath, false, Encoding.UTF8))
+            {
+                using (CsvWriter csvOut = new CsvWriter(writer, new CultureInfo("en-US")))
+                {
+                    using (StreamReader reader = new StreamReader(templatePath, true))
+                    {
+                        using (CsvReader csv = new CsvReader(reader, new CultureInfo("en-US")))
+                        {
+                            // Read the header row
+                            csv.Read();
+
+                            if (!csv.ReadHeader() || csv.HeaderRecord == null)
+                            {
+                                Console.Error.WriteLine("Unable to read header from input CSV.");
+                                return;
+                            }
+
+                            // Create output headers - one for each language
+                            string[] headers = new string[csv.HeaderRecord.Length + languageMappings.Count + languageEnglishVariants.Length];
+
+                            csv.HeaderRecord.CopyTo(headers, 0);
+                            languageMappings.Select(l => l.StoreCode).ToArray().CopyTo(headers, csv.HeaderRecord.Length);
+                            languageEnglishVariants.CopyTo(headers, csv.HeaderRecord.Length + languageMappings.Count);
+
+                            foreach (string value in headers)
+                            {
+                                csvOut.WriteField(value);
+                            }
+
+                            csvOut.NextRecord();
+
+                            string[] values = (string[])headers.Clone();
+
+                            while (csv.Read())
+                            {
+                                string fieldName = csv.GetField(0) ?? string.Empty;
+                                string fieldId = csv.GetField(1) ?? string.Empty;
+                                string fieldType = csv.GetField(2) ?? string.Empty;
+                                string fieldDefault = csv.GetField(3) ?? string.Empty;
+                                string enGbValue = csv.GetField(4) ?? string.Empty;
+
+                                values[0] = fieldName;
+                                values[1] = fieldId;
+                                values[2] = fieldType;
+                                values[3] = fieldDefault;
+
+                                for (int i = 4; i < headers.Length; i++)
+                                {
+                                    values[i] = enGbValue;
+                                }
+
+                                if (fieldType.Equals("Text", StringComparison.Ordinal) && enGbValue.Contains('$', StringComparison.Ordinal))
+                                {
+                                    // Perform a language lookup and substitution
+                                    values[4] = englishGb.Substitute(langPath, values[4]);
+
+                                    int curCol = 5;
+
+                                    foreach (Language l in languageMappings)
+                                    {
+                                        values[curCol] = l.Substitute(langPath, enGbValue);
+
+                                        // If the string still contains unsubstituted values, use the English version instead
+                                        if (values[curCol].Contains('$'))
+                                            values[curCol] = values[4];
+
+                                        curCol++;
+                                    }
+
+                                    // Manually set the English variants to the same as British English
+                                    foreach (string variant in languageEnglishVariants)
+                                    {
+                                        values[curCol] = values[4];
+                                        curCol++;
+                                    }
+                                }
+
+                                foreach (string value in values)
+                                {
+                                    csvOut.WriteField(value);
+                                }
+
+                                csvOut.NextRecord();
+                            }
+                        }
+                    }
+                }
+            }
+        }
+    }
+}

winstore/Properties/launchSettings.json

@@ -0,0 +1,8 @@
+{
+  "profiles": {
+    "convert-to-winstore": {
+      "commandName": "Project",
+      "commandLineArgs": "../../../../"
+    }
+  }
+}

winstore/convert-to-winstore.csproj

@@ -0,0 +1,15 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <OutputType>Exe</OutputType>
+    <TargetFramework>net8.0</TargetFramework>
+    <RootNamespace>convert_to_winstore</RootNamespace>
+    <ImplicitUsings>enable</ImplicitUsings>
+    <Nullable>enable</Nullable>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="CsvHelper" Version="33.0.1" />
+  </ItemGroup>
+
+</Project>