sinai-dev · sinai-dev · May 17, 2021 · Apr 15, 2021 · Apr 15, 2021 · Apr 15, 2021
diff --git a/.gitignore b/.gitignore
@@ -9,7 +9,6 @@
 *.user
 *.userosscache
 *.sln.docstates
-*/mcs-unity*
 
 # User-specific files (MonoDevelop/Xamarin Studio)
 *.userprefs

diff --git a/.gitmodules b/.gitmodules
@@ -0,0 +1,9 @@
+[submodule "lib/Il2CppAssemblyUnhollower"]
+	path = lib/Il2CppAssemblyUnhollower
+	url = https://github.com/knah/Il2CppAssemblyUnhollower
+[submodule "lib/HarmonyX"]
+	path = lib/HarmonyX
+	url = https://github.com/BepInEx/HarmonyX
+[submodule "lib/mcs-unity"]
+	path = lib/mcs-unity
+	url = https://github.com/sinai-dev/mcs-unity
diff --git a/README.md b/README.md
@@ -16,61 +16,39 @@
 | ----------- | ------ | ---- |
 | [BepInEx](https://github.com/BepInEx/BepInEx) 6.X | ✅ [link](https://github.com/sinai-dev/UnityExplorer/releases/latest/download/UnityExplorer.BepInEx.Il2Cpp.zip) | ✅ [link](https://github.com/sinai-dev/UnityExplorer/releases/latest/download/UnityExplorer.BepInEx6.Mono.zip) |
 | [BepInEx](https://github.com/BepInEx/BepInEx) 5.X | ✖️ n/a | ✅ [link](https://github.com/sinai-dev/UnityExplorer/releases/latest/download/UnityExplorer.BepInEx5.Mono.zip) |
-| [MelonLoader](https://github.com/HerpDerpinstine/MelonLoader) 0.3 | ✅ [link](https://github.com/sinai-dev/UnityExplorer/releases/latest/download/UnityExplorer.MelonLoader.Il2Cpp.zip) | ✅ [link](https://github.com/sinai-dev/UnityExplorer/releases/latest/download/UnityExplorer.MelonLoader.Mono.zip) | 
+| [MelonLoader](https://github.com/HerpDerpinstine/MelonLoader) 0.3.1 | ✅ [link](https://github.com/sinai-dev/UnityExplorer/releases/latest/download/UnityExplorer.MelonLoader.Il2Cpp.zip) | ✅ [link](https://github.com/sinai-dev/UnityExplorer/releases/latest/download/UnityExplorer.MelonLoader.Mono.zip) | 
 | Standalone | ✅ [link](https://github.com/sinai-dev/UnityExplorer/releases/latest/download/UnityExplorer.Standalone.Il2Cpp.zip) | ✅ [link](https://github.com/sinai-dev/UnityExplorer/releases/latest/download/UnityExplorer.Standalone.Mono.zip) | 
 
+### Known issues
+* UI layouts broken/unusable after changing resolutions: delete the file `data.ini` in the UnityExplorer folder (same place as where you put the DLL). Better fix being worked on.
+* Any `MissingMethodException` or `NotSupportedException`: please report the issue and provide a copy of your mod loader log and/or Unity log.
+* The C# console may unexpectedly produce a GC Mark Overflow crash when calling certain outside methods. Not clear yet what is causing this, but it's being looked into.
+* In IL2CPP, some IEnumerable and IDictionary types may fail enumeration. Waiting for the Unhollower rewrite to address this any further.
+* In IL2CPP, the C# console might not suggest deobfuscated (or obfuscated) names. Being looked into.
+
 ## How to install
 
 ### BepInEx
 
-1. Install [BepInEx](https://github.com/BepInEx/BepInEx) for your game. For IL2CPP you should use [BepInEx 6 (Bleeding Edge)](https://builds.bepis.io/projects/bepinex_be), for Mono you should use [BepInEx 5](https://github.com/BepInEx/BepInEx/releases) (until Mono support stabilizes in BepInEx 6).
+1. Install [BepInEx](https://github.com/BepInEx/BepInEx) for your game. IL2CPP currently requires a [Bleeding Edge](https://builds.bepis.io/projects/bepinex_be) release.
 2. Download the UnityExplorer release for BepInEx IL2CPP or Mono above.
 3. Take the `UnityExplorer.BIE.___.dll` file and put it in `[GameFolder]\BepInEx\plugins\`
 4. In IL2CPP, you will need to download the [Unity libs](https://github.com/LavaGang/Unity-Runtime-Libraries) for the game's Unity version and put them in the `BepInEx\unity-libs\` folder. 
 
 ### MelonLoader
 
-1. Install [MelonLoader](https://github.com/HerpDerpinstine/MelonLoader) 0.3+ for your game. Version 0.3 is currently in pre-release, so you must "Enable ALPHA Releases" in your MelonLoader Installer settings to see the option for it.
+1. Install [MelonLoader](https://github.com/HerpDerpinstine/MelonLoader) 0.3.1+ for your game. This version can currently be obtained from [here](https://github.com/LavaGang/MelonLoader/actions).
 2. Download the UnityExplorer release for MelonLoader IL2CPP or Mono above.
 3. Take the `UnityExplorer.ML.___.dll` file and put it in the `[GameFolder]\Mods\` folder.
 
 ### Standalone
 
-The standalone release requires you to also load `0Harmony.dll` (HarmonyX, from the `lib\` folder) to function properly, and the IL2CPP also requires `UnhollowerBaseLib.dll` as well. The Mono release should be fairly easy to use with any loader, but the IL2CPP one may be tricky, I'd recommend just using BepInEx or MelonLoader for IL2CPP.
-
-1. Load the UnityExplorer DLL from your mod or inject it, as well as `0Harmony.dll` and `UnhollowerBaseLib.dll` as required.
-2. Create an instance of Unity Explorer with `UnityExplorer.ExplorerStandalone.CreateInstance();`
-3. Optionally subscribe to the `ExplorerStandalone.OnLog` event to handle logging if you wish.
-
-## Issues and contributions
-
-Both issue reports and PR contributions are welcome in this repository.
-
-### Issue reporting
-
-To report an issue with UnityExplorer, please use the following template (as well as any other information / images you can provide).
-
-Template:
-
-```
-* Game issue occurs on: 
-* UnityExplorer version: (eg BIE.IL2CPP v3.3.3, etc)
-
-* Description of issue:
-
-* Unity log link:
-* Mod Loader log link: 
-```
-
-Please upload your Unity log file to [Pastebin](https://pastebin.com/) (or equivalent service) and provide a link to the paste.
-
-* The log should be found at `%userprofile%\AppData\LocalLow\[Company]\[Game]\` unless redirected by your Mod Loader.
-* The file will be called either `output_log.txt` or `Player.log`
-
-As well as the Unity log, please upload your Mod Loader's log:
+The standalone release can be used with any injector or loader of your choice, but it requires you to load the dependencies manually: HarmonyX, and the IL2CPP version also requires that you set up an [Il2CppAssemblyUnhollower runtime](https://github.com/knah/Il2CppAssemblyUnhollower#required-external-setup).
 
-* BepInEx: `BepInEx\LogOutput.log`
-* MelonLoader: `MelonLoader\Latest.log`
+1. Load the required libs - HarmonyX, and Il2CppAssemblyUnhollower if IL2CPP
+2. Load the UnityExplorer DLL
+3. Create an instance of Unity Explorer with `UnityExplorer.ExplorerStandalone.CreateInstance();`
+4. Optionally subscribe to the `ExplorerStandalone.OnLog` event to handle logging if you wish
 
 ## Features
 
@@ -80,44 +58,31 @@ As well as the Unity log, please upload your Mod Loader's log:
   </a>
 </p>
 
-* <b>Scene Explorer</b>: Simple menu to traverse the Transform heirarchy of the scene. 
-* <b>GameObject Inspector</b>: Various helpful tools to see and manipulate the GameObject, similar to what you can do in the Editor.
-* <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. There's also a UI mode to inspect UI objects.
+### Object Explorer
 
-### C# Console Tips
+* Use the <b>Scene Explorer</b> tab to traverse the active scenes, as well as the DontDestroyOnLoad scene and the HideAndDontSave "scene" (assets and hidden objects).
+* Use the <b>Object Search</b> tab to search for Unity objects (including GameObjects, Components, etc), C# Singletons or Static Classes.
 
-The C# Console can be used to define temporary classes and methods, or it can be used to evaluate an expression, but you cannot do both at the same time.
+### Inspector
 
-For example, you could run this code to define a temporary class (it will be visible within the console until you run `Reset();`).
+The inspector is used to see detailed information on GameObjects (GameObject Inspector), C# objects (Reflection Inspector) and C# classes (Static Inspector).
 
-```csharp
-public class MyClass
-{
-    public static void Method()
-    {
-        UnityExplorer.ExplorerCore.Log("hello");
-    }
-}
-```
+For the GameObject Inspector, you can edit any of the input fields in the inspector (excluding readonly fields) and press <b>Enter</b> to apply your changes. You can also do this to the GameObject path as a way to change the GameObject's parent. Press the <b>Escape</b> key to cancel your edits.
 
-You could then delete or comment out the class and run the following expression to run that method:
+In the Reflection Inspectors, automatic updating is not enabled by default, and you must press Apply for any changes you make to take effect. 
 
-```csharp
-MyClass.Method();
-```
+### C# Console
 
-However, you cannot define a class and run it both at the same time. You must either define class(es) and run that, or define an expression and run that.
+The C# Console uses the `Mono.CSharp.Evaluator` to define temporary classes or run immediate REPL code.
 
-You can also make use of the helper methods in the console to simplify some tasks, which you can see listed when the console has nothing entered for input. These methods are **not** accessible within any temporary classes you define, they can only be used in the expression context.
+See the "Help" dropdown in the C# console menu for more detailed information.
 
-### Logging
+### Mouse-Inspect
 
-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.
+The "Mouse Inspect" dropdown on the main UnityExplorer navbar allows you to inspect objects under the mouse.
 
-These logs are also visible in the Debug Console part of the UI.
+* <b>World</b>: uses Physics.Raycast to look for Colliders
+* <b>UI</b>: uses GraphicRaycasters to find UI objects
 
 ### Settings
 
@@ -139,10 +104,9 @@ Building the project should be straight-forward, the references are all inside t
 
 ## Acknowledgments
 
-* [ManlyMarco](https://github.com/ManlyMarco) for [Runtime Unity Editor](https://github.com/ManlyMarco/RuntimeUnityEditor) \[[license](THIRDPARTY_LICENSES.md#runtimeunityeditor-license)\], snippets from the REPL Console were used for UnityExplorer's C# Console.
+* [ManlyMarco](https://github.com/ManlyMarco) for [Runtime Unity Editor](https://github.com/ManlyMarco/RuntimeUnityEditor) \[[license](THIRDPARTY_LICENSES.md#runtimeunityeditor-license)\], the ScriptEvaluator from RUE's REPL console was used as the base for UnityExplorer's C# console.
 * [denikson](https://github.com/denikson) (aka Horse) for [mcs-unity](https://github.com/denikson/mcs-unity) \[no license\], used as the `Mono.CSharp` reference for the C# Console.
 * [HerpDerpenstine](https://github.com/HerpDerpinstine) for [MelonCoroutines](https://github.com/LavaGang/MelonLoader/blob/6cc958ec23b5e2e8453a73bc2e0d5aa353d4f0d1/MelonLoader.Support.Il2Cpp/MelonCoroutines.cs) \[[license](THIRDPARTY_LICENSES.md#melonloader-license)\], they were included for standalone IL2CPP coroutine support.
-* [InGameCodeEditor](https://assetstore.unity.com/packages/tools/gui/ingame-code-editor-144254) \[[license](THIRDPARTY_LICENSES.md#ingamecodeeditor-license)\] was used as the base for the syntax highlighting for UnityExplorer's C# console (`UnityExplorer.UI.Main.CSConsole.Lexer`).
 
 ### Disclaimer