Fix the warning about hash detected collision for loc key "Mallobald" (#2761) #patch

Author: IhateTrains

ImperatorToCK3.UnitTests/CK3/Characters/CK3CharacterTests.cs

@@ -24,6 +24,7 @@
 using ImperatorToCK3.UnitTests.Mappers.Trait;
 using ImperatorToCK3.UnitTests.TestHelpers;
 using System;
+using System.Collections.Frozen;
 using System.Collections.Generic;
 using System.Linq;
 using Xunit;
@@ -44,6 +45,7 @@ public class CK3CharacterTests {
 	private static readonly ModFilesystem CK3ModFS = new(CK3Root, Array.Empty<Mod>());
 	private static readonly DNAFactory DNAFactory = new(IRModFS, CK3ModFS);
 	private static TestCK3CultureCollection cultures = new();
+	private static readonly FrozenDictionary<string, string> characterNameOverrides = FrozenDictionary<string, string>.Empty;
 
 	static CK3CharacterTests() {
 		var irProvinces = new ImperatorToCK3.Imperator.Provinces.ProvinceCollection {new(1), new(2), new(3)};
@@ -89,9 +91,9 @@ internal Character Build() {
 				irMapData,
 				provinceMapper,
 				deathReasonMapper,
-				DNAFactory,
 				new Date(867, 1, 1),
 				config,
+				nameOverrides: characterNameOverrides,
 				unlocalizedImperatorNames: []
 			);
 			return character;

ImperatorToCK3.UnitTests/CK3/Characters/CharacterCollectionTests.cs

@@ -29,6 +29,7 @@
 using System.Linq;
 using Xunit;
 using System;
+using System.IO;
 
 namespace ImperatorToCK3.UnitTests.CK3.Characters;
 
@@ -379,4 +380,39 @@ public void ImperatorCountriesGoldCanBeDistributedAmongRulerAndVassals() {
 				Assert.Equal(25, ck3Vassal2.Gold);
 			});
 	}
+
+	[Fact]
+	public void ImperatorCharacterNamesCanBeOverriddenByConfigurable() {
+		Date ck3BookmarkDate = new(867, 1, 1);
+		var configuration = new Configuration { CK3BookmarkDate = ck3BookmarkDate };
+		var imperatorWorld = new TestImperatorWorld(configuration);
+
+		imperatorWorld.Characters.Add(new(0) {Name = "Mallobald"});
+		
+		Directory.CreateDirectory("configurables");
+		const string overridesFilePath = "configurables/character_name_overrides.txt";
+		File.WriteAllText(overridesFilePath, "Mallobald = Mallobald_collision_fix # avoids hash collision in CK3");
+
+		var ck3Characters = new CharacterCollection();
+		var config = new Configuration { CK3BookmarkDate = ck3BookmarkDate };
+		ck3Characters.ImportImperatorCharacters(
+			imperatorWorld,
+			new ReligionMapper(new ReligionCollection(new Title.LandedTitles()), irRegionMapper, new CK3RegionMapper()),
+			new CultureMapper(irRegionMapper, new CK3RegionMapper(), cultures),
+			cultures,
+			new TraitMapper(),
+			new NicknameMapper(),
+			new ProvinceMapper(),
+			new DeathReasonMapper(),
+			new DNAFactory(irModFS, ck3ModFS),
+			new TestCK3LocDB(),
+			new Date(1000, 1, 1, AUC: true),
+			config);
+		
+		var ck3Character = ck3Characters["imperator0"];
+		Assert.Equal("Mallobald_collision_fix", ck3Character.GetName(ck3BookmarkDate));
+		
+		// Clean up.
+		File.Delete(overridesFilePath);
+	}
 }

ImperatorToCK3.UnitTests/CK3/Dynasties/DynastyTests.cs

@@ -4,7 +4,6 @@
 using commonItems.Mods;
 using commonItems.Serialization;
 using ImperatorToCK3.CK3;
-using ImperatorToCK3.CK3.Characters;
 using ImperatorToCK3.CK3.Dynasties;
 using ImperatorToCK3.CK3.Religions;
 using ImperatorToCK3.CK3.Titles;
