cleanups

Author: sinai-dev

README.md

@@ -44,7 +44,7 @@
 * <b>Reflection Inspector</b>: Inspect Properties and Fields. Can also set primitive values and evaluate primitive methods.
 * <b>Search</b>: Search for UnityEngine.Objects with various filters, or use the helpers for static Instances and Classes.
 * <b>C# Console</b>: Interactive console for evaluating C# methods on the fly, with some basic helpers.
-* <b>Inspect-under-mouse</b>: Hover over an object with a collider and inspect it by clicking on it.
+* <b>Inspect-under-mouse</b>: Hover over an object with a collider and inspect it by clicking on it. There's also a UI mode to inspect UI objects.
 
 ## How to install
 
@@ -68,9 +68,15 @@ Note: You must use version 0.3 of MelonLoader or greater. Version 0.3 is current
 ### Standalone
 
 0. Load the DLL from your mod or inject it. You must also make sure that the required libraries (Harmony, Unhollower for Il2Cpp, etc) are loaded.
-1. Create an instance of Unity Explorer with `new ExplorerCore();`
-2. You will need to call `ExplorerCore.Update()` (static method) from your Update method.
-3. Subscribe to the `ExplorerCore.OnLog__` methods for logging.
+1. Create an instance of Unity Explorer with `ExplorerStandalone.CreateInstance();`
+2. You will need to call `ExplorerStandalone.Update()` from your Update method.
+3. Subscribe to the `ExplorerStandalone.OnLog` event to handle logging if you wish.
+
+## Logging
+
+Explorer saves all logs to disk (only keeps the most recent 10 logs). They can be found in a "UnityExplorer" folder in the same place as where you put the DLL file.
+
+These logs are also visible in the Debug Console part of the UI.
 
 ## Settings
 

src/Config/ModConfig.cs renamed to src/Config/ExplorerConfig.cs

