Added GIF support, fixed minor inconsistencies

Author: SB15-MD

Data/CustomImage.cs

@@ -1,9 +1,4 @@
-using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Text;
-using System.Threading.Tasks;
-using CustomLoadingScreens.Managers;
+using CustomLoadingScreens.Managers;
 using SixLabors.ImageSharp;
 using SixLabors.ImageSharp.PixelFormats;
 using SixLabors.ImageSharp.Processing;
@@ -17,10 +12,13 @@ internal class CustomImage
         private readonly Configuration _config = Configuration.Default;
 
         internal readonly string Name;
-        internal readonly Sprite Sprite;
+        internal readonly List<Sprite> Sprites;
+        internal readonly int FramesPerSecond;
+        internal readonly int FrameCount;
 
         internal CustomImage(string path)
         {
+            Sprites = new List<Sprite>();
             var logger = new Logger(nameof(CustomImage));
             _config.PreferContiguousImageBuffers = true;
 
@@ -29,25 +27,31 @@ internal CustomImage(string path)
             // Unity loads textures upside-down so flip it
             var image = Image.Load<Rgba32>(path);
             image.Mutate(c => c.Flip(FlipMode.Vertical));
-            
-            var texture = new Texture2D(image.Width, image.Height, TextureFormat.RGBA32, false);
 
-            var getPixelDataResult = image.DangerousTryGetSinglePixelMemory(out var memory);
-            if (!getPixelDataResult)
+            FramesPerSecond = image.Frames.RootFrame.Metadata.GetGifMetadata().FrameDelay * 10;
+            FrameCount = image.Frames.Count;
+
+            foreach (var frame in image.Frames)
             {
-                logger.Error("Failed to get pixel data.");
-                return;
-            }
+                var texture = new Texture2D(frame.Width, frame.Height, TextureFormat.RGBA32, false);
 
-            using var handle = memory.Pin();
+                var getPixelDataResult = frame.DangerousTryGetSinglePixelMemory(out var memory);
+                if (!getPixelDataResult)
+                {
+                    logger.Error("Failed to get pixel data.");
+                    return;
+                }
 
-            // Ugly unsafe block to save a hard copy of memory for performance
-            unsafe { texture.LoadRawTextureData((IntPtr)handle.Pointer, memory.Length * sizeof(IntPtr)); }
-            
-            texture.Apply(false);
+                using var handle = memory.Pin();
 
-            Sprite = Sprite.Create(texture, new Rect(0, 0, texture.width, texture.height), new Vector2(0.5f, 0.5f));
-            Sprite.hideFlags |= HideFlags.DontUnloadUnusedAsset;
+                // Ugly unsafe block to save a hard copy of memory for performance
+                unsafe { texture.LoadRawTextureData((IntPtr)handle.Pointer, memory.Length * sizeof(IntPtr)); }
+
+                texture.Apply(false);
+
+                Sprites.Add( Sprite.Create(texture, new Rect(0, 0, texture.width, texture.height), new Vector2(0.5f, 0.5f)));
+                Sprites.Last().hideFlags |= HideFlags.DontUnloadUnusedAsset;
+            }
 
             logger.Msg("Created sprite.");
         }

Main.cs

@@ -1,12 +1,18 @@
-using CustomLoadingScreens.Managers;
-using CustomLoadingScreens.Utilities;
+using CustomLoadingScreens.Data;
+using CustomLoadingScreens.Managers;
+using CustomLoadingScreens.Patches;
+using Il2CppInterop.Runtime.InteropTypes.Arrays;
 using MelonLoader;
+using UnityEngine.UI;
+using Logger = CustomLoadingScreens.Utilities.Logger;
 
 namespace CustomLoadingScreens
 {
     public class Main : MelonMod
     {
         private static readonly Logger Logger = new("CustomLoadingScreens");
+        internal static Il2CppArrayBase<Image> Images;
+        internal static CustomImage CurrentCustomImage;
         public override void OnInitializeMelon()
         {
             ModSettings.Register();
@@ -21,5 +27,15 @@ public override void OnInitializeMelon()
                        $"{(CustomDataManager.CustomImages.Count != 1 ? "s" : "")} and {CustomDataManager.GetNumberOfQuotes()} custom loading quote" +
                        $"{(CustomDataManager.GetNumberOfQuotes() != 1 ? "s" : "")}.", false);
         }
+
+        /// <summary>
+        ///     Adds support for GIF images.
+        /// </summary>
+        public override void OnUpdate()
+        {
+            base.OnUpdate();
+            LoadingImagePatch.LoadingImgPatch.Update();
+        }
     }
+
 }

Managers/CustomDataManager.cs

@@ -1,6 +1,5 @@
 using CustomLoadingScreens.Data;
 using CustomLoadingScreens.Utilities;
