From d256517e21c77c67d56fbc9bd2cebdee8b2f820a Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Mon, 4 May 2026 19:02:44 +0000 Subject: [PATCH] feat: load forge mod translations from local jars Agent-Logs-Url: https://github.com/MCCTeam/Minecraft-Console-Client/sessions/3d9090fb-cdf3-48e7-a7ce-575b54161f0e Co-authored-by: milutinke <441903+milutinke@users.noreply.github.com> --- MinecraftClient/McClient.cs | 2 + .../Protocol/Handlers/Protocol18Forge.cs | 2 + .../Protocol/Message/ChatParser.cs | 220 +++++++++++++++++- .../ConfigComments/ConfigComments.resx | 3 + MinecraftClient/Settings.cs | 3 + docs/guide/configuration.md | 10 + 6 files changed, 231 insertions(+), 9 deletions(-) diff --git a/MinecraftClient/McClient.cs b/MinecraftClient/McClient.cs index 136fe224..fcade4a7 100644 --- a/MinecraftClient/McClient.cs +++ b/MinecraftClient/McClient.cs @@ -314,6 +314,8 @@ namespace MinecraftClient client.ReceiveBufferSize = 1024 * 1024; client.ReceiveTimeout = Config.Main.Advanced.TcpTimeout * 1000; // Default: 30 seconds handler = Protocol.ProtocolHandler.GetProtocolHandler(client, protocolversion, forgeInfo, this); + if (forgeInfo is not null) + ChatParser.LoadForgeModTranslations(forgeInfo.Mods.Select(static mod => mod.ModID)); Log.Info(Translations.mcc_version_supported); timeoutdetector = new(new Thread(new ParameterizedThreadStart(TimeoutDetector)), new CancellationTokenSource()); diff --git a/MinecraftClient/Protocol/Handlers/Protocol18Forge.cs b/MinecraftClient/Protocol/Handlers/Protocol18Forge.cs index 7359d200..0e93c0bb 100644 --- a/MinecraftClient/Protocol/Handlers/Protocol18Forge.cs +++ b/MinecraftClient/Protocol/Handlers/Protocol18Forge.cs @@ -301,6 +301,8 @@ namespace MinecraftClient.Protocol.Handlers for (int i = 0; i < modCount; i++) mods.Add(dataTypes.ReadNextString(packetData)); + ChatParser.LoadForgeModTranslations(mods); + Dictionary channels = new(); int channelCount = dataTypes.ReadNextVarInt(packetData); for (int i = 0; i < channelCount; i++) diff --git a/MinecraftClient/Protocol/Message/ChatParser.cs b/MinecraftClient/Protocol/Message/ChatParser.cs index 7920fa61..34e83878 100644 --- a/MinecraftClient/Protocol/Message/ChatParser.cs +++ b/MinecraftClient/Protocol/Message/ChatParser.cs @@ -5,6 +5,7 @@ using System.IO.Compression; using System.Linq; using System.Net.Http; using System.Net.Http.Json; +using System.Diagnostics.CodeAnalysis; using System.Security.Cryptography; using System.Text; using System.Text.Json; @@ -255,9 +256,9 @@ namespace MinecraftClient.Protocol.Message /// private static Dictionary TranslationRules = new(); - private sealed class ResourcePackTranslationLayer(string packIdentifier, Dictionary translations) + private sealed class TranslationLayer(string identifier, Dictionary translations) { - public string PackIdentifier { get; } = packIdentifier; + public string Identifier { get; } = identifier; public Dictionary Translations { get; } = translations; } @@ -273,8 +274,13 @@ namespace MinecraftClient.Protocol.Message private const long MaxResourcePackDownloadBytes = 256L * 1024 * 1024; private const int ResourcePackDownloadBufferSize = 81920; private const string ResourcePackTranslationCacheVersion = "1"; + private const string ForgeModTranslationDirectory = "mods"; - private static readonly List ResourcePackTranslationLayers = []; + private static readonly Regex ForgeModIdLineRegex = + new(@"^\s*modId\s*=\s*""([^""]+)""", RegexOptions.Compiled | RegexOptions.CultureInvariant); + + private static readonly List ForgeModTranslationLayers = []; + private static readonly List ResourcePackTranslationLayers = []; private static readonly HttpClient ResourcePackHttpClient = new(); /// @@ -283,6 +289,7 @@ namespace MinecraftClient.Protocol.Message /// public static void InitTranslations() { + ForgeModTranslationLayers.Clear(); ResourcePackTranslationLayers.Clear(); if (!RulesInitialized) @@ -464,8 +471,8 @@ namespace MinecraftClient.Protocol.Message public static void RemoveResourcePackTranslations(string packIdentifier) { - ResourcePackTranslationLayers.RemoveAll(layer => - layer.PackIdentifier.Equals(packIdentifier, StringComparison.Ordinal)); + ResourcePackTranslationLayers.RemoveAll(layer => + layer.Identifier.Equals(packIdentifier, StringComparison.Ordinal)); } public static void ClearResourcePackTranslations() @@ -473,6 +480,56 @@ namespace MinecraftClient.Protocol.Message ResourcePackTranslationLayers.Clear(); } + public static void LoadForgeModTranslations(IEnumerable modIds) + { + ArgumentNullException.ThrowIfNull(modIds); + + ForgeModTranslationLayers.Clear(); + + if (!Config.Main.Advanced.LoadForgeModTranslations || !Directory.Exists(ForgeModTranslationDirectory)) + return; + + HashSet requestedModIds = new( + modIds + .Where(static modId => !string.IsNullOrWhiteSpace(modId)) + .Select(static modId => NormalizeForgeModId(modId)), + StringComparer.OrdinalIgnoreCase); + + if (requestedModIds.Count == 0) + return; + + Dictionary> translationsByModId = + new(StringComparer.OrdinalIgnoreCase); + + foreach (string modJarPath in Directory.EnumerateFiles(ForgeModTranslationDirectory, "*.jar") + .OrderBy(static path => path, StringComparer.OrdinalIgnoreCase)) + { + try + { + using FileStream modJarStream = File.OpenRead(modJarPath); + MergeForgeModTranslations(modJarStream, requestedModIds, translationsByModId); + } + catch (IOException) + { + } + catch (InvalidDataException) + { + } + catch (JsonException) + { + } + } + + foreach (string modId in requestedModIds) + { + if (translationsByModId.TryGetValue(modId, out Dictionary? translations) + && translations.Count > 0) + { + ForgeModTranslationLayers.Add(new TranslationLayer(modId, translations)); + } + } + } + /// /// Format text using a specific formatting rule. /// Example : * %s %s + ["ORelio", "is doing something"] = * ORelio is doing something @@ -532,7 +589,7 @@ namespace MinecraftClient.Protocol.Message else return "[" + rulename + "] " + string.Join(" ", using_data); } - private static bool TryGetTranslationRule(string rulename, out string? result) + private static bool TryGetTranslationRule(string rulename, [NotNullWhen(true)] out string? result) { for (int i = ResourcePackTranslationLayers.Count - 1; i >= 0; i--) { @@ -540,6 +597,12 @@ namespace MinecraftClient.Protocol.Message return true; } + for (int i = ForgeModTranslationLayers.Count - 1; i >= 0; i--) + { + if (ForgeModTranslationLayers[i].Translations.TryGetValue(rulename, out result)) + return true; + } + return TranslationRules.TryGetValue(rulename, out result); } @@ -609,7 +672,7 @@ namespace MinecraftClient.Protocol.Message return mergedTranslations; } - private static bool TryGetResourcePackLanguage(string entryPath, out string? language) + private static bool TryGetResourcePackLanguage(string entryPath, [NotNullWhen(true)] out string? language) { language = null; @@ -647,11 +710,150 @@ namespace MinecraftClient.Protocol.Message RemoveResourcePackTranslations(packIdentifier); if (translations.Count > 0) - ResourcePackTranslationLayers.Add(new ResourcePackTranslationLayer(packIdentifier, translations)); + ResourcePackTranslationLayers.Add(new TranslationLayer(packIdentifier, translations)); + } + + private static void MergeForgeModTranslations(Stream modJarStream, HashSet requestedModIds, + Dictionary> translationsByModId) + { + using ZipArchive archive = new(modJarStream, ZipArchiveMode.Read, leaveOpen: true); + + HashSet archiveModIds = GetForgeModIds(archive) + .Where(requestedModIds.Contains) + .ToHashSet(StringComparer.OrdinalIgnoreCase); + + if (archiveModIds.Count == 0) + return; + + Dictionary> archiveTranslations = ExtractForgeModTranslations(archive, archiveModIds); + foreach (var (modId, translations) in archiveTranslations) + translationsByModId[modId] = translations; + } + + private static HashSet GetForgeModIds(ZipArchive archive) + { + ZipArchiveEntry? modsTomlEntry = archive.Entries.FirstOrDefault(entry => + entry.FullName.Equals("META-INF/mods.toml", StringComparison.OrdinalIgnoreCase)); + + if (modsTomlEntry is null) + return []; + + HashSet modIds = new(StringComparer.OrdinalIgnoreCase); + using StreamReader reader = new(modsTomlEntry.Open(), Encoding.UTF8, detectEncodingFromByteOrderMarks: true); + + while (reader.ReadLine() is string line) + { + string trimmedLine = line.Trim(); + if (trimmedLine.StartsWith('#')) + continue; + + Match match = ForgeModIdLineRegex.Match(trimmedLine); + if (match.Success) + modIds.Add(NormalizeForgeModId(match.Groups[1].Value)); + } + + return modIds; + } + + private static Dictionary> ExtractForgeModTranslations(ZipArchive archive, HashSet requestedModIds) + { + string selectedLanguage = NormalizeLanguageCode(Config.Main.Advanced.Language); + Dictionary> fallbackTranslations = + new(StringComparer.OrdinalIgnoreCase); + Dictionary> selectedTranslations = + new(StringComparer.OrdinalIgnoreCase); + + foreach (ZipArchiveEntry entry in archive.Entries) + { + if (!TryGetForgeModLanguage(entry.FullName, out string? modId, out string? language)) + continue; + + if (!requestedModIds.Contains(modId)) + continue; + + if (language.Equals("en_us", StringComparison.OrdinalIgnoreCase)) + { + if (!fallbackTranslations.TryGetValue(modId, out Dictionary? translations)) + { + translations = new Dictionary(StringComparer.Ordinal); + fallbackTranslations[modId] = translations; + } + + MergeResourcePackTranslations(entry, translations); + } + else if (language.Equals(selectedLanguage, StringComparison.OrdinalIgnoreCase)) + { + if (!selectedTranslations.TryGetValue(modId, out Dictionary? translations)) + { + translations = new Dictionary(StringComparer.Ordinal); + selectedTranslations[modId] = translations; + } + + MergeResourcePackTranslations(entry, translations); + } + } + + Dictionary> mergedTranslations = + new(StringComparer.OrdinalIgnoreCase); + + foreach (string modId in requestedModIds) + { + Dictionary modTranslations = new(StringComparer.Ordinal); + + if (fallbackTranslations.TryGetValue(modId, out Dictionary? fallback)) + { + foreach (var (key, value) in fallback) + modTranslations[key] = value; + } + + if (selectedTranslations.TryGetValue(modId, out Dictionary? selected)) + { + foreach (var (key, value) in selected) + modTranslations[key] = value; + } + + if (modTranslations.Count > 0) + mergedTranslations[modId] = modTranslations; + } + + return mergedTranslations; + } + + private static bool TryGetForgeModLanguage(string entryPath, [NotNullWhen(true)] out string? modId, + [NotNullWhen(true)] out string? language) + { + modId = null; + language = null; + + string[] pathParts = entryPath + .Replace('\\', '/') + .Split('/', StringSplitOptions.RemoveEmptyEntries); + + if (pathParts.Length != 4 + || !pathParts[0].Equals("assets", StringComparison.OrdinalIgnoreCase) + || !pathParts[2].Equals("lang", StringComparison.OrdinalIgnoreCase) + || !pathParts[3].EndsWith(".json", StringComparison.OrdinalIgnoreCase)) + { + return false; + } + + modId = NormalizeForgeModId(pathParts[1]); + language = NormalizeLanguageCode(Path.GetFileNameWithoutExtension(pathParts[3])); + return !string.IsNullOrEmpty(modId) && !string.IsNullOrEmpty(language); + } + + private static string NormalizeForgeModId(string modId) + { + return Settings.ToLowerIfNeed(modId.Trim()); + } + + private static string NormalizeLanguageCode(string language) + { + return Settings.ToLowerIfNeed(language.Trim()).Replace('-', '_'); } private static bool TryLoadCachedResourcePackTranslations(string cacheFilePath, Uri resourcePackUri, string hash, - out Dictionary? translations) + [NotNullWhen(true)] out Dictionary? translations) { translations = null; diff --git a/MinecraftClient/Resources/ConfigComments/ConfigComments.resx b/MinecraftClient/Resources/ConfigComments/ConfigComments.resx index f7588f37..b5369fc7 100644 --- a/MinecraftClient/Resources/ConfigComments/ConfigComments.resx +++ b/MinecraftClient/Resources/ConfigComments/ConfigComments.resx @@ -687,6 +687,9 @@ Usage examples: "/tell <mybot> reco Player2", "/connect <serverip> P Load translations from server resource packs and cache extracted language entries locally for faster reuse. + + Load translations from local Forge mod jars in the mods folder when their mod IDs are announced by the server. + Use "auto", "no" or "force". Force-enabling only works for MC 1.13+. diff --git a/MinecraftClient/Settings.cs b/MinecraftClient/Settings.cs index 6c32f9be..b5e8a562 100644 --- a/MinecraftClient/Settings.cs +++ b/MinecraftClient/Settings.cs @@ -778,6 +778,9 @@ namespace MinecraftClient [TomlInlineComment("$Main.Advanced.load_resourcepack_translations$")] public bool LoadResourcePackTranslations = true; + [TomlInlineComment("$Main.Advanced.load_forge_mod_translations$")] + public bool LoadForgeModTranslations = true; + // [TomlInlineComment("$Main.Advanced.console_title$")] public string ConsoleTitle = "%username%@%serverip% - Minecraft Console Client"; diff --git a/docs/guide/configuration.md b/docs/guide/configuration.md index 10e4ca00..bb553988 100644 --- a/docs/guide/configuration.md +++ b/docs/guide/configuration.md @@ -279,6 +279,16 @@ Coordinate = { x = 145, y = 64, z = 2045 } - **Default:** `true` +#### `LoadForgeModTranslations` + +- **Description:** + + Set this to `false` to ignore translations from local Forge mod jars. When enabled, MCC looks in the local `mods` folder, reads matching `assets//lang/.json` files from jars announced by the server, and falls back to `en_us` when the selected locale is missing. + +- **Type:** `boolean` + +- **Default:** `true` + #### `ConsoleTitle` - **Description:**