Skip to content
This repository was archived by the owner on May 9, 2023. It is now read-only.

Commit d7008db

Browse files
authored
Update README.md
1 parent 8c1913f commit d7008db

File tree

1 file changed

+43
-46
lines changed

1 file changed

+43
-46
lines changed

README.md

Lines changed: 43 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -6,46 +6,42 @@
66
🔍 An in-game UI for exploring, debugging and modifying Unity games.
77
</p>
88
<p align="center">
9-
✔️ Supports most Unity games from versions 5.2 to 2020+ (IL2CPP and Mono).
9+
✔️ Supports most Unity versions from 5.2 to >2020 (IL2CPP and Mono).
1010
</p>
1111
<p align="center">
1212
💜 Enjoy this tool? Consider supporting me on <a href="https://ko-fi.com/sinaidev">ko-fi</a>!
1313
</p>
1414

15-
## Releases [![](https://img.shields.io/github/downloads/sinai-dev/UnityExplorer/total.svg)](../../releases)
15+
# Releases [![](https://img.shields.io/github/downloads/sinai-dev/UnityExplorer/total.svg)](../../releases)
1616

17-
[![](https://img.shields.io/github/release/sinai-dev/UnityExplorer.svg?label=version)](../../releases/latest) [![](https://img.shields.io/github/downloads/sinai-dev/UnityExplorer/latest/total.svg)](../../releases/latest)
18-
| Mod Loader | IL2CPP | Mono |
19-
| ----------- | ------ | ---- |
20-
| [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) |
21-
| [BepInEx](https://github.com/BepInEx/BepInEx) 5.X | ✖️ n/a |[link](https://github.com/sinai-dev/UnityExplorer/releases/latest/download/UnityExplorer.BepInEx5.Mono.zip) |
22-
| [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) |
23-
| [MelonLoader](https://github.com/HerpDerpinstine/MelonLoader) 0.3.0 |[link](https://github.com/sinai-dev/UnityExplorer/releases/latest/download/UnityExplorer.MelonLoader_Legacy.Il2Cpp.zip) |[link](https://github.com/sinai-dev/UnityExplorer/releases/latest/download/UnityExplorer.MelonLoader_Legacy.Mono.zip) |
24-
| 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) |
17+
[![](https://img.shields.io/github/release/sinai-dev/UnityExplorer.svg?label=version)](../../releases/latest) [![](https://img.shields.io/github/workflow/status/sinai-dev/UnityExplorer/Build%20UnityExplorer)](https://github.com/sinai-dev/UnityExplorer/actions) [![](https://img.shields.io/github/downloads/sinai-dev/UnityExplorer/latest/total.svg)](../../releases/latest)
2518

26-
* [Click here for Bleeding Edge releases](https://github.com/sinai-dev/UnityExplorer/actions) (click on the latest workflow and scroll down to Artifacts)
19+
## BepInEx
2720

28-
### Known issues
29-
* Any `MissingMethodException` or `NotSupportedException`: please report the issue and provide a copy of your mod loader log and/or Unity log.
30-
* In IL2CPP, some IEnumerable and IDictionary types may fail enumeration. Waiting for the Unhollower rewrite to address this any further.
31-
* The C# Console's completions have some minor issues such as not suggestion global classes which have no namespace, and erronously suggesting classes from using directives when they shouldn't be suggested. These are issues with mcs itself which I am looking into.
21+
| Release | IL2CPP | Mono |
22+
| ------- | ------ | ---- |
23+
| 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) |
24+
| BIE 5.X | ✖️ n/a |[link](https://github.com/sinai-dev/UnityExplorer/releases/latest/download/UnityExplorer.BepInEx5.Mono.zip) |
3225

33-
## How to install
26+
1. Take the `UnityExplorer.BIE.[version].dll` file and put it in `BepInEx\plugins\`
27+
2. In IL2CPP, you will need to download the [Unity libs](https://github.com/LavaGang/Unity-Runtime-Libraries) for the game's Unity version, create a folder `BepInEx\unity-libs\`, then extract the Unity libs into this folder.
3428

35-
### BepInEx
29+
<i>Note: BepInEx 6 is obtainable via [BepisBuilds](https://builds.bepis.io/projects/bepinex_be)</i>
3630

37-
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.
38-
2. Download the UnityExplorer release for BepInEx IL2CPP or Mono above.
39-
3. Take the `UnityExplorer.BIE.___.dll` file and put it in `[GameFolder]\BepInEx\plugins\`
40-
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.
31+
## MelonLoader
4132

42-
### MelonLoader
33+
| Release | IL2CPP | Mono |
34+
| ------- | ------ | ---- |
35+
| ML 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) |
36+
| ML 0.3.0 |[link](https://github.com/sinai-dev/UnityExplorer/releases/latest/download/UnityExplorer.MelonLoader_Legacy.Il2Cpp.zip) |[link](https://github.com/sinai-dev/UnityExplorer/releases/latest/download/UnityExplorer.MelonLoader_Legacy.Mono.zip) |
4337

44-
1. Install [MelonLoader](https://github.com/HerpDerpinstine/MelonLoader) 0.3.1+ for your game (or use `MelonLoader_Legacy` for `0.3.0`). This version can currently be obtained from [here](https://github.com/LavaGang/MelonLoader/actions).
45-
2. Download the UnityExplorer release for MelonLoader IL2CPP or Mono above.
46-
3. Take the `UnityExplorer.ML.___.dll` file and put it in the `[GameFolder]\Mods\` folder.
38+
1. Take the `UnityExplorer.ML.[version].dll` file and put it in the `Mods\` folder created by MelonLoader.
4739

48-
### Standalone
40+
## Standalone
41+
42+
| IL2CPP | Mono |
43+
| ------ | ---- |
44+
|[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) |
4945

5046
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).
5147

@@ -54,7 +50,12 @@ The standalone release can be used with any injector or loader of your choice, b
5450
3. Create an instance of Unity Explorer with `UnityExplorer.ExplorerStandalone.CreateInstance();`
5551
4. Optionally subscribe to the `ExplorerStandalone.OnLog` event to handle logging if you wish
5652

57-
## Features
53+
# Known issues
54+
* Any `MissingMethodException` or `NotSupportedException`: please report the issue and provide a copy of your mod loader log and/or Unity log.
55+
* In IL2CPP, some IEnumerable and IDictionary types may fail enumeration. Waiting for the Unhollower rewrite to address this any further.
56+
* The C# Console's completions have some minor issues such as not suggestion global classes which have no namespace, and erronously suggesting classes from using directives when they shouldn't be suggested. These are issues with mcs itself which I am looking into.
57+
58+
# Features
5859

5960
<p align="center">
6061
<a href="https://raw.githubusercontent.com/sinai-dev/UnityExplorer/master/img/preview.png">
@@ -69,34 +70,30 @@ The standalone release can be used with any injector or loader of your choice, b
6970

7071
### Inspector
7172

72-
The inspector is used to see detailed information on GameObjects (GameObject Inspector), C# objects (Reflection Inspector) and C# classes (Static Inspector).
73-
74-
* In 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.
75-
* In the Reflection Inspectors, automatic updating is not enabled by default, and you must press Apply for any changes you make to take effect.
73+
* The inspector is used to see detailed information on GameObjects (GameObject Inspector), C# objects (Reflection Inspector) and C# classes (Static Inspector).
74+
* In 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.
75+
* In the Reflection Inspectors, automatic updating is not enabled by default, and you must press Apply for any changes you make to take effect.
7676

7777
### C# Console
7878

79-
The C# Console uses the `Mono.CSharp.Evaluator` to define temporary classes or run immediate REPL code.
80-
81-
See the "Help" dropdown in the C# console menu for more detailed information.
79+
* The C# Console uses the `Mono.CSharp.Evaluator` to define temporary classes or run immediate REPL code.
80+
* See the "Help" dropdown in the C# console menu for more detailed information.
8281

8382
### Mouse-Inspect
8483

85-
The "Mouse Inspect" dropdown on the main UnityExplorer navbar allows you to inspect objects under the mouse.
86-
87-
* <b>World</b>: uses Physics.Raycast to look for Colliders
88-
* <b>UI</b>: uses GraphicRaycasters to find UI objects
84+
* The "Mouse Inspect" dropdown on the main UnityExplorer navbar allows you to inspect objects under the mouse.
85+
* <b>World</b>: uses Physics.Raycast to look for Colliders
86+
* <b>UI</b>: uses GraphicRaycasters to find UI objects
8987

9088
### Settings
9189

92-
You can change the settings via the "Options" page of the main menu, or directly from the config file.
93-
94-
Depending on the release you are using, the config file will be found at:
95-
* BepInEx: `BepInEx\config\com.sinai.unityexplorer.cfg`
96-
* MelonLoader: `UserData\MelonPreferences.cfg`
97-
* Standalone `{DLL_location}\UnityExplorer\config.ini`
90+
* You can change the settings via the "Options" page of the main menu, or directly from the config file.
91+
* Depending on the release you are using, the config file will be found at:
92+
* BepInEx: `BepInEx\config\com.sinai.unityexplorer.cfg`
93+
* MelonLoader: `UserData\MelonPreferences.cfg`
94+
* Standalone `{DLL_location}\UnityExplorer\config.ini`
9895

99-
## Building
96+
# Building
10097

10198
If you fork the repository on GitHub you can build using the [dotnet workflow](https://github.com/sinai-dev/UnityExplorer/blob/master/.github/workflows/dotnet.yml):
10299

@@ -111,7 +108,7 @@ For Visual Studio:
111108
2. Build `mcs`, and if using IL2CPP then build `UnhollowerBaseLib` as well.
112109
3. Build the UnityExplorer release(s) you want to use, either by selecting the config as the Active Config, or batch-building.
113110

114-
## Acknowledgments
111+
# Acknowledgments
115112

116113
* [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.
117114
* [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.

0 commit comments

Comments
 (0)