Skip to content

Commit 19feaff

Browse files
PicoShotPicoShot
committed
Update README.md
1 parent 2260135 commit 19feaff

1 file changed

Lines changed: 60 additions & 77 deletions

File tree

‎README.md‎

Lines changed: 60 additions & 77 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
<h1 align="center">UnityInspectorStandalone</h1>
1+
# <h1 align="center">UnityInspectorStandalone</h1>
22

33
<div align="center">
44

5-
A powerful runtime inspector for Unity games with **Mono** and **IL2CPP** support.
5+
A powerful, universal runtime inspector and debugging tool for Unity games with support **Mono** and **IL2CPP** runtimes.
66

77
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
88
[![Unity](https://img.shields.io/badge/Unity-Mono%20%7C%20IL2CPP-green.svg)](https://unity.com/)
@@ -12,100 +12,83 @@ A powerful runtime inspector for Unity games with **Mono** and **IL2CPP** suppor
1212
</div>
1313

1414
<p align="center">
15-
<img src="Assets/screenshot.png" alt="Screenshot">
15+
<img src="Assets/screenshot.png" alt="UnityInspector Screenshot" width="80%">
1616
</p>
1717

18-
more screenshots at [Assets](Assets/)
18+
<p align="center">
19+
<em>Find more screenshots in the <a href="Assets/">Assets/</a> directory.</em>
20+
</p>
1921

2022
---
21-
## Overview
2223

23-
UnityInspector is a single-DLL runtime inspection tool that allows you to explore and modify Unity games in real-time. Whether you're a game developer debugging your project or a researcher analyzing game mechanics, UnityInspector provides comprehensive access to Unity's internal structures.
24+
## Overview
2425

25-
### Key Highlights
26+
**UnityInspector** is a single-DLL runtime inspection tool that intercepts the game presentation loop to draw a Dear ImGui interface. It allows you to explore, inspect, and modify internal game structures, components, properties, and execute methods in real-time.
2627

27-
- **Single DLL** - No external dependencies required
28-
- **Dual runtime support** - Works with both Mono and IL2CPP backends
29-
- **Live editing** - Modify object properties in real-time
28+
Whether you are debugging your own Unity builds, researching game mechanics, or writing plugins, UnityInspector gives you complete live runtime access.
3029

3130
---
3231

33-
## Features
32+
## Key Highlights
3433

35-
### Inspector
36-
37-
- **Scene Hierarchy Browser**
38-
- Complete tree view of all GameObjects in the active scene
39-
- Shows active/inactive state with visual indicators
40-
41-
- **Component Inspection**
42-
- View all components attached to any GameObject
43-
- Component filtering by name
44-
- Field and Property tabs for organized viewing
45-
46-
- **Field Editor**
47-
- Edit instance and static fields directly
48-
- Support for multiple types:
49-
- Numeric: `int`, `float`, `double`
50-
- Vectors: `Vector2`, `Vector3`, `Vector4`
51-
- Rotation: `Quaternion`
52-
- Color: `Color` with built-in picker
53-
- Boolean: `bool` with checkbox
54-
- String: Read-only display
55-
56-
- **Property Editor**
57-
- Read/Write property access
58-
- Inline editing with appropriate controls
59-
60-
- **Method Invoker**
61-
- Invoke methods at runtime with custom parameters
62-
- Parameter type validation
63-
- Return value display
64-
- Static and instance method support
65-
66-
- **Transform Editor**
67-
- World and Local coordinate views
68-
- Position, Rotation, Scale editing
34+
* **Single DLL Proxy** - Drop-in installation with zero external dependencies.
35+
* **Dual Engine Support** - Full compatibility with both **Mono** and **IL2CPP** runtimes.
36+
* **Live Modification** - Edit fields, read/write properties, and invoke functions on the fly.
6937

7038
---
7139

72-
## Installation
73-
74-
### Requirements
75-
76-
- Windows 10 or later
77-
- Unity game (Mono or IL2CPP) running on **DirectX 11**
78-
79-
> **Note:** Only DirectX 11 is supported. DX12 and Vulkan are **not** supported. Launch your game with `-force-d3d11` to ensure DX11 mode.
80-
81-
### Steps
40+
## Features
8241

83-
1. Download the latest `winhttp.dll` from [Releases](https://github.com/PicoShot/UnityInspectorStandalone/releases)
84-
2. copy `winhttp.dll` to game directory and run game
85-
3. Press `INSERT` to toggle the menu
42+
### Scene Hierarchy Browser
43+
* Comprehensive tree view of all active and inactive `GameObject`s in the active scenes.
44+
* Inactive game objects are clearly distinguished with visual indicators.
45+
* Fast search and filter controls to locate specific objects.
46+
47+
### Component Inspector
48+
* Lists all script components, colliders, renderers, and standard Unity modules attached to the selected `GameObject`.
49+
* Search filter to isolate specific component classes.
50+
* Structured tabs dividing properties, fields, and general parameters.
51+
52+
### Field Editor
53+
* Direct read and write access to both **Instance** and **Static** fields.
54+
* Input validation and native controls for common types:
55+
* **Numeric**: `int`, `float`, `double`
56+
* **Vectors**: `Vector2`, `Vector3`, `Vector4`
57+
* **Rotations**: `Quaternion`
58+
* **Colors**: `Color` with a built-in interactive color picker
59+
* **Booleans**: `bool` toggle checkboxes
60+
* **Strings**: View values inline
61+
62+
### Property Editor
63+
* View and edit active properties at runtime.
64+
* Safely invokes getters and setters through reflection or IL2CPP metadata APIs.
65+
66+
### Method Invoker
67+
* Invoke any class method (including private, static, and instance methods) dynamically.
68+
* Interactive parameter input boxes with type validation.
69+
* Displays returning objects or primitive values directly in the console/UI.
70+
71+
### Transform Editor
72+
* Dedicated window for manipulating positioning.
73+
* Switch between **Local** and **World** coordinate spaces.
74+
* Edit position vectors, rotation angles, and scaling factors instantly.
8675

8776
---
8877

89-
## Supported Unity Versions
90-
91-
| Version | Mono | IL2CPP |
92-
| ----------- | ---- | ------ |
93-
| 2015-2020.x | [?] | [?] |
94-
| 2021.x | [?] | [!] |
95-
| 2022.x | [!] | [+] |
96-
| 2023.x | [?] | [?] |
97-
| 6000.x | [+] | [+] |
78+
## Requirements & Installation
9879

99-
- [?] Not Tested
100-
- [-] Not Supported
101-
- [!] Have Bugs
102-
- [+] Supported
103-
104-
---
80+
### Requirements
81+
* **OS**: Windows 10 / 11 (x64)
82+
* **Graphics API**: **DirectX 11** or **DirectX 12**
83+
* **Unity Runtimes**: Mono / IL2CPP
10584

106-
## Credits
85+
> Vulkan is not officially supported at this time to avoid external Vulkan SDK requirements.
10786
108-
- [ImGui](https://github.com/ocornut/imgui) by ocornut
109-
- [Kiero](https://github.com/Rebzzel/kiero) for the DirectX hooking framework
87+
### Setup Instructions
88+
1. Download the latest precompiled `winhttp.dll` from the [Releases](https://github.com/Rebzzel/kiero) tab.
89+
2. Locate the root directory of your target Unity game (the folder containing the game executable).
90+
3. Copy `winhttp.dll` into the game directory.
91+
4. Launch the game.
92+
5. Press the <kbd>INSERT</kbd> key on your keyboard to toggle the UnityInspector interface.
11093

111-
---
94+
---

0 commit comments

Comments
 (0)