Expose mod.yaml content to localisation.

Mod metadata, load screens and mod content is all now sourced from ftl files, allowing these items to be translated.

Translations are now initialized as part of ModData creation, as currently they are made available too late for the usage we need here.

The "modcontent" mod learns a new parameter for "Content.TranslationFile" - this allows a mod to provide the path of a translation file to the mod which it can load. This allows mods such as ra, cnc, d2k, ts to own the translations for their ModContent, yet still make them accessible to the modcontent mod.

CheckFluentReference learns to validate all these new fields to ensure translations have been set.

Author: RoosterDragon

OpenRA.Game/ExternalMods.cs

@@ -27,7 +27,6 @@ public class ExternalMod
 	{
 		public readonly string Id;
 		public readonly string Version;
-		public readonly string Title;
 		public readonly string LaunchPath;
 		public readonly string[] LaunchArgs;
 		public Sprite Icon { get; internal set; }
@@ -127,7 +126,6 @@ internal void Register(Manifest mod, string launchPath, IEnumerable<string> laun
 			{
 				new MiniYamlNode("Id", mod.Id),
 				new MiniYamlNode("Version", mod.Metadata.Version),
-				new MiniYamlNode("Title", mod.Metadata.Title),
 				new MiniYamlNode("LaunchPath", launchPath),
 				new MiniYamlNode("LaunchArgs", new[] { "Game.Mod=" + mod.Id }.Concat(launchArgs).JoinWith(", "))
 			}));

OpenRA.Game/Game.cs

@@ -395,7 +395,7 @@ static void Initialize(Arguments args)
 			Mods = new InstalledMods(modSearchPaths, explicitModPaths);
 			Console.WriteLine("Internal mods:");
 			foreach (var mod in Mods)
-				Console.WriteLine($"\t{mod.Key}: {mod.Value.Metadata.Title} ({mod.Value.Metadata.Version})");
+				Console.WriteLine($"\t{mod.Key} ({mod.Value.Metadata.Version})");
 
 			modLaunchWrapper = args.GetValue("Engine.LaunchWrapper", null);
 
@@ -420,7 +420,7 @@ static void Initialize(Arguments args)
 
 			Console.WriteLine("External mods:");
 			foreach (var mod in ExternalMods)
-				Console.WriteLine($"\t{mod.Key}: {mod.Value.Title} ({mod.Value.Version})");
+				Console.WriteLine($"\t{mod.Key} ({mod.Value.Version})");
 
 			InitializeMod(modID, args);
 		}
@@ -499,8 +499,8 @@ public static void InitializeMod(string mod, Arguments args)
 			Cursor = new CursorManager(ModData.CursorProvider, ModData.Manifest.CursorSheetSize);
 
 			var metadata = ModData.Manifest.Metadata;
-			if (!string.IsNullOrEmpty(metadata.WindowTitle))
-				Renderer.Window.SetWindowTitle(metadata.WindowTitle);
+			if (!string.IsNullOrEmpty(metadata.WindowTitleTranslated))
+				Renderer.Window.SetWindowTitle(metadata.WindowTitleTranslated);
 
 			PerfHistory.Items["render"].HasNormalTick = false;
 			PerfHistory.Items["batches"].HasNormalTick = false;

OpenRA.Game/Manifest.cs

@@ -45,12 +45,20 @@ public SpriteSequenceFormat(MiniYaml yaml)
 
 	public class ModMetadata
 	{
-		public string Title;
-		public string Version;
-		public string Website;
-		public string WebIcon32;
-		public string WindowTitle;
-		public bool Hidden;
+		// FieldLoader used here, must matching naming in YAML.
+#pragma warning disable IDE1006 // Naming Styles
+		[FluentReference]
+		readonly string Title;
+		public readonly string Version;
+		public readonly string Website;
+		public readonly string WebIcon32;
+		[FluentReference]
+		readonly string WindowTitle;
+		public readonly bool Hidden;
+#pragma warning restore IDE1006 // Naming Styles
+
+		public string TitleTranslated => FluentProvider.GetString(Title);
+		public string WindowTitleTranslated => WindowTitle != null ? FluentProvider.GetString(WindowTitle) : null;
 	}
 
 	/// <summary>Describes what is to be loaded in order to run a mod.</summary>

OpenRA.Game/ModData.cs

@@ -65,6 +65,8 @@ public ModData(Manifest mod, InstalledMods mods, bool useLoadScreen = false)
 
 			Manifest.LoadCustomData(ObjectCreator);
 
