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

Commit 8f07255

Browse files
committed
Update README.md
1 parent 46f3512 commit 8f07255

File tree

1 file changed

+25
-36
lines changed

1 file changed

+25
-36
lines changed

README.md

Lines changed: 25 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,6 @@
1313
<img src="https://img.shields.io/github/downloads/sinai-dev/Explorer/total.svg" />
1414
</p>
1515

16-
- [Releases](#releases)
17-
- [Features](#features)
18-
- [How to install](#how-to-install)
19-
- [Mod Config](#mod-config)
20-
- [Building](#building)
21-
- [Acknowledgments](#acknowledgments)
22-
2316
## Releases
2417

2518
| Mod Loader | IL2CPP | Mono |
@@ -31,6 +24,29 @@
3124

3225
\* BepInEx 6.X Mono release may not work on all games yet.
3326

27+
## How to install
28+
29+
### BepInEx
30+
31+
0. 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).
32+
1. Download the UnityExplorer release for BepInEx IL2CPP or Mono above.
33+
2. Take the `UnityExplorer.BIE.___.dll` file and put it in `[GameFolder]\BepInEx\plugins\`
34+
3. 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.
35+
36+
### MelonLoader
37+
38+
0. 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.
39+
1. Download the UnityExplorer release for MelonLoader IL2CPP or Mono above.
40+
2. Take the `UnityExplorer.ML.___.dll` file and put it in the `[GameFolder]\Mods\` folder.
41+
42+
### Standalone
43+
44+
The standalone release is based on the BepInEx build, so it requires Harmony 2.0 (or HarmonyX) to function properly.
45+
46+
0. Load the DLL from your mod or inject it. You must also make sure `0Harmony.dll` is loaded, and `UnhollowerBaseLib.dll` for IL2CPP as well.
47+
1. Create an instance of Unity Explorer with `UnityExplorer.ExplorerStandalone.CreateInstance();`
48+
2. Optionally subscribe to the `ExplorerStandalone.OnLog` event to handle logging if you wish.
49+
3450
## Features
3551

3652
<p align="center">
@@ -72,40 +88,13 @@ However, you cannot define a class and run it both at the same time. You must ei
7288

7389
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.
7490

75-
## How to install
76-
77-
### BepInEx
78-
79-
Note: 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).
80-
81-
0. Install [BepInEx](https://github.com/BepInEx/BepInEx) for your game.
82-
1. Download the UnityExplorer release for BepInEx IL2CPP or Mono above.
83-
2. Take the `UnityExplorer.BIE.___.dll` file and put it in `[GameFolder]\BepInEx\plugins\`
84-
3. In IL2CPP, it is highly recommended to get the base Unity libs for the game's Unity version and put them in the `BepInEx\unity-libs\` folder.
85-
86-
### MelonLoader
87-
88-
Note: You must use version 0.3 of MelonLoader or greater. Version 0.3 is currently in pre-release, so you must opt-in from your MelonLoader installer (enable alpha releases).
89-
90-
0. Install [MelonLoader](https://github.com/HerpDerpinstine/MelonLoader) for your game.
91-
1. Download the UnityExplorer release for MelonLoader IL2CPP or Mono above.
92-
2. Take the contents of the release and put it in the `[GameFolder]\Mods\` folder. It should look like `[GameFolder]\Mods\UnityExplorer.ML.___.dll`
93-
94-
### Standalone
95-
96-
The standalone release is based on the BepInEx build, so it requires Harmony 2.0 (or HarmonyX) to function properly.
97-
98-
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.
99-
1. Create an instance of Unity Explorer with `ExplorerStandalone.CreateInstance();`
100-
2. Optionally subscribe to the `ExplorerStandalone.OnLog` event to handle logging if you wish.
101-
102-
## Logging
91+
### Logging
10392

10493
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.
10594

10695
These logs are also visible in the Debug Console part of the UI.
10796

108-
## Settings
97+
### Settings
10998

11099
You can change the settings via the "Options" page of the main menu, or directly from the config file (generated after first launch). The config file will be found either inside a "UnityExplorer" folder in the same directory as where you put the DLL file, or for BepInEx it will be at `BepInEx\config\UnityExplorer\`.
111100

0 commit comments

Comments
 (0)