@@ -6,14 +6,14 @@
 
 namespace UnityExplorer.Config
 {
-    public class ModConfig
+    public class ExplorerConfig
     {
-        public static ModConfig Instance;
+        public static ExplorerConfig Instance;
 
         internal static readonly IniDataParser _parser = new IniDataParser();
-        internal static readonly string INI_PATH = Path.Combine(ExplorerCore.EXPLORER_FOLDER, "config.ini");
+        internal static readonly string INI_PATH = Path.Combine(ExplorerCore.Loader.ConfigFolder, "config.ini");
 
-        static ModConfig()
+        static ExplorerConfig()
         {
             _parser.Configuration.CommentString = "#";
         }
@@ -22,7 +22,7 @@ static ModConfig()
         public KeyCode  Main_Menu_Toggle    = KeyCode.F7;
         public bool     Force_Unlock_Mouse  = true;
         public int      Default_Page_Limit  = 25;
-        public string   Default_Output_Path = ExplorerCore.EXPLORER_FOLDER + @"\Output";
+        public string   Default_Output_Path = ExplorerCore.ExplorerFolder + @"\Output";
         public bool     Log_Unity_Debug     = false;
         public bool     Hide_On_Startup     = false;
         //public bool     Save_Logs_To_Disk   = true;
@@ -36,7 +36,7 @@ internal static void InvokeConfigChanged()
 
         public static void OnLoad()
         {
-            Instance = new ModConfig();
+            Instance = new ExplorerConfig();
 
             if (LoadSettings())
                 return;
@@ -99,6 +99,9 @@ public static void SaveSettings()
             sec.AddKey(nameof(Hide_On_Startup),     Instance.Hide_On_Startup.ToString());
             //sec.AddKey("Save_Logs_To_Disk",     Instance.Save_Logs_To_Disk.ToString());
 
+            if (!Directory.Exists(ExplorerCore.Loader.ConfigFolder))
+                Directory.CreateDirectory(ExplorerCore.Loader.ConfigFolder);
+
             File.WriteAllText(INI_PATH, data.ToString());
         }
     }

src/ExplorerBepIn5Plugin.cs

@@ -19,39 +19,19 @@ public class ExplorerCore
         public const string AUTHOR = "Sinai";
         public const string GUID = "com.sinai.unityexplorer";
 
+        public static ExplorerCore Instance { get; private set; }
+
+        private static IExplorerLoader s_loader;
+        public static IExplorerLoader Loader => s_loader
 #if ML
-        public static string EXPLORER_FOLDER = Path.Combine("Mods", NAME);
+                                             ?? (s_loader = ExplorerMelonMod.Instance);   
 #elif BIE
-        public static string EXPLORER_FOLDER = Path.Combine(BepInEx.Paths.ConfigPath, NAME);
+                                             ?? (s_loader = ExplorerBepInPlugin.Instance);
 #elif STANDALONE
-        public static string EXPLORER_FOLDER
-        {
-            get
-            {
-                if (s_explorerFolder == null)
-                {
-                    s_explorerFolder = (new Uri(Assembly.GetExecutingAssembly().CodeBase)).AbsolutePath;
-                    s_explorerFolder = Uri.UnescapeDataString(s_explorerFolder);
-                    s_explorerFolder = Path.GetDirectoryName(s_explorerFolder);                    
-                }
-                
-                return s_explorerFolder;
-            }
-        }
-        private static string s_explorerFolder;
+                                             ?? (s_loader = ExplorerStandalone.Instance);
 #endif
 
-        public static ExplorerCore Instance { get; private set; }
-
-        public static bool ShowMenu
-        {
-            get => s_showMenu;
-            set => SetShowMenu(value);
-        }
-        public static bool s_showMenu;
-
-        private static bool s_doneUIInit;
-        private static float s_timeSinceStartup;
+        public static string ExplorerFolder => Loader.ExplorerFolder;
 
         public ExplorerCore()
         {
@@ -67,60 +47,29 @@ public ExplorerCore()
             ReflectionHelpers.TryLoadGameModules();
 #endif
 
-            if (!Directory.Exists(EXPLORER_FOLDER))
-                Directory.CreateDirectory(EXPLORER_FOLDER);
+            if (!Directory.Exists(ExplorerFolder))
+                Directory.CreateDirectory(ExplorerFolder);
 
-            ModConfig.OnLoad();
+            ExplorerConfig.OnLoad();
 
             InputManager.Init();
             ForceUnlockCursor.Init();
 
             SetupEvents();
 
-            ShowMenu = true;
+            UIManager.ShowMenu = true;
 
             Log($"{NAME} {VERSION} initialized.");
         }
 
         public static void Update()
         {
-            if (!s_doneUIInit)
-                CheckUIInit();
+            UIManager.CheckUIInit();
 
             if (MouseInspector.Enabled)
                 MouseInspector.UpdateInspect();
             else
-            {
-                if (InputManager.GetKeyDown(ModConfig.Instance.Main_Menu_Toggle))
-                    ShowMenu = !ShowMenu;
-
-                if (ShowMenu && s_doneUIInit)
-                    UIManager.Update();
-            }
-        }
-
-        private static void CheckUIInit()
-        {
-            s_timeSinceStartup += Time.deltaTime;
-
-            if (s_timeSinceStartup > 0.1f)
-            {
-                s_doneUIInit = true;
-                try
-                {
-                    UIManager.Init();
-                    Log("Initialized UnityExplorer UI.");
-
-                    if (ModConfig.Instance.Hide_On_Startup)
-                        ShowMenu = false;
-
-                    // InspectorManager.Instance.Inspect(Tests.TestClass.Instance);
-                }
-                catch (Exception e)
-                {
-                    LogWarning($"Exception setting up UI: {e}");
-                }
-            }
+                UIManager.Update();
         }
 
         private void SetupEvents()
@@ -129,10 +78,14 @@ private void SetupEvents()
             try
             {
                 Application.add_logMessageReceived(new Action<string, string, LogType>(OnUnityLog));
+
                 SceneManager.add_sceneLoaded(new Action<Scene, LoadSceneMode>((Scene a, LoadSceneMode b) => { OnSceneLoaded(); }));
                 SceneManager.add_activeSceneChanged(new Action<Scene, Scene>((Scene a, Scene b) => { OnSceneLoaded(); }));
             }
-            catch { }
+            catch (Exception ex)
+            {
+                LogWarning($"Exception setting up Unity event listeners!\r\n{ex}");
+            }
 #else
             Application.logMessageReceived += OnUnityLog;
             SceneManager.sceneLoaded += (Scene a, LoadSceneMode b) => { OnSceneLoaded(); }; 
@@ -145,23 +98,6 @@ internal void OnSceneLoaded()
             UIManager.OnSceneChange();
         }
 
