add doc comments and change file locations

Author: incomplete-tree

src/Loader.cs

@@ -148,7 +148,7 @@ public static void AddPatchDataType(string typeId, Type type)
 			typeMappings.Add(typeId, type);
 	}
 
-	internal static void RegisterMods(Dictionary<string, Mod> mods)
+	internal static bool RegisterMods(Dictionary<string, Mod> mods)
 	{
 		Directory.CreateDirectory(Plugin.MODS_PATH);
 		string[] modContainers = Directory.GetDirectories(Plugin.MODS_PATH)
@@ -237,13 +237,11 @@ internal static void RegisterMods(Dictionary<string, Mod> mods)
 		}
 
 		CheckDependencies(mods);
+		var dependencyCycle = !SortMods(Registry.mods);
+		return dependencyCycle;
 	}
-
 	internal static void LoadMods(Dictionary<string, Mod> mods)
 	{
-		var dependencyCycle = !SortMods(Registry.mods);
-		if (dependencyCycle) return;
-
 		StringBuilder checksumString = new();
 		foreach (var (id, mod) in Registry.mods)
 		{
@@ -269,6 +267,69 @@ internal static void LoadMods(Dictionary<string, Mod> mods)
 		Compatibility.HashSignatures(checksumString);
 
 	}
+	internal static void PatchGLD(JObject gameLogicdata, Dictionary<string, Mod> mods)
+	{
+		Loc.BuildAndLoadLocalization(
+			JsonSerializer.Deserialize<Dictionary<string, Dictionary<string, string>>>(
+				Plugin.GetResource("localization.json")
+			)!
+		);
+		foreach (var (id, mod) in mods)
+		{
+			if (mod.status != Mod.Status.Success) continue;
+			foreach (var file in mod.files)
+			{
+				if (Path.GetFileName(file.name) == "localization.json")
+				{
+					Loader.LoadLocalizationFile(mod, file);
+					continue;
+				}
+				if (Regex.IsMatch(Path.GetFileName(file.name), @"^patch(_.*)?\.json$"))
+				{
+					var patchText = new StreamReader(new MemoryStream(file.bytes)).ReadToEnd();
+					var template = new GldConfigTemplate(patchText, mod.id);
+					var text = template.Render();
+					if (text is null)
+					{
+						mod.status = Mod.Status.Error;
+						continue;
+					}
+					Loader.LoadGameLogicDataPatch(
+						mod,
+						gameLogicdata,
+						JObject.Parse(text)
+					);
+					continue;
+				}
+				if (Regex.IsMatch(Path.GetFileName(file.name), @"^prefab(_.*)?\.json$"))
+				{
+					Loader.LoadPrefabInfoFile(
+						mod,
+						file
+					);
+					continue;
+				}
+
+				switch (Path.GetExtension(file.name))
+				{
+					case ".png":
+						Loader.LoadSpriteFile(mod, file);
+						break;
+					case ".wav":
+						Loader.LoadAudioFile(mod, file);
+						break;
+					case ".bundle":
+						Loader.LoadAssetBundle(mod, file);
+						break;
+				}
+			}
+		}
+		TechItem.techTierFirebaseId.Clear();
+		for (int i = 0; i <= Main.MAX_TECH_TIER; i++)
+		{
+			TechItem.techTierFirebaseId.Add($"tech_research_{i}");
+		}
+	}
 	private static void CheckDependencies(Dictionary<string, Mod> mods)
 	{
 		foreach (var (id, mod) in mods)

src/Managers/Config.cs

@@ -4,7 +4,7 @@
 namespace PolyMod.Managers;
 
 /// <summary>
-/// allows mods to save config.
+/// Allows mods to save config.
 /// </summary>
 public class Config<T> where T : class
 {
@@ -91,7 +91,7 @@ public TResult Get<TResult>(Func<T, TResult> getter)
         return getter(currentConfig ?? throw new InvalidOperationException("Must set default before reading config."));
     }
     /// <summary>
-    /// writes the config to disk
+    /// Writes the config to disk
     /// </summary>
     public void SaveChanges()
     {

src/Managers/GLDConfig.cs

@@ -5,7 +5,7 @@
 
 namespace PolyMod.Managers;
 
-public class GldConfigTemplate
+internal class GldConfigTemplate
 {
     private static readonly string ConfigPath = Path.Combine(Plugin.BASE_PATH, "mods.json");
 

src/Managers/Visual.cs

@@ -10,40 +10,93 @@
 
 namespace PolyMod.Managers;
 
+/// <summary>
+/// Manages visual aspects of the game, including sprites, UI elements, and in-game object appearances.
+/// </summary>
 public static class Visual
 {
+	/// <summary>
+	/// Represents a single tile in a tribe's world preview.
+	/// </summary>
 	public class PreviewTile
 	{
+		/// <summary>The X-coordinate of the tile.</summary>
 		[JsonInclude]
 		public int? x = null;
+		/// <summary>The Y-coordinate of the tile.</summary>
 		[JsonInclude]
 		public int? y = null;
+		/// <summary>The type of terrain on the tile.</summary>
 		[JsonInclude]
 		[JsonConverter(typeof(EnumCacheJson<Polytopia.Data.TerrainData.Type>))]
 		public Polytopia.Data.TerrainData.Type terrainType = Polytopia.Data.TerrainData.Type.Ocean;
+		/// <summary>The type of resource on the tile.</summary>
 		[JsonInclude]
 		[JsonConverter(typeof(EnumCacheJson<ResourceData.Type>))]
 		public ResourceData.Type resourceType = ResourceData.Type.None;
+		/// <summary>The type of unit on the tile.</summary>
 		[JsonInclude]
 		[JsonConverter(typeof(EnumCacheJson<UnitData.Type>))]
 		public UnitData.Type unitType = UnitData.Type.None;
+		/// <summary>The type of improvement on the tile.</summary>
 		[JsonInclude]
 		[JsonConverter(typeof(EnumCacheJson<ImprovementData.Type>))]
 		public ImprovementData.Type improvementType = ImprovementData.Type.None;
 	}
+
+	/// <summary>
+	/// Holds information for creating a custom sprite.
+	/// </summary>
+	/// <param name="pixelsPerUnit">The number of pixels per unit for the sprite.</param>
+	/// <param name="pivot">The pivot point of the sprite.</param>
 	public record SpriteInfo(float? pixelsPerUnit, Vector2? pivot);
+
+	/// <summary>
+	/// Holds information about a custom skin.
+	/// </summary>
+	/// <param name="idx">The index of the skin.</param>
+	/// <param name="id">The unique identifier for the skin.</param>
+	/// <param name="skinData">The data associated with the skin.</param>
 	public record SkinInfo(int idx, string id, SkinData? skinData);
+
+	/// <summary>
+	/// A dictionary mapping BasicPopup instance IDs to their custom widths.
+	/// </summary>
 	public static Dictionary<int, int> basicPopupWidths = new();
 	private static bool firstTimeOpeningPreview = true;
 	private static UnitData.Type currentUnitTypeUI = UnitData.Type.None;
 	private static TribeData.Type attackerTribe = TribeData.Type.None;
+
+	/// <summary>
+	/// Defines the types of prefabs that can be customized.
+	/// </summary>
 	public enum PrefabType
 	{
+		/// <summary>A unit prefab.</summary>
 		Unit,
+		/// <summary>An improvement prefab.</summary>
 		Improvement,
+		/// <summary>A resource prefab.</summary>
 		Resource
 	}
+
+	/// <summary>
+	/// Holds information for a custom prefab.
+	/// </summary>
+	/// <param name="type">The type of the prefab.</param>
+	/// <param name="name">The name of the prefab.</param>
+	/// <param name="visualParts">A list of visual parts that make up the prefab.</param>
 	public record PrefabInfo(PrefabType type, string name, List<VisualPartInfo> visualParts);
+
+	/// <summary>
+	/// Represents a visual part of a custom prefab.
+	/// </summary>
+	/// <param name="gameObjectName">The name of the GameObject for this visual part.</param>
+	/// <param name="baseName">The base name for sprite lookups.</param>
+	/// <param name="rotation">The rotation of the visual part.</param>
+	/// <param name="coordinates">The local position of the visual part.</param>
+	/// <param name="scale">The local scale of the visual part.</param>
+	/// <param name="tintable">Whether the visual part can be tinted.</param>
 	public record VisualPartInfo(
 		string gameObjectName,
 		string baseName,
@@ -257,7 +310,7 @@ private static void TerrainRenderer_UpdateGraphics(TerrainRenderer __instance, T
 		if (tile.data.terrain is Polytopia.Data.TerrainData.Type.Forest or Polytopia.Data.TerrainData.Type.Mountain)
 		{
 			string propertyName = terrain.ToLower();
-			terrain = "field";
+				terrain = "field";
 
 			PropertyInfo? rendererProperty = tile.GetType().GetProperty(propertyName + "Renderer",
 				BindingFlags.Public | BindingFlags.Instance);
@@ -565,6 +618,11 @@ private static void PopupBase_Hide(PopupBase __instance)
 		basicPopupWidths.Remove(__instance.GetInstanceID());
 	}
 
+	/// <summary>
+	/// Shows a BasicPopup and sets its width.
+	/// </summary>
+	/// <param name="self">The BasicPopup instance.</param>
+	/// <param name="width">The desired width of the popup.</param>
 	public static void ShowSetWidth(this BasicPopup self, int width)
 	{
 		basicPopupWidths.Add(self.GetInstanceID(), width);
@@ -594,6 +652,13 @@ private static void UpdateVisualPart(SkinVisualsReference.VisualPart visualPart,
 		}
 	}
 
+	/// <summary>
+	/// Creates a <see cref="Sprite"/> from raw image data.
+	/// </summary>
+	/// <param name="data">The byte array containing the image data.</param>
+	/// <param name="pivot">The pivot point for the sprite. Defaults to the center.</param>
+	/// <param name="pixelsPerUnit">The number of pixels per unit for the sprite.</param>
+	/// <returns>A new <see cref="Sprite"/> instance.</returns>
 	public static Sprite BuildSprite(byte[] data, Vector2? pivot = null, float pixelsPerUnit = 2112f)
 	{
 		Texture2D texture = new(1, 1, TextureFormat.RGBA32, true);
@@ -609,6 +674,13 @@ public static Sprite BuildSprite(byte[] data, Vector2? pivot = null, float pixel
 		return BuildSpriteWithTexture(texture, pivot, pixelsPerUnit);
 	}
 
+	/// <summary>
+	/// Creates a <see cref="Sprite"/> from an existing <see cref="Texture2D"/>.
+	/// </summary>
+	/// <param name="texture">The texture to create the sprite from.</param>
+	/// <param name="pivot">The pivot point for the sprite. Defaults to the center.</param>
+	/// <param name="pixelsPerUnit">The number of pixels per unit for the sprite.</param>
+	/// <returns>A new <see cref="Sprite"/> instance.</returns>
 	public static Sprite BuildSpriteWithTexture(Texture2D texture, Vector2? pivot = null, float? pixelsPerUnit = 2112f)
 	{
 		return Sprite.Create(

src/Mod.cs

@@ -1,27 +1,76 @@
 namespace PolyMod;
 
+/// <summary>
+/// Represents a mod, containing its manifest information, status, and files.
+/// </summary>
 public class Mod
 {
+    /// <summary>
+    /// Represents a dependency for a mod.
+    /// </summary>
+    /// <param name="id">The unique identifier of the dependency.</param>
+    /// <param name="min">The minimum compatible version of the dependency.</param>
+    /// <param name="max">The maximum compatible version of the dependency.</param>
+    /// <param name="required">Whether the dependency is required for the mod to function.</param>
     public record Dependency(string id, Version min, Version max, bool required = true);
+
+    /// <summary>
+    /// Represents the manifest of a mod, containing metadata.
+    /// </summary>
+    /// <param name="id">The unique identifier of the mod.</param>
+    /// <param name="name">The display name of the mod.</param>
+    /// <param name="description">A description of the mod.</param>
+    /// <param name="version">The version of the mod.</param>
+    /// <param name="authors">The authors of the mod.</param>
+    /// <param name="dependencies">The dependencies of the mod.</param>
+    /// <param name="client">Whether the mod is client-side only.</param>
     public record Manifest(string id, string? name, string? description, Version version, string[] authors, Dependency[]? dependencies, bool client = false);
+
+    /// <summary>
+    /// Represents a file included in a mod.
+    /// </summary>
+    /// <param name="name">The name of the file.</param>
+    /// <param name="bytes">The raw byte content of the file.</param>
     public record File(string name, byte[] bytes);
+
+    /// <summary>
+    /// Represents the loading status of a mod.
+    /// </summary>
     public enum Status
     {
+        /// <summary>The mod was loaded successfully.</summary>
         Success,
+        /// <summary>An error occurred while loading the mod.</summary>
         Error,
+        /// <summary>The mod's dependencies were not satisfied.</summary>
         DependenciesUnsatisfied,
     }
 
+    /// <summary>The unique identifier of the mod.</summary>
     public string id;
+    /// <summary>The display name of the mod.</summary>
     public string? name;
+    /// <summary>A description of the mod.</summary>
     public string? description;
+    /// <summary>The version of the mod.</summary>
     public Version version;
+    /// <summary>The authors of the mod.</summary>
     public string[] authors;
+    /// <summary>The dependencies of the mod.</summary>
     public Dependency[]? dependencies;
+    /// <summary>Whether the mod is client-side only.</summary>
     public bool client;
+    /// <summary>The loading status of the mod.</summary>
     public Status status;
+    /// <summary>The files included in the mod.</summary>
     public List<File> files;
 
+    /// <summary>
+    /// Initializes a new instance of the <see cref="Mod"/> class.
+    /// </summary>
+    /// <param name="manifest">The mod's manifest data.</param>
+    /// <param name="status">The initial loading status of the mod.</param>
+    /// <param name="files">The list of files included in the mod.</param>
     public Mod(Manifest manifest, Status status, List<File> files)
     {
         id = manifest.id;
@@ -34,4 +83,13 @@ public Mod(Manifest manifest, Status status, List<File> files)
         this.status = status;
         this.files = files;
     }
+
+    /// <summary>
+    /// Returns a string that represents the current mod.
+    /// </summary>
+    /// <returns>A string representation of the mod.</returns>
+    public override string ToString()
+    {
+        return $"mod: id={id} dependencies={dependencies} status={status}";
+    }
 }

src/Managers/Audio.cs src/Patches/Audio.cssrc/Managers/Audio.cs renamed to src/Patches/Audio.cs

@@ -5,7 +5,7 @@
 
 namespace PolyMod.Managers;
 
-public static class Audio
+internal static class Audio
 {
     [HarmonyPostfix]
     [HarmonyPatch(typeof(AudioManager), nameof(AudioManager.SetupData))]