Add object sources for steam/gog and openloco (#107)

* add more object sources

* cleanup

* clean db, misc fixes

Author: LeftofZen

Dat/Data/ObjectSource.cs

@@ -0,0 +1,10 @@
+namespace OpenLoco.Dat.Data
+{
+	public enum ObjectSource // note this is similar to the DAT enum `SourceGame`, but we need more definition now
+	{
+		Custom,
+		LocomotionSteam,
+		LocomotionGoG,
+		OpenLoco,
+	}
+}

Dat/Data/OriginalObjectFiles.cs

@@ -26,18 +26,20 @@ public void SaveIndex(string indexFile)
 
 		public void SaveIndex(string indexFile, JsonSerializerOptions options)
 			=> File.WriteAllText(indexFile, JsonSerializer.Serialize(this, options));
+
 		public static async Task<ObjectIndexEntry> GetDatFileInfoFromBytesAsync((string Filename, byte[] Data) file)
 			=> await Task.Run(() => GetDatFileInfoFromBytes(file));
 
-		public static async Task<ObjectIndex?> LoadOrCreateIndexAsync(string directory, IProgress<float>? progress = null)
+		public static async Task<ObjectIndex> LoadOrCreateIndexAsync(string directory, IProgress<float>? progress = null)
 		{
 			var indexPath = Path.Combine(directory, DefaultIndexFileName);
-			ObjectIndex? index;
+			ObjectIndex? index = null;
 			if (File.Exists(indexPath))
 			{
 				index = LoadIndex(indexPath);
 			}
-			else
+
+			if (index == null)
 			{
 				index = await CreateIndexAsync(directory, progress);
 				index.SaveIndex(indexPath);
@@ -46,7 +48,7 @@ public static async Task<ObjectIndexEntry> GetDatFileInfoFromBytesAsync((string
 			return index;
 		}
 
-		public static ObjectIndex? LoadOrCreateIndex(string directory, IProgress<float>? progress = null)
+		public static ObjectIndex LoadOrCreateIndex(string directory, IProgress<float>? progress = null)
 			=> LoadOrCreateIndexAsync(directory, progress).Result;
 
 		public static Task<ObjectIndex> CreateIndexAsync(string directory, IProgress<float>? progress = null)
@@ -107,16 +109,16 @@ public static ObjectIndexEntry GetDatFileInfoFromBytes((string Filename, byte[]
 			}
 
 			var remainingData = file.Data[(S5Header.StructLength + ObjectHeader.StructLength)..];
-			var isVanilla = hdrs.S5.IsVanilla();
+			var source = OriginalObjectFiles.GetFileSource(hdrs.S5.Name, hdrs.S5.Checksum);
 
 			if (hdrs.S5.ObjectType == ObjectType.Vehicle)
 			{
 				var decoded = SawyerStreamReader.Decode(hdrs.Obj.Encoding, remainingData, 4); // only need 4 bytes since vehicle type is in the 4th byte of a vehicle object
-				return new ObjectIndexEntry(file.Filename, hdrs.S5.Name, hdrs.S5.Checksum, hdrs.S5.ObjectType, isVanilla, (VehicleType)decoded[3]);
+				return new ObjectIndexEntry(file.Filename, hdrs.S5.Name, hdrs.S5.Checksum, hdrs.S5.ObjectType, source, (VehicleType)decoded[3]);
 			}
 			else
 			{
-				return new ObjectIndexEntry(file.Filename, hdrs.S5.Name, hdrs.S5.Checksum, hdrs.S5.ObjectType, isVanilla);
+				return new ObjectIndexEntry(file.Filename, hdrs.S5.Name, hdrs.S5.Checksum, hdrs.S5.ObjectType, source);
 			}
 		}
 	}
@@ -126,6 +128,6 @@ public record ObjectIndexEntry(
 		string DatName,
 		uint32_t DatChecksum,
 		ObjectType ObjectType,
-		bool IsVanilla,
+		ObjectSource ObjectSource,
 		VehicleType? VehicleType = null);
 }

Dat/ObjectIndex.cs

@@ -80,6 +80,6 @@ public bool IsVanilla()
 			=> IsVanilla(Name, Checksum);
 
 		public static bool IsVanilla(string name, uint checksum)
-			=> OriginalObjectFiles.GetFileSource(name, checksum) != FileSource.Custom;
+			=> OriginalObjectFiles.GetFileSource(name, checksum) != ObjectSource.Custom;
 	}
 }

Dat/Types/S5Header.cs

@@ -45,12 +45,42 @@
 var objectMetadata = JsonSerializer.Deserialize<IEnumerable<ObjectMetadata>>(File.ReadAllText("Q:\\Games\\Locomotion\\Server\\Objects\\objectMetadata.json"), jsonOptions)
 	.ToDictionary(x => (x.DatName, x.DatChecksum), x => x);
 
-Console.WriteLine($"MetadataCount={objectMetadata.Count()}");
+Console.WriteLine($"MetadataCount={objectMetadata.Count}");
 
 var dir = "Q:\\Games\\Locomotion\\Server\\Objects";
 var index = ObjectIndex.LoadOrCreateIndex(dir);
 var logger = new Logger();
 