-using Il2Cpp;
 
 namespace CustomLoadingScreens.Managers
 {
@@ -9,6 +8,7 @@ internal class CustomDataManager
         private const string JpgSearchPattern = "*.jpg";
         private const string PngSearchPattern = "*.png";
         private const string TxtSearchPattern = "*.txt";
+        private const string GifSearchPattern = "*.gif";
 
         internal static readonly List<CustomImage> CustomImages = new();
         internal static readonly List<string> CustomQuotes = new();
@@ -41,7 +41,8 @@ private static void AddImage(string path)
         internal static void LoadImages()
         {
             var imageFiles = Directory.EnumerateFiles(ModSettings.CustomImageFolder, JpgSearchPattern)
-                .Concat(Directory.EnumerateFiles(ModSettings.CustomImageFolder, PngSearchPattern));
+                .Concat(Directory.EnumerateFiles(ModSettings.CustomImageFolder, PngSearchPattern))
+                .Concat(Directory.EnumerateFiles(ModSettings.CustomImageFolder, GifSearchPattern));
             foreach (var image in imageFiles)
             {
                 AddImage(image);

Patches/LoadingImagePatch.cs

@@ -1,8 +1,6 @@
 using CustomLoadingScreens.Managers;
 using HarmonyLib;
 using Il2Cpp;
-using Il2CppAssets.Scripts.PeroTools.Commons;
-using Il2CppInterop.Runtime.InteropTypes.Arrays;
 using UnityEngine;
 using UnityEngine.UI;
 using Logger = CustomLoadingScreens.Utilities.Logger;
@@ -11,45 +9,44 @@ namespace CustomLoadingScreens.Patches
 {
     internal class LoadingImagePatch
     {
-
         /// <summary>
         ///     This HarmonyPatch class does all the work for setting the custom backgrounds and text.
         /// </summary>
         [HarmonyPatch(typeof(LoadingImg), nameof(LoadingImg.OnEnable))]
         internal class LoadingImgPatch
         {
             private static readonly Logger Logger = new(nameof(LoadingImgPatch));
-            private static bool Is43AspectRatio(double width, double height) => width % height / height <= 1.7; 
+            private static bool Is43AspectRatio(double width, double height) => width % height / height <= 1.7;
             private static void Postfix(ref LoadingImg __instance)
             {
 
                 // Rolled a custom image and we have a custom image
                 if (ProbabilityManager.UseCustomImage && CustomDataManager.CustomImages.Any())
                 {
                     var customImage = ProbabilityManager.GetRandomImage();
-                    Il2CppArrayBase<Image> components;
+                    Main.CurrentCustomImage = customImage;
 
                     __instance.simpleIllus.SetActive(false);
                     __instance.specialIllus.SetActive(false);
                     __instance.verySpecialIllus.SetActive(false);
                     __instance.specialIllusfor43.SetActive(false);
 
                     // Deal with the specialIllus variables, respective of aspect ratio
-                    if (Is43AspectRatio(customImage.Sprite.texture.width, customImage.Sprite.texture.height))
+                    if (Is43AspectRatio(customImage.Sprites[0].texture.width, customImage.Sprites[0].texture.height))
                     {
                         __instance.specialIllusfor43.SetActive(true);
-                        components = __instance.specialIllusfor43.GetComponents<Image>();
+                        Main.Images = __instance.specialIllusfor43.GetComponents<Image>();
                     }
                     else
                     {
                         __instance.specialIllus.SetActive(true);
-                        components = __instance.simpleIllus.GetComponents<Image>();
+                        Main.Images = __instance.simpleIllus.GetComponents<Image>();
                     }
 
                     // Sets all image components in the Illus to the custom image
-                    foreach (var image in components)
+                    foreach (var image in Main.Images)
                     {
-                        image.sprite = customImage.Sprite;
+                        image.sprite = customImage.Sprites[0];
                     }
 
                     // We can only use bound quotes if that image exists, bound quotes will always be displayed
@@ -85,6 +82,24 @@ private static void Postfix(ref LoadingImg __instance)
 
                 Logger.Msg("Custom random loading text has been loaded.");
             }
+
+            /// <summary>
+            ///     Adds support for GIF images.
+            /// </summary>
+            internal static void Update()
+            {
+                if (Main.CurrentCustomImage is null || Main.Images == null || Main.CurrentCustomImage.FramesPerSecond == 0) return;
+                
+                var frame = (int)Mathf.Floor(Time.time * 1000) %
+                    (Main.CurrentCustomImage.FramesPerSecond * Main.CurrentCustomImage.FrameCount) / Main.CurrentCustomImage.FramesPerSecond;
+
+                // Updates animated loading screens
+                foreach (var compImage in Main.Images)
+                {
+                    if (compImage == null) return;
+                    compImage.sprite = Main.CurrentCustomImage.Sprites[frame];
+                }
+            }
         }
     }
 }

Properties/AssemblyInfo.cs

@@ -1,7 +1,5 @@
 using System.Reflection;
-using System.Runtime.CompilerServices;
 using System.Runtime.InteropServices;
-using CustomLoadingScreens;
 using MelonLoader;
 
 // General Information about an assembly is controlled through the following
@@ -16,7 +14,7 @@
 [assembly: AssemblyTrademark("")]
 [assembly: AssemblyCulture("")]
 
-[assembly: MelonInfo(typeof(CustomLoadingScreens.Main), "CustomLoadingScreens", "1.0.0", "Mr. Talk")]
+[assembly: MelonInfo(typeof(CustomLoadingScreens.Main), "CustomLoadingScreens", "1.1.0", "Mr. Talk")]
 [assembly: MelonGame("PeroPeroGames", "MuseDash")]
 
 // Setting ComVisible to false makes the types in this assembly not visible
@@ -37,5 +35,5 @@
 // You can specify all the values or you can default the Build and Revision Numbers
 // by using the '*' as shown below:
 // [assembly: AssemblyVersion("1.0.*")]
-[assembly: AssemblyVersion("1.0.0.0")]
-[assembly: AssemblyFileVersion("1.0.0.0")]
+[assembly: AssemblyVersion("1.1.0.0")]
+[assembly: AssemblyFileVersion("1.1.0.0")]

Utilities/Logger.cs

@@ -22,7 +22,7 @@ public void Warning(object message)
             _logger.Msg(ConsoleColor.Yellow, "Warning: " + message);
         }
 
-        public void Error(string message)
+        public void Error(object message)
         {
             _logger.Msg(ConsoleColor.Red, "ERROR: " + message);
         }