@@ -23,6 +22,7 @@
 using Xunit;
 using Character = ImperatorToCK3.CK3.Characters.Character;
 using System;
+using System.Collections.Frozen;
 using CharacterCollection = ImperatorToCK3.Imperator.Characters.CharacterCollection;
 
 // ReSharper disable StringLiteralTypo
@@ -39,6 +39,7 @@ public class DynastyTests {
 	private static readonly ImperatorRegionMapper IRRegionMapper;
 	private static readonly CultureMapper CultureMapper;
 	private static readonly TestCK3CultureCollection Cultures = [];
+	private static readonly FrozenDictionary<string, string> characterNameOverrides = FrozenDictionary<string, string>.Empty;
 
 	static DynastyTests() {
 		var irProvinces = new ImperatorToCK3.Imperator.Provinces.ProvinceCollection {new(1), new(2), new(3)};
@@ -87,9 +88,9 @@ public Character Build() {
 				irMapData,
 				provinceMapper,
 				deathReasonMapper,
-				new DNAFactory(IRModFS, ck3ModFS),
 				new Date(867, 1, 1),
 				config,
+				nameOverrides: characterNameOverrides,
 				unlocalizedImperatorNames: []
 			);
 			return character;

ImperatorToCK3.sln.DotSettings

@@ -88,6 +88,7 @@
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=legwear/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=librakaly/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=magick/@EntryIndexedValue">True</s:Boolean>
+	<s:Boolean x:Key="/Default/UserDictionary/Words/=mallobald/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=mapping_0027s/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=Mauretania/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=Maurya/@EntryIndexedValue">True</s:Boolean>

ImperatorToCK3/CK3/Characters/Character.cs

@@ -16,6 +16,7 @@
 using ImperatorToCK3.Mappers.Trait;
 using ImperatorToCK3.Mappers.UnitType;
 using Open.Collections;
+using System.Collections.Frozen;
 using System.Collections.Generic;
 using System.Text;
 using ZLinq;
@@ -371,9 +372,9 @@ internal Character(
 		MapData irMapData,
 		ProvinceMapper provinceMapper,   // used to determine ck3 province for religion mapper
 		DeathReasonMapper deathReasonMapper,
-		DNAFactory dnaFactory,
 		Date dateOnConversion,
 		Configuration config,
+		FrozenDictionary<string, string> nameOverrides,
 		ConcurrentHashSet<string> unlocalizedImperatorNames
 	) {
 		this.characters = characters;
@@ -395,6 +396,9 @@ ConcurrentHashSet<string> unlocalizedImperatorNames
 			}
 		} else {
 			var nameLoc = ImperatorCharacter.Name;
+			if (nameOverrides.TryGetValue(nameLoc, out var overrideName)) {
+				nameLoc = overrideName;
+			}
 			var name = nameLoc.Replace(' ', '_');
 			SetName(name, null);
 			if (!string.IsNullOrEmpty(name)) {

ImperatorToCK3/CK3/Characters/CharacterCollection.cs

@@ -21,6 +21,7 @@
 using System.Collections.Concurrent;
 using System.Collections.Frozen;
 using System.Collections.Generic;
+using System.IO;
 using System.Linq;
 using System.Text.RegularExpressions;
 using System.Threading.Tasks;
@@ -45,6 +46,8 @@ Configuration config
 		Logger.Info("Importing Imperator Characters...");
 
 		var unlocalizedImperatorNames = new ConcurrentHashSet<string>();
+		
+		var nameOverrides = GetImperatorCharacterNameOverrides();
 
 		var parallelOptions = new ParallelOptions {
 			MaxDegreeOfParallelism = Environment.ProcessorCount - 1,
@@ -62,9 +65,9 @@ Configuration config
 				impWorld.MapData,
 				provinceMapper,
 				deathReasonMapper,
-				dnaFactory,
 				conversionDate,
 				config,
+				nameOverrides,
 				unlocalizedImperatorNames
 			);
 		});
@@ -89,6 +92,16 @@ Configuration config
 		}
 	}
 
