diff --git a/README.md b/README.md index 2f38a67..4c8026f 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ 🔍 An in-game UI for exploring, debugging and modifying Unity games.
- ✅ Supports most Unity versions from 5.2 to >2020 (IL2CPP and Mono). + ✔️ Supports most Unity versions from 5.2 to 2020+ (IL2CPP and Mono).
☕ Enjoy this tool? Consider supporting me on ko-fi! @@ -65,14 +65,25 @@ The standalone release can be used with any injector or loader of your choice, b ### Object Explorer -* Use the Scene Explorer tab to traverse the active scenes, as well as the DontDestroyOnLoad scene and the HideAndDontSave "scene" (assets and hidden objects). +* Use the Scene Explorer tab to traverse the active scenes, as well as the DontDestroyOnLoad and HideAndDontSave objects. + * The "HideAndDontSave" scene contains objects with that flag, as well as Assets and Resources which are not in any scene but behave the same way. + * You can use the Scene Loader to easily load any of the scenes in the build (may not work for Unity 5.X games) * Use the Object Search tab to search for Unity objects (including GameObjects, Components, etc), C# Singletons or Static Classes. + * Use the UnityObject search to look for any objects which derive from `UnityEngine.Object`, with optional filters + * The singleton search will look for any classes with a typical "Instance" field, and check it for a current value. This may cause unexpected behaviour in some IL2CPP games as we cannot distinguish between true properties and field-properties, so some property accessors will be invoked. ### Inspector -* The inspector is used to see detailed information on GameObjects (GameObject Inspector), C# objects (Reflection Inspector) and C# classes (Static Inspector). - * In the GameObject Inspector, you can edit any of the input fields in the inspector (excluding readonly fields) and press Enter to apply your changes. You can also do this to the GameObject path as a way to change the GameObject's parent. Press the Escape key to cancel your edits. - * In the Reflection Inspectors, automatic updating is not enabled by default, and you must press Apply for any changes you make to take effect. +The inspector is used to see detailed information on objects of any type and manipulate their values, as well as to inspect C# Classes with static reflection. + +* The GameObject Inspector (tab prefix `[G]`) is used to inspect a `GameObject`, and to see and manipulate its Transform and Components. + * You can edit any of the input fields in the inspector (excluding readonly fields) and press Enter to apply your changes. You can also do this to the GameObject path as a way to change the GameObject's parent. Press the Escape key to cancel your edits. + * note: When inspecting a GameObject with a Canvas, the transform controls may be overridden by the RectTransform anchors. +* The Reflection Inspectors (tab prefix `[R]` and `[S]`) are used for everything else + * Automatic updating is not enabled by default, and you must press Apply for any changes you make to take effect. + * Press the `▼` button to expand certain values such as strings, enums, lists, dictionaries, some structs, etc + * Use the filters at the top to quickly find the members you are looking for + * For `Texture2D` objects, there is a `View Texture` button at the top of the inspector which lets you view it and save it as a PNG file. Currently there are no other similar helpers yet, but I may add more at some point for Mesh, Sprite, Material, etc ### C# Console @@ -87,8 +98,7 @@ The standalone release can be used with any injector or loader of your choice, b ### Settings -* You can change the settings via the "Options" page of the main menu, or directly from the config file. -* Depending on the release you are using, the config file will be found at: +* You can change the settings via the "Options" tab of the menu, or directly from the config file. * BepInEx: `BepInEx\config\com.sinai.unityexplorer.cfg` * MelonLoader: `UserData\MelonPreferences.cfg` * Standalone `{DLL_location}\UnityExplorer\config.ini`