sinai-dev-UnityExplorer icon

UnityExplorer

An in-game UI for exploring, debugging and modifying Unity games.

Last updated 7 hours ago
Total downloads 684
Total rating 6 
Categories Tools
Dependency string sinai-dev-UnityExplorer-4.1.7
Dependants 0 other mods depend on this mod

README

UnityExplorer

🔍 An in-game UI for exploring, debugging and modifying Unity games.
✔️ Supports most Unity versions from 5.2 to 2021+ (IL2CPP and Mono).
☕ Enjoy this tool? Consider supporting me on ko-fi!

GitHub

Manual install

For a manual install:

  1. Take the UnityExplorer.BIE.[version].dll file and put it in BepInEx\plugins\
  2. In IL2CPP, you will need to download the Unity libs for the game's Unity version, create a folder BepInEx\unity-libs\, then extract the Unity libs into this folder.

Features

Object Explorer

  • 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 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

  • The C# Console uses the Mono.CSharp.Evaluator to define temporary classes or run immediate REPL code.
  • You can execute a script automatically on startup by naming it startup.cs and placing it in the UnityExplorer\Scripts\ folder (this folder will be created where you placed the DLL file).
  • See the "Help" dropdown in the C# console menu for more detailed information.

Mouse-Inspect

  • The "Mouse Inspect" dropdown on the main UnityExplorer navbar allows you to inspect objects under the mouse.
  • World: uses Physics.Raycast to look for Colliders
  • UI: uses GraphicRaycasters to find UI objects

Settings

  • You can change the settings via the "Options" tab of the menu, or directly from the config file.

Building

If you fork the repository on GitHub you can build using the dotnet workflow:

  1. Click on the Actions tab and enable workflows in your repository
  2. Click on the "Build UnityExplorer" workflow, then click "Run Workflow" and run it manually, or make a new commit to trigger the workflow.
  3. Take the artifact from the completed run.

For Visual Studio:

  1. Clone the repository and run git submodule update --init --recursive to get the submodules.
  2. Open the src\UnityExplorer.sln project.
  3. Build mcs, and if using IL2CPP then build UnhollowerBaseLib as well.
  4. Build the UnityExplorer release(s) you want to use, either by selecting the config as the Active Config, or batch-building.

Acknowledgments

Available versions

Please note that the install buttons only work if you have compatible client software installed, such as the Thunderstore Mod Manager. Otherwise use the zip download links instead.

Upload date Version number Downloads Download link  
2021-6-22 4.1.7 56 Version 4.1.7 Install
2021-6-20 4.1.6 201 Version 4.1.6 Install
2021-6-14 4.1.5 158 Version 4.1.5 Install
2021-6-7 4.1.4 240 Version 4.1.4 Install
2021-6-7 4.1.3 29 Version 4.1.3 Install