+	private static FrozenDictionary<string, string> GetImperatorCharacterNameOverrides() {
+		const string configurablePath = "configurables/character_name_overrides.txt";
+		if (!File.Exists(configurablePath)) {
+			Logger.Warn($"{configurablePath} not found, will not override any Imperator character names.");
+			return FrozenDictionary<string, string>.Empty;
+		}
+		var reader = new BufferedReader(File.ReadAllText(configurablePath));
+		return reader.GetAssignments().ToFrozenDictionary();
+	}
+
 	private void ImportImperatorCharacter(
 		Imperator.Characters.Character irCharacter,
 		ReligionMapper religionMapper,
@@ -100,9 +113,9 @@ private void ImportImperatorCharacter(
 		MapData irMapData,
 		ProvinceMapper provinceMapper,
 		DeathReasonMapper deathReasonMapper,
-		DNAFactory dnaFactory,
 		Date endDate,
 		Configuration config,
+		FrozenDictionary<string, string> nameOverrides,
 		ConcurrentHashSet<string> unlocalizedImperatorNames) {
 		// Create a new CK3 character.
 		var newCharacter = new Character(
@@ -117,9 +130,9 @@ private void ImportImperatorCharacter(
 			irMapData,
 			provinceMapper,
 			deathReasonMapper,
-			dnaFactory,
 			endDate,
 			config,
+			nameOverrides,
 			unlocalizedImperatorNames
 		);
 		irCharacter.CK3Character = newCharacter;

ImperatorToCK3/Data_Files/blankMod/output/common/culture/name_lists/IRToCK3_central_germanic.txt

@@ -34,7 +34,8 @@
 		Hraugmund Hraugram Hraugric Hroco Ingast Ingbald Inger Ingmund
 		Ingoht Ingoleik Ingomar Ingram Ingrand Ingrauc Ingric Ingsun
 		Inguiomer Ingwald Laikwald Leigmund Leikbolad Leikrauc Leko
-		Malact Malleik Mallobald Mallobaudes Mallovendus Malo Malobald
+		Malact Malleik Mallobald_collision_fix Mallobaudes Mallovendus Malo Malobald # In CK3 there's a hash collision between the keys "Mallobald" and "laamp_base_contract_schemes.2541.e.tt.employer_has_trait.paranoid", so the key "Mallobald" has been changed to "Mallobald_collision_fix".
+
 		Malogan Malogast Maloger Malogund Maloram Malorand Malorauc
 		Maloric Malowind Malwald Marcobold Marcogan Marcogast Marcoger
 		Marcogund Marcoleik Marcomer Marcomund Marcoram Marcorauc

ImperatorToCK3/Data_Files/blankMod/output/localization/french/ir_names_l_french.yml

@@ -510,7 +510,7 @@
  Leko: "Leko"
  Malact: "Malact"
  Malleik: "Malleik"
- Mallobald: "Mallobald"
+ Mallobald_collision_fix: "Mallobald"
  Mallobaudes: "Mallobaudes"
  Mallovendus: "Mallovendus"
  Malo: "Malo"

ImperatorToCK3/Data_Files/blankMod/output/localization/german/ir_names_l_german.yml

@@ -510,7 +510,7 @@
  Leko: "Leko"
  Malact: "Malact"
  Malleik: "Malleik"
- Mallobald: "Mallobald"
+ Mallobald_collision_fix: "Mallobald"
  Mallobaudes: "Mallobaudes"
  Mallovendus: "Mallovendus"
  Malo: "Malo"

ImperatorToCK3/Data_Files/blankMod/output/localization/korean/ir_names_l_korean.yml

@@ -510,7 +510,7 @@
  Leko: "레코"
  Malact: "마랔트"
  Malleik: "말라잌"
- Mallobald: "말로발드"
+ Mallobald_collision_fix: "말로발드"
  Mallobaudes: "말로바우뎃"
  Mallovendus: "말로벤둣"
  Malo: "마로"