[Major] expand readme, add sprites origin export and improve the gameobject comparer

Author: remyCases

DiffUtils.cs

@@ -56,7 +56,7 @@ public bool Equals(UndertaleGameObject? x, UndertaleGameObject? y)
             x.Persistent == y.Persistent &&
             x.Awake == y.Awake &&
             x.CollisionShape == y.CollisionShape && 
-            x.Events.Count == y.Events.Count;
+            x.Events.Enumerate().SelectMany(x => x.Item2.Select(y => (((EventType)x.Item1).ToString(), (int)y.EventSubtype))).ToList().Count == y.Events.Enumerate().SelectMany(x => x.Item2.Select(y => (((EventType)x.Item1).ToString(), (int)y.EventSubtype))).ToList().Count;
     }
 
     // If Equals() returns true for a pair of objects
@@ -73,7 +73,7 @@ public int GetHashCode(UndertaleGameObject x)
             x.Persistent.GetHashCode() ^
             x.Awake.GetHashCode() ^
             x.CollisionShape.GetHashCode() ^
-            x.Events.Count.GetHashCode();
+            x.Events.Enumerate().SelectMany(x => x.Item2.Select(y => (((EventType)x.Item1).ToString(), (int)y.EventSubtype))).ToList().Count.GetHashCode();
     }
 }
 class UndertaleGameObjectNameComparer : IEqualityComparer<UndertaleGameObject>
@@ -348,6 +348,7 @@ private static void AddedRemovedSprites(UndertaleData name, UndertaleData refere
 
         IEnumerable<UndertaleSprite> added = name.Sprites.Except(reference.Sprites, new UndertaleSpriteNameComparer());
         IEnumerable<UndertaleSprite> removed = reference.Sprites.Except(name.Sprites, new UndertaleSpriteNameComparer());
+        using StreamWriter swOrigin = new(Path.Join(outputFolder.FullName, Path.DirectorySeparatorChar.ToString(), $"addedSpritesOrigin.txt"));
         using (StreamWriter sw = new(Path.Join(outputFolder.FullName, Path.DirectorySeparatorChar.ToString(), $"addedSprites.txt")))
         {
             foreach(UndertaleSprite sprite in added)
@@ -360,6 +361,7 @@ private static void AddedRemovedSprites(UndertaleData name, UndertaleData refere
                         worker.ExportAsPNG(sprite.Textures[i].Texture, Path.Combine(dirAddedSprite.FullName , sprite.Name.Content + "_" + i + ".png"), null, true);
                     }
                 }
+                swOrigin.WriteLine($"Msl.GetSprite(\"{sprite.Name.Content}\").OriginX = {sprite.OriginX};\nMsl.GetSprite(\"{sprite.Name.Content}\").OriginY = {sprite.OriginY};");
             }
         }
         File.WriteAllLines(Path.Join(outputFolder.FullName, Path.DirectorySeparatorChar.ToString(), $"removedSprites.txt"), removed.Select(x => x.Name.Content));

ModShardDiff.csproj

@@ -15,7 +15,7 @@
     <Authors>zizani</Authors>
     <PackageTags>msl;cli</PackageTags>
     <PackageProjectUrl>https://github.com/ModShardTeam/ModShardDiff</PackageProjectUrl>
-    <Description>A cli tool to export all differences between two .win files.</Description>
+    <Description>A cli tool to export differences between two .win files.</Description>
   </PropertyGroup>
 
   <PropertyGroup>

README.md

@@ -1,3 +1,33 @@
 # ModShardDiff
 
-A cli tool to export all differences between two .win files.
+A cli tool to export differences between two .win files. 
+
+## What will I get from this tool ?
+
+MSD will export in seperate files the following:
+- list of added and removed `Codes` in txt
+- list of added and removed `GameObjects` in txt
+- list of added and removed `Rooms` in txt
+- list of added and removed `Sounds` in txt
+- list of added and removed `Sprites` in txt
+- list of added and removed `TexturePageItems` in txt
+- added `Codes` in gml
+- added `GameObjects` in json
+- added `Sprites` in png
+- modified diff `Codes` in html
+- modified diff `GameObjects` in html
+- modified `Sprites` in png
+- list of modified `Sprites origin` in txt
+
+The diff for `Codes` and `GameObjects` is made using the `diff-match-patch` lib, and the html export relies on this same [api](https://github.com/google/diff-match-patch/wiki/API#diff_prettyhtmldiffs--html).
+
+## How can I install it?
+
+1. Install the latest [.NET Core SDK](https://dot.net).
+2. Run `dotnet tool install --global ModShardDiff`.
+
+## How can I use it?
+
+#### Using the CLI:
+
+To compare `data_modified.win` from `data_vanilla.win` and export the results in the folder `PATH/TO/EXPORT`, run `msd -n data_modified.win -r data_vanilla.win -o PATH/TO/EXPORT`.