+foreach (var meta in objectMetadata)
+{
+	if (!index.TryFind(meta.Key, out var entry) || entry == null)
+	{
+		continue;
+	}
+
+	var source = OriginalObjectFiles.GetFileSource(meta.Key);
+	var sourceString = source switch
+	{
+		ObjectSource.Custom => "custom",
+		ObjectSource.LocomotionSteam => "loco.steam",
+		ObjectSource.LocomotionGoG => "loco.gog",
+		ObjectSource.OpenLoco => "openloco",
+		_ => throw new NotImplementedException(),
+	};
+
+	var vehicleString = entry.ObjectType.ToString().ToLower();
+	if (entry.VehicleType != null)
+	{
+		vehicleString += entry.VehicleType.ToString()!.ToLower();
+	}
+
+	var uniqueName = string.Join('.', source.ToString(), entry.VehicleType.ToString(), entry.DatName);
+
+	// check uniqueness and append an identifier if necessary
+
+	objectMetadata[meta.Key] = meta.Value with { UniqueName = uniqueName };
+}
+
 var objectList = new List<(DatFileInfo DatFileInfo, VehicleObject Vehicle)>();
 var count = 0;
 foreach (var obj in index.Objects.Where(x => x.ObjectType == ObjectType.Vehicle))
@@ -112,9 +142,11 @@ void AddNewObjectMetadataEntries()
 	foreach (var obj in index.Objects)
 	{
 		var key = (obj.DatName, obj.DatChecksum);
+		var source = OriginalObjectFiles.GetFileSource(key);
+
 		if (!objectMetadata.ContainsKey(key))
 		{
-			objectMetadata.Add(key, new ObjectMetadata(Path.GetFileNameWithoutExtension(obj.Filename), obj.DatName, obj.DatChecksum, null, [], [], [], null, OpenLoco.Definitions.ObjectAvailability.AllGames));
+			objectMetadata.Add(key, new ObjectMetadata(Path.GetFileNameWithoutExtension(obj.Filename), obj.DatName, obj.DatChecksum, null, [], [], [], null, OpenLoco.Definitions.ObjectAvailability.AllGames, source));
 		}
 	}
 

DataSanitiser/Program.cs

@@ -35,7 +35,8 @@
 		o.Tags.Select(t => t.Name).ToList(),
 		o.Modpacks.Select(m => m.Name).ToList(),
 		o.Object.Licence?.Name,
-		o.Object.Availability);
+		o.Object.Availability,
+		o.Object.ObjectSource);
 	objs.Add(obj);
 }
 

DatabaseExporter/Program.cs

@@ -1,5 +1,6 @@
 using Microsoft.EntityFrameworkCore;
 using OpenLoco.Dat;
+using OpenLoco.Dat.Data;
 using OpenLoco.Definitions;
 using OpenLoco.Definitions.Database;
 using OpenLoco.Definitions.SourceData;
@@ -124,13 +125,15 @@ static void SeedDb(LocoDb db, bool deleteExisting)
 			var metadataKey = (objIndex.DatName, objIndex.DatChecksum);
 			if (!objectMetadataDict.TryGetValue(metadataKey, out var meta))
 			{
-				var newMetadata = new ObjectMetadata(Guid.NewGuid().ToString(), objIndex.DatName, objIndex.DatChecksum, null, [], [], [], null, ObjectAvailability.AllGames);
+				var newMetadata = new ObjectMetadata(Guid.NewGuid().ToString(), objIndex.DatName, objIndex.DatChecksum, null, [], [], [], null, ObjectAvailability.AllGames, ObjectSource.Custom);
 				meta = newMetadata;
 				objectMetadataDict.Add((objIndex.DatName, objIndex.DatChecksum), newMetadata);
 			}
 
 			var filename = Path.Combine(ObjDirectory, objIndex.Filename);
-			var creationTime = objIndex.IsVanilla ? gameReleaseDate : File.GetLastWriteTimeUtc(filename); // this is the "Modified" time as shown in Windows
+			var creationTime = objIndex.ObjectSource is ObjectSource.LocomotionSteam or ObjectSource.LocomotionGoG
+				? gameReleaseDate
+				: File.GetLastWriteTimeUtc(filename); // this is the "Modified" time as shown in Windows
 
 			var authors = meta.Authors == null ? null : db.Authors.Where(x => meta.Authors.Contains(x.Name)).ToList();
 			var tags = meta.Tags == null ? null : db.Tags.Where(x => meta.Tags.Contains(x.Name)).ToList();
@@ -142,7 +145,7 @@ static void SeedDb(LocoDb db, bool deleteExisting)
 				UniqueName = meta!.UniqueName,
 				DatName = objIndex.DatName,
 				DatChecksum = objIndex.DatChecksum,
-				IsVanilla = objIndex.IsVanilla,
+				ObjectSource = objIndex.ObjectSource,
 				ObjectType = objIndex.ObjectType,
 				VehicleType = objIndex.VehicleType,
 				Description = meta?.Description,

DatabaseSeeder/Program.cs

@@ -10,7 +10,7 @@ public record DtoDatObjectWithMetadata(
 		string DatName,
 		uint DatChecksum,
 		string? DatBytes, // base64-encoded
-		bool IsVanilla,
+		ObjectSource ObjectSource,
 		ObjectType ObjectType,
 		VehicleType? VehicleType,
 		string? Description,

Definitions/DTO/DtoDatObjectWithMetadata.cs

@@ -8,6 +8,6 @@ public record DtoObjectIndexEntry(
 		string DatName,
 		uint DatChecksum,
 		ObjectType ObjectType,
-		bool IsVanilla,
+		ObjectSource ObjectSource,
 		VehicleType? VehicleType);
 }

Definitions/DTO/DtoObjectIndexEntry.cs

@@ -21,7 +21,7 @@ public class TblLocoObject
 
 		#endregion
 
-		public bool IsVanilla { get; set; }
+		public ObjectSource ObjectSource { get; set; }
 
 		public ObjectType ObjectType { get; set; }