-        private static void SetShowMenu(bool show)
-        {
-            s_showMenu = show;
-
-            if (UIManager.CanvasRoot)
-            {
-                UIManager.CanvasRoot.SetActive(show);
-
-                if (show)
-                    ForceUnlockCursor.SetEventSystem();
-                else
-                    ForceUnlockCursor.ReleaseEventSystem();
-            }
-
-            ForceUnlockCursor.UpdateCursorControl();
-        }
-
         private void OnUnityLog(string message, string stackTrace, LogType type)
         {
             if (!DebugConsole.LogUnity)
@@ -185,26 +121,14 @@ private void OnUnityLog(string message, string stackTrace, LogType type)
             }
         }
 
-#if STANDALONE
-        public static Action<string> OnLogMessage;
-        public static Action<string> OnLogWarning;
-        public static Action<string> OnLogError;
-#endif
-
         public static void Log(object message, bool unity = false)
         {
             DebugConsole.Log(message?.ToString());
 
             if (unity)
                 return;
 
-#if ML
-            MelonLoader.MelonLogger.Msg(message?.ToString());
-#elif BIE
-            ExplorerBepInPlugin.Logging?.LogMessage(message?.ToString());
-#elif STANDALONE
-            OnLogMessage?.Invoke(message?.ToString());
-#endif
+            Loader.OnLogMessage(message);
         }
 
         public static void LogWarning(object message, bool unity = false)
@@ -214,13 +138,7 @@ public static void LogWarning(object message, bool unity = false)
             if (unity)
                 return;
 
-#if ML
-            MelonLoader.MelonLogger.Msg(message?.ToString());
-#elif BIE
-            ExplorerBepInPlugin.Logging?.LogWarning(message?.ToString());
-#elif STANDALONE
-            OnLogWarning?.Invoke(message?.ToString());
-#endif
+            Loader.OnLogWarning(message);
         }
 
         public static void LogError(object message, bool unity = false)
@@ -230,24 +148,7 @@ public static void LogError(object message, bool unity = false)
             if (unity)
                 return;
 
-#if ML
-            MelonLoader.MelonLogger.Msg(message?.ToString());
-#elif BIE
-            ExplorerBepInPlugin.Logging?.LogError(message?.ToString());
-#elif STANDALONE
-            OnLogError?.Invoke(message?.ToString());
-#endif
-        }
-
-
-        public static string RemoveInvalidFilenameChars(string s)
-        {
-            var invalid = System.IO.Path.GetInvalidFileNameChars();
-            foreach (var c in invalid)
-            {
-                s = s.Replace(c.ToString(), "");
-            }
-            return s;
+            Loader.OnLogError(message);
         }
     }
 }

src/ExplorerCore.cs

@@ -251,7 +251,7 @@ internal void ConstructTextureViewerArea(GameObject parent)
             if (string.IsNullOrEmpty(name))
                 name = "untitled";
 
-            var savePath = $@"{Config.ModConfig.Instance.Default_Output_Path}\{name}.png";
+            var savePath = $@"{Config.ExplorerConfig.Instance.Default_Output_Path}\{name}.png";
             inputField.text = savePath;
 
             saveBtn.onClick.AddListener(() => 

src/ExplorerMelonMod.cs

@@ -59,7 +59,7 @@ internal readonly List<KeyValuePair<CachePaired, CachePaired>> m_entries
             = new List<KeyValuePair<CachePaired, CachePaired>>();
 
         internal readonly KeyValuePair<CachePaired, CachePaired>[] m_displayedEntries
-            = new KeyValuePair<CachePaired, CachePaired>[ModConfig.Instance.Default_Page_Limit];
+            = new KeyValuePair<CachePaired, CachePaired>[ExplorerConfig.Instance.Default_Page_Limit];
 
         internal bool m_recacheWanted = true;