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

Commit 1ab41f5

Browse files
committed
Update README.md
1 parent 7dc58ea commit 1ab41f5

File tree

1 file changed

+46
-11
lines changed

1 file changed

+46
-11
lines changed

README.md

Lines changed: 46 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -38,28 +38,63 @@ Requires [MelonLoader](https://github.com/HerpDerpinstine/MelonLoader) to be ins
3838
## How to use
3939

4040
* Press F7 to show or hide the menu.
41-
* Simply browse through the scene, search for objects, etc, it's pretty self-explanatory.
41+
* Simply browse through the scene, search for objects, etc, most of it is pretty self-explanatory.
4242

43-
### Mouse Control
43+
### Scene Explorer
4444

45-
CppExplorer can force the mouse to be visible and unlocked when the menu is open, if you have enabled "Force Unlock Mouse" (Left-Alt toggle). However, you may also want to prevent the mouse clicking-through onto the game behind CppExplorer, this is possible but it requires specific patches for that game.
45+
* A simple menu which allows you to traverse the Transform heirarchy of the scene.
46+
* Click on a GameObject to set it as the current path, or <b>Inspect</b> it to send it to the Inspector window.
47+
48+
[![](https://i.imgur.com/2b0q0jL.png)](https://i.imgur.com/2b0q0jL.png)
49+
50+
### Inspectors
51+
52+
CppExplorer has two main inspector modes: GameObject Inspector, and Reflection Inspector.
53+
54+
<b>Tip:</b> when in Tab View, GameObjects are denoted by a [G] prefix, and Reflection objects are denoted by a [R] symbol.
55+
56+
### GameObject Inspector
57+
58+
* Allows you to see the children and components on a GameObject.
59+
* Can use some basic GameObject Controls such as translating and rotating the object, destroy it, clone it, etc.
60+
61+
[![](https://i.imgur.com/JTxqlx4.png)](https://i.imgur.com/JTxqlx4.png)
4662

47-
* For VRChat, use [VRCExplorerMouseControl](https://github.com/sinaioutlander/VRCExplorerMouseControl)
48-
* You can create your own mini-plugin using one of the two plugins above as an example. Usually only 1 or 2 simple Harmony patches are needed to fix the problem (if you want to submit that here, feel free to make a PR to this Readme).
63+
### Reflection Inspector
4964

50-
## Images
65+
* The Reflection Inspector is used for all other supported objects.
66+
* Allows you to inspect Properties, Fields and basic Methods, as well as set primitive values and evaluate primitive methods.
67+
* Can search and filter members for the ones you are interested in.
5168

52-
<b>Scene Explorer, GameObject Inspector, and Reflection Inspectors:</b>
69+
[![](https://i.imgur.com/eFVTQdh.png)](https://i.imgur.com/eFVTQdh.png)
5370

54-
[![](https://i.imgur.com/n8bkxVW.png)](https://i.imgur.com/n8bkxVW.png)
71+
### Object Search
5572

56-
<b>Object Search:</b>
73+
* You can search for an `UnityEngine.Object` with the Object Search feature.
74+
* Filter by name, type, etc.
75+
* For GameObjects and Transforms you can filter which scene they are found in too.
5776

5877
[![](https://i.imgur.com/lK2RthM.png)](https://i.imgur.com/lK2RthM.png)
5978

60-
<b>C# REPL console:</b>
79+
### C# REPL console
80+
81+
* A simple C# REPL console, allows you to execute a method body on the fly.
82+
83+
[![](https://i.imgur.com/5U4D1a8.png)](https://i.imgur.com/5U4D1a8.png)
84+
85+
### Inspect-under-mouse
86+
87+
* Press Shift+RMB (Right Mouse Button) while the CppExplorer menu is open to begin Inspect-Under-Mouse.
88+
* Hover over your desired object, if you see the name appear then you can click on it to inspect it.
89+
* Only objects with Colliders are supported.
90+
91+
### Mouse Control
92+
93+
CppExplorer can force the mouse to be visible and unlocked when the menu is open, if you have enabled "Force Unlock Mouse" (Left-Alt toggle). However, you may also want to prevent the mouse clicking-through onto the game behind CppExplorer, this is possible but it requires specific patches for that game.
6194

62-
[![](https://i.imgur.com/gYTor7C.png)](https://i.imgur.com/gYTor7C.png)
95+
* For VRChat, use [VRCExplorerMouseControl](https://github.com/sinai-dev/VRCExplorerMouseControl)
96+
* For Hellpoint, use [HPExplorerMouseControl](https://github.com/sinai-dev/Hellpoint-Mods/tree/master/HPExplorerMouseControl/HPExplorerMouseControl)
97+
* You can create your own plugin using one of the two plugins above as an example. Usually only a few simple Harmony patches are needed to fix the problem.
6398

6499
## Credits
65100

0 commit comments

Comments
 (0)