+			FluentProvider.Initialize(this, DefaultFileSystem);
+
 			if (useLoadScreen)
 			{
 				LoadScreen = ObjectCreator.CreateObject<ILoadScreen>(Manifest.LoadScreen.Value);

OpenRA.Game/Network/GameServer.cs

@@ -182,13 +182,13 @@ public GameServer(MiniYaml yaml)
 				if (external != null && external.Version == Version)
 				{
 					// Use external mod registration to populate the section header
-					ModTitle = external.Title;
+					ModTitle = external.Id;
 				}
 				else if (Game.Mods.TryGetValue(Mod, out var mod))
 				{
 					// Use internal mod data to populate the section header, but
 					// on-connect switching must use the external mod plumbing.
-					ModTitle = mod.Metadata.Title;
+					ModTitle = mod.Metadata.TitleTranslated;
 				}
 				else
 				{
@@ -199,7 +199,7 @@ public GameServer(MiniYaml yaml)
 						.FirstOrDefault(m => m.Id == Mod);
 
 					if (guessMod != null)
-						ModTitle = guessMod.Title;
+						ModTitle = guessMod.Id;
 					else
 						ModTitle = $"Unknown mod: {Mod}";
 				}
@@ -222,7 +222,7 @@ public GameServer(Server.Server server)
 			Map = server.Map.Uid;
 			Mod = manifest.Id;
 			Version = manifest.Metadata.Version;
-			ModTitle = manifest.Metadata.Title;
+			ModTitle = manifest.Metadata.TitleTranslated;
 			ModWebsite = manifest.Metadata.Website;
 			ModIcon32 = manifest.Metadata.WebIcon32;
 			Protected = !string.IsNullOrEmpty(server.Settings.Password);

OpenRA.Game/Network/SyncReport.cs

@@ -122,7 +122,7 @@ internal void DumpSyncReport(int frame)
 					Log.Write("sync", $"Player: {Game.Settings.Player.Name} ({Platform.CurrentPlatform} {Environment.OSVersion} {Platform.RuntimeVersion})");
 					if (Game.IsHost)
 						Log.Write("sync", "Player is host.");
-					Log.Write("sync", $"Game ID: {orderManager.LobbyInfo.GlobalSettings.GameUid} (Mod: {mod.Title} at Version {mod.Version})");
+					Log.Write("sync", $"Game ID: {orderManager.LobbyInfo.GlobalSettings.GameUid} (Mod: {mod.TitleTranslated} at Version {mod.Version})");
 					Log.Write("sync", $"Sync for net frame {r.Frame} -------------");
 					Log.Write("sync", $"SharedRandom: {r.SyncedRandom} (#{r.TotalCount})");
 					Log.Write("sync", "Synced Traits:");

OpenRA.Game/Support/ExceptionHandler.cs

@@ -31,8 +31,8 @@ public static void HandleFatalError(Exception ex)
 
 			if (Game.ModData != null)
 			{
-				var mod = Game.ModData.Manifest.Metadata;
-				Log.Write("exception", $"{mod.Title} mod version {mod.Version}");
+				var manifest = Game.ModData.Manifest;
+				Log.Write("exception", $"{manifest.Id} mod version {manifest.Metadata.Version}");
 			}
 
 			if (Game.OrderManager != null && Game.OrderManager.World != null && Game.OrderManager.World.Map != null)

OpenRA.Mods.Cnc/CncLoadScreen.cs

@@ -19,6 +19,9 @@ namespace OpenRA.Mods.Cnc
 {
 	public sealed class CncLoadScreen : SheetLoadScreen
 	{
+		[FluentReference]
+		const string Loading = "loadscreen-loading";
+
 		int loadTick;
 
 		Sprite nodLogo, gdiLogo, evaLogo, brightBlock, dimBlock;
@@ -31,11 +34,15 @@ public sealed class CncLoadScreen : SheetLoadScreen
 		int lastDensity;
 		Size lastResolution;
 
+		string message = "";
+
 		public override void Init(ModData modData, Dictionary<string, string> info)
 		{
 			base.Init(modData, info);
 
 			versionText = modData.Manifest.Metadata.Version;
+
+			message = FluentProvider.GetString(Loading);
 		}
 
 		public override void DisplayInner(Renderer r, Sheet s, int density)
@@ -89,7 +96,7 @@ public override void DisplayInner(Renderer r, Sheet s, int density)
 			if (r.Fonts != null)
 			{
 				var loadingFont = r.Fonts["BigBold"];
-				var loadingText = Info["Text"];
+				var loadingText = message;
 				var loadingPos = new float2((bounds.Width - loadingFont.Measure(loadingText).X) / 2, barY);
 				loadingFont.DrawText(loadingText, loadingPos, Color.Gray);
 

OpenRA.Mods.Common/FileSystem/DefaultFileSystemLoader.cs

@@ -48,7 +48,12 @@ bool IFileSystemExternalContent.InstallContentIfRequired(ModData modData)
 			if (contentInstalled)
 				return false;
 
-			Game.InitializeMod(content.ContentInstallerMod, new Arguments("Content.Mod=" + modData.Manifest.Id));
+			string translationPath;
+			using (var fs = (FileStream)modData.DefaultFileSystem.Open(content.Translation))
+				translationPath = fs.Name;
+			Game.InitializeMod(
+				content.ContentInstallerMod,
+				new Arguments(new[] { "Content.Mod=" + modData.Manifest.Id, "Content.TranslationFile=" + translationPath }));
 			return true;
 		}
 	}

OpenRA.Mods.Common/Lint/CheckFluentReferences.cs

@@ -43,16 +43,17 @@ void ILintMapPass.Run(Action<string> emitError, Action<string> emitWarning, ModD
 
 			var mapTranslations = FieldLoader.GetValue<string[]>("value", map.TranslationDefinitions.Value);
 
-			foreach (var language in GetModLanguages(modData))
+			var allModTranslations = modData.Manifest.Translations.Append(modData.Manifest.Get<ModContent>().Translation).ToArray();
+			foreach (var language in GetModLanguages(allModTranslations))
 			{
 				// Check keys and variables are not missing across all language files.
 				// But for maps we don't warn on unused keys. They might be unused on *this* map,
 				// but the mod or another map may use them and we don't have sight of that.
 				CheckKeys(
-					modData.Manifest.Translations.Concat(mapTranslations), map.Open, usedKeys,
+					allModTranslations.Concat(mapTranslations), map.Open, usedKeys,
 					language, _ => false, emitError, emitWarning);
 
-				var modFluentBundle = new FluentBundle(language, modData.Manifest.Translations, modData.DefaultFileSystem, _ => { });
+				var modFluentBundle = new FluentBundle(language, allModTranslations, modData.DefaultFileSystem, _ => { });
 				var mapFluentBundle = new FluentBundle(language, mapTranslations, map, error => emitError(error.Message));
 
 				foreach (var group in usedKeys.KeysWithContext)
@@ -78,14 +79,15 @@ void ILintPass.Run(Action<string> emitError, Action<string> emitWarning, ModData
 			foreach (var context in usedKeys.EmptyKeyContexts)
 				emitWarning($"Empty key in mod translation files required by {context}");
 
-			foreach (var language in GetModLanguages(modData))
+			var allModTranslations = modData.Manifest.Translations.Append(modData.Manifest.Get<ModContent>().Translation).ToArray();
+			foreach (var language in GetModLanguages(allModTranslations))
 			{
 				Console.WriteLine($"Testing language: {language}");
 				CheckModWidgets(modData, usedKeys, testedFields);
 
 				// With the fully populated keys, check keys and variables are not missing and not unused across all language files.
 				var keyWithAttrs = CheckKeys(
-					modData.Manifest.Translations, modData.DefaultFileSystem.Open, usedKeys,
+					allModTranslations, modData.DefaultFileSystem.Open, usedKeys,
 					language,
 					file =>
 						!modData.Manifest.AllowUnusedTranslationsInExternalPackages ||
@@ -113,9 +115,9 @@ void ILintPass.Run(Action<string> emitError, Action<string> emitWarning, ModData
 					$"`{field.ReflectedType.Name}.{field.Name}` - previous warnings may be incorrect");
 		}
 
-		static IEnumerable<string> GetModLanguages(ModData modData)
+		static IEnumerable<string> GetModLanguages(IEnumerable<string> translations)
 		{
-			return modData.Manifest.Translations
+			return translations
 				.Select(filename => FilenameRegex.Match(filename).Groups["language"].Value)
 				.Distinct()
 				.OrderBy(l => l);
@@ -249,51 +251,55 @@ static Keys GetUsedFluentKeysInMap(Map map, Action<string> emitWarning)
 				.Where(t => t.IsSubclassOf(typeof(TraitInfo)) || t.IsSubclassOf(typeof(Warhead)))
 				.SelectMany(t => t.GetFields().Where(f => f.HasAttribute<FluentReferenceAttribute>())));
 
-			// HACK: Need to hardcode the custom loader for GameSpeeds.
-			var gameSpeeds = modData.Manifest.Get<GameSpeeds>();
-			var gameSpeedNameField = typeof(GameSpeed).GetField(nameof(GameSpeed.Name));
-			var gameSpeedFluentReference = Utility.GetCustomAttributes<FluentReferenceAttribute>(gameSpeedNameField, true)[0];
-			testedFields.Add(gameSpeedNameField);
-			foreach (var speed in gameSpeeds.Speeds.Values)
-				usedKeys.Add(speed.Name, gameSpeedFluentReference, $"`{nameof(GameSpeed)}.{nameof(GameSpeed.Name)}`");
+			// TODO: linter does not work with LoadUsing
+			GetUsedTranslationKeysFromFieldsWithTranslationReferenceAttribute(
+				usedKeys, testedFields, Utility.GetFields(typeof(GameSpeed)), modData.Manifest.Get<GameSpeeds>().Speeds.Values);
 
 			// TODO: linter does not work with LoadUsing
-			foreach (var actorInfo in modData.DefaultRules.Actors)
-			{
-				foreach (var info in actorInfo.Value.TraitInfos<ResourceRendererInfo>())
-				{
-					var resourceTypeNameField = typeof(ResourceRendererInfo.ResourceTypeInfo).GetField(nameof(ResourceRendererInfo.ResourceTypeInfo.Name));
-					var resourceTypeFluentReference = Utility.GetCustomAttributes<FluentReferenceAttribute>(resourceTypeNameField, true)[0];
-					testedFields.Add(resourceTypeNameField);
-					foreach (var resourceTypes in info.ResourceTypes)
-						usedKeys.Add(
-							resourceTypes.Value.Name,
-							resourceTypeFluentReference,
-							$"`{nameof(ResourceRendererInfo.ResourceTypeInfo)}.{nameof(ResourceRendererInfo.ResourceTypeInfo.Name)}`");
-				}
-			}
+			GetUsedTranslationKeysFromFieldsWithTranslationReferenceAttribute(
+				usedKeys, testedFields,
+				Utility.GetFields(typeof(ResourceRendererInfo.ResourceTypeInfo)),
+				modData.DefaultRules.Actors
+					.SelectMany(actorInfo => actorInfo.Value.TraitInfos<ResourceRendererInfo>())
+					.SelectMany(info => info.ResourceTypes.Values));
+
+			const BindingFlags Binding = BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Static;
+			var constFields = modData.ObjectCreator.GetTypes().SelectMany(modType => modType.GetFields(Binding)).Where(f => f.IsLiteral);
+			GetUsedTranslationKeysFromFieldsWithTranslationReferenceAttribute(
+				usedKeys, testedFields, constFields, new[] { (object)null });
+
+			var modMetadataFields = typeof(ModMetadata).GetFields(BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Instance);
+			GetUsedTranslationKeysFromFieldsWithTranslationReferenceAttribute(
+				usedKeys, testedFields, modMetadataFields, new[] { modData.Manifest.Metadata });
+
+			var modContent = modData.Manifest.Get<ModContent>();
+			GetUsedTranslationKeysFromFieldsWithTranslationReferenceAttribute(
+				usedKeys, testedFields, Utility.GetFields(typeof(ModContent)), new[] { modContent });
+			GetUsedTranslationKeysFromFieldsWithTranslationReferenceAttribute(
+				usedKeys, testedFields, Utility.GetFields(typeof(ModContent.ModPackage)), modContent.Packages.Values);
+
+			return (usedKeys, testedFields);
+		}
 
-			foreach (var modType in modData.ObjectCreator.GetTypes())
+		static void GetUsedTranslationKeysFromFieldsWithTranslationReferenceAttribute(
+			Keys usedKeys, List<FieldInfo> testedFields,
+			IEnumerable<FieldInfo> newFields, IEnumerable<object> objects)
+		{
+			var fieldsWithAttribute =
+				newFields
+					.Select(f => (Field: f, FluentReference: Utility.GetCustomAttributes<FluentReferenceAttribute>(f, true).SingleOrDefault()))
+					.Where(x => x.FluentReference != null)
+					.ToArray();
+			testedFields.AddRange(fieldsWithAttribute.Select(x => x.Field));
+			foreach (var obj in objects)
 			{
-				const BindingFlags Binding = BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Static;
-				foreach (var field in modType.GetFields(Binding))
+				foreach (var (field, fluentReference) in fieldsWithAttribute)
 				{
-					// Checking for constant string fields.
-					if (!field.IsLiteral)
-						continue;
-
-					var fluentReference = Utility.GetCustomAttributes<FluentReferenceAttribute>(field, true).SingleOrDefault();
-					if (fluentReference == null)
-						continue;
-
-					testedFields.Add(field);
-					var keys = LintExts.GetFieldValues(null, field, fluentReference.DictionaryReference);
+					var keys = LintExts.GetFieldValues(obj, field, fluentReference.DictionaryReference);
 					foreach (var key in keys)
 						usedKeys.Add(key, fluentReference, $"`{field.ReflectedType.Name}.{field.Name}`");
 				}
 			}
-
-			return (usedKeys, testedFields);
 		}
 
 		static void CheckModWidgets(ModData modData, Keys usedKeys, List<FieldInfo> testedFields)