|
5 | 5 | <p align="center">
|
6 | 6 | 🔍 An in-game UI for exploring, debugging and modifying Unity games.
|
7 | 7 | </p>
|
8 |
| -<p align="center"> |
9 |
| - ✔️ Supports most Unity versions from 5.2 to 2021+ (IL2CPP and Mono). |
10 |
| -</p> |
11 |
| -<p align="center"> |
12 |
| - ✨ Powered by <a href="https://github.com/sinai-dev/UniverseLib">UniverseLib</a> |
13 |
| -</p> |
14 |
| - |
15 |
| -# Releases [](../../releases) |
16 |
| - |
17 |
| -[](../../releases/latest) [](https://github.com/sinai-dev/UnityExplorer/actions) [](../../releases/latest) |
18 |
| - |
19 |
| -⚡ Thunderstore releases: [BepInEx Mono](https://thunderstore.io/package/sinai-dev/UnityExplorer) | [BepInEx IL2CPP](https://gtfo.thunderstore.io/package/sinai-dev/UnityExplorer_IL2CPP) | [MelonLoader IL2CPP](https://boneworks.thunderstore.io/package/sinai-dev/UnityExplorer_IL2CPP_ML) |
20 |
| - |
21 |
| -## Release schedule |
22 |
| - |
23 |
| -Releases will be posted at most once per week, generally on weekends. |
24 |
| - |
25 |
| -Nightly builds can be found [here](https://github.com/sinai-dev/UnityExplorer/actions). |
26 |
| - |
27 |
| -## BepInEx |
28 |
| - |
29 |
| -| Release | IL2CPP | Mono | |
30 |
| -| ------- | ------ | ---- | |
31 |
| -| BIE 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) | |
32 |
| -| BIE 6.X (CoreCLR) | ✅ [link](https://github.com/sinai-dev/UnityExplorer/releases/latest/download/UnityExplorer.BepInEx.IL2CPP.CoreCLR.zip) | ✖ | |
33 |
| -| BIE 5.X | ✖️ n/a | ✅ [link](https://github.com/sinai-dev/UnityExplorer/releases/latest/download/UnityExplorer.BepInEx5.Mono.zip) | |
34 |
| - |
35 |
| -1. Unzip the release file into a folder |
36 |
| -2. Take the `plugins/sinai-dev-UnityExplorer` folder and place it in `BepInEx/plugins/` |
37 |
| - |
38 |
| -<i>Note: BepInEx 6 is obtainable via [builds.bepinex.dev](https://builds.bepinex.dev/projects/bepinex_be)</i> |
39 |
| - |
40 |
| -## MelonLoader |
41 | 8 |
|
42 |
| -| Release | IL2CPP | Mono | |
43 |
| -| ------- | ------ | ---- | |
44 |
| -| ML 0.5 | ✅ [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) | |
45 |
| -| ML 0.6 | ✅ [link](https://github.com/sinai-dev/UnityExplorer/releases/latest/download/UnityExplorer.MelonLoader.IL2CPP.net6preview.zip) | ✖️ | |
| 9 | +# UnityExplorerKSP |
46 | 10 |
|
47 |
| -1. Unzip the release file into a folder |
48 |
| -2. Copy the DLL inside the `Mods` folder into your MelonLoader `Mods` folder |
49 |
| -3. Copy all of the DLLs inside the `UserLibs` folder into your MelonLoader `UserLibs` folder |
50 |
| - |
51 |
| -## Standalone |
52 |
| - |
53 |
| -| IL2CPP | Mono | |
54 |
| -| ------ | ---- | |
55 |
| -| ✅ [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) | |
56 |
| - |
57 |
| -The standalone release can be used with any injector or loader of your choice, but it requires you to load the dependencies manually. |
58 |
| - |
59 |
| -1. Ensure the required libs are loaded - UniverseLib, HarmonyX and MonoMod. Take them from the [`UnityExplorer.Editor`](https://github.com/sinai-dev/UnityExplorer/releases/latest/download/UnityExplorer.Editor.zip) release if you need them. |
60 |
| -2. For IL2CPP, load Il2CppAssemblyUnhollower and start an [Il2CppAssemblyUnhollower runtime](https://github.com/knah/Il2CppAssemblyUnhollower#required-external-setup) |
61 |
| -2. Load the UnityExplorer DLL |
62 |
| -3. Create an instance of Unity Explorer with `UnityExplorer.ExplorerStandalone.CreateInstance();` |
63 |
| -4. Optionally subscribe to the `ExplorerStandalone.OnLog` event to handle logging if you wish |
64 |
| - |
65 |
| -## Unity Editor |
66 |
| - |
67 |
| -1. Download the [`UnityExplorer.Editor`](https://github.com/sinai-dev/UnityExplorer/releases/latest/download/UnityExplorer.Editor.zip) release. |
68 |
| -2. Install the package, either by using the Package Manager and importing the `package.json` file, or by manually dragging the folder into your `Assets` folder. |
69 |
| -3. Drag the `Runtime/UnityExplorer` prefab into your scene, or create a GameObject and add the `Explorer Editor Behaviour` script to it. |
70 |
| - |
71 |
| -# Common issues and solutions |
72 |
| - |
73 |
| -Although UnityExplorer should work out of the box for most Unity games, in some cases you may need to tweak the settings for it to work properly. |
74 |
| - |
75 |
| -To adjust the settings, open the config file: |
76 |
| -* BepInEx: `BepInEx\config\com.sinai.unityexplorer.cfg` |
77 |
| -* MelonLoader: `UserData\MelonPreferences.cfg` |
78 |
| -* Standalone: `sinai-dev-UnityExplorer\config.cfg` |
79 |
| - |
80 |
| -Try adjusting the following settings and see if it fixes your issues: |
81 |
| -* `Startup_Delay_Time` - increase to 5-10 seconds (or more as needed), can fix issues with UnityExplorer being destroyed or corrupted during startup. |
82 |
| -* `Disable_EventSystem_Override` - if input is not working properly, try setting this to `true`. |
83 |
| - |
84 |
| -If these fixes do not work, please create an issue in this repo and I'll do my best to look into it. |
| 11 | +This is a fork of [UnityExplorer](https://github.com/sinai-dev/UnityExplorer), modified to work as a standalone Kerbal Space Program plugin : |
| 12 | +- Uses Harmony instead of HarmonyX |
| 13 | +- Uses a forked version of UniverseLib wich also uses Harmony instead of HarmonyX |
| 14 | +- All dependencies, and notably `Mono.Cecil` are packed in the assembly to avoid conflicts with the outdated `Mono.Cecil` bundled with KSP. |
| 15 | +- Removed unused code (IL2CPP support, bepinex/melon loaders...) |
85 | 16 |
|
86 | 17 | # Features
|
87 | 18 |
|
@@ -164,15 +95,6 @@ The inspector is used to see detailed information on objects of any type and man
|
164 | 95 | ### Settings
|
165 | 96 |
|
166 | 97 | * You can change the settings via the "Options" tab of the menu, or directly from the config file.
|
167 |
| - * BepInEx: `BepInEx\config\com.sinai.unityexplorer.cfg` |
168 |
| - * MelonLoader: `UserData\MelonPreferences.cfg` |
169 |
| - * Standalone `{DLL_location}\sinai-dev-UnityExplorer\config.cfg` |
170 |
| - |
171 |
| -# Building |
172 |
| - |
173 |
| -1. Run the `build.ps1` powershell script to build UnityExplorer. Releases are found in the `Release` folder. |
174 |
| - |
175 |
| -Building individual configurations from your IDE is fine, though note that the intial build process builds into `Release/<version>/...` instead of the subfolders that the powershell script uses. Batch building is not currently supported with the project. |
176 | 98 |
|
177 | 99 | # Acknowledgments
|
178 | 100 |
|
|
0 commit comments