Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nakdeyes/UnrealImGuiTools
A set of tools and utilities for use with Unreal Engine projects using ImGui.
https://github.com/nakdeyes/UnrealImGuiTools
Last synced: 13 days ago
JSON representation
A set of tools and utilities for use with Unreal Engine projects using ImGui.
- Host: GitHub
- URL: https://github.com/nakdeyes/UnrealImGuiTools
- Owner: nakdeyes
- License: mit
- Created: 2022-05-24T04:14:06.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-11T06:53:50.000Z (3 months ago)
- Last Synced: 2024-04-11T07:51:46.125Z (3 months ago)
- Language: C++
- Size: 200 KB
- Stars: 122
- Watchers: 4
- Forks: 15
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-game-security - A set of tools and utilities for use with Unreal Engine projects using ImGui
README
# UnrealImGuiTools
A set of tools and utilities for use with Unreal Engine projects using ImGui.
# Description
This plugin includes tools for use with Unreal Engine projects. It also provides a small framework to make writing your own game specific tool windows a bit more quickly and easily.
The plugin itself does not contain ImGui, but has [segross' UnrealImGui plugin](https://github.com/segross/UnrealImGui) as a dependant plugin. This plugin, segross' plugin, and [Omar Cornut's fantastic Dear ImGui](https://github.com/ocornut/imgui) are all released under MIT license.
### Compatibility
Most of these tools were written with UE 4.27, then it was later updated to UE 5.0 (it was a very minimal change). So currently only UE 5.0 is currently supported, but I plan to formalize 4.27 support with a flag or something in the future. For now, if you drop this in 4.27 it will still mostly work with perhaps 1 or 2 tweaks.
# Controlling ImGui Tools and ImGui
### Editor Button
To increase discoverability and ease of use, there is an editor button menu that provides options for interacting with both ImGui Tools plugin and the ImGui plugin itself. Find it in the main editor toolbar:
Here you will find:
* Top level ImGui Tools enable switch
* Buttons to enable / disable individual tools
* Buttons to enable different Input features of the ImGui plugin
### CVars
When outside the editor (like in Standalone builds) the main way to interact with the plugin is via CVars. Here is a list of useful ones:
```imgui.tools.enabled true```
| CVAR | Example | Description |
|------------------------------------------------------|-------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ```imgui.tools.enabled ``` | ```imgui.tools.enabled true imgui.tools.enabled false``` | Top-level switch that will enable / disable all ImGui Tools. |
| ```imgui.tools.toggle_tool_vis ``` | ```imgui.tools.toggle_tool_vis MemoryDebugger imgui.tools.toggle_tool_vis LoadDebugger``` | Toggle visibility of a particular imgui tool. This list auto-completes with all registered tools, so it is a good way to explore all registered tools. If the top level switch is disabled when this CVAR is executed, the top level switch will be toggled on as well. |
| ```imgui.tools.file_load.toggle_record``` | ```imgui.tools.file_load.toggle_record``` | For the Load Debugger - toggle recording of UE file loads. |
### Creating game level ImGui Tool windows
Create your own ImGui tool windows in your game module!
There is example game module code in the ```ExampleGameCode``` directory that will show you how to register tools with the plugin.
***Question:*** Why the heck should I pipe my game ImGui tools through the plugin?
***Answer:*** Really, it just gives you a nice ImGui drawing entry point, an editor button, in-game menu button, and a CVAR via ```imgui.tools.toggle_tool_vis``` to toggle the visibility of your tool. Boiler plate that you might find yourself doing often when writing bespoke ImGui tool windows.
# Included Tools
## Memory Debugger
The Memory Debugger was built to show detailed memory information at runtime. While Memory Insights is largely useful for debugging individual allocations and some high level data, and the STAT commands can show you some useful buckets at a glance, this memory debugger is meant to fit somewhere in the middle. It is meant to compliment the existing memory debugging tools. There are a few parts to the Memory Debugger
#### Platform Memory Stats
These are real-time top level memory stats.
#### Texture Memory
These are real-time stats for the textures currently loaded into the texture streaming system. This is useful to sanity check texture sizes at a glance, see which textures are marked for streaming or not, see usage counts and more!
#### Object Memory
This one is super cool! This will show you the memory size of all loaded UObjects in a cool heirarchical view. However, it is not real-time but instead 'snapshot' based. When you are ready to inspect your memory press the "Update (SLOW!)' button and give it ~10 seconds while the memory data is gathered. Then you can search through it by name, sort it by size / instances, and more! You can 'Inspect' any UClass to show a dedicated window for instances of that class (with an option to update those in real time).
***NOTE: UObjects must implement UObject::GetResourceSizeEx() for the tool to correctly gather resource sizes. This is implemented for 99% of Epic UObjects (but watch out for the occasional exception!), but may require closer inspection for some third party libs/plugins (this had to be implemented manually for WWISE UObjects for instance)***
## Load Debugger
Synchronous loading hitches got you down? We have you covered! The LoadDebugger is a very small and simple tools that can track all sync and async class loads that happen during gameplay. Simply enable recording, spew the loads to the log output if desired, and clear the load list when needed. This is a great tool for hunting down unintentional / unknown sync file loads to eliminate those last hitches before ship by enabling recording and playing through the game a few times.
## Actor Component Debugger (ALPHA)
***NOTE: This tool is very much in progress and maybe only 50% complete. But perhaps is already a tiny bit useful***
This is a tool meant to help explore, analyze, and debug AActors and UActorComponents ( and more! ). It provides an in-game actor and component explorer and shows you useful information like counts of actors and components that replicate or tick, all represented in a heirarchical class view. You can tear off a window for any given actor or component to inspect it more closely.
***Coming soon: advanced text search and sorting options a'la the memory debugger, and a mechanism to provide custom debug per actor or component class***
