poret/UnrealImGui
1
0
Fork 0
mirror of https://github.com/kevinporetti/UnrealImGui.git synced 2025-01-18 08:20:32 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
Unreal plug-in that integrates Dear ImGui framework into Unreal Engine 5.
16 Commits 1 Branch 12 Tags 3.8 MiB
C++ 98.1%
C 1%
C# 0.9%
126b59d2c6
Go to file
Sebastian 126b59d2c6 Updated project information.
2017-10-10 23:16:51 +01:00
Resources Initial commit: 2017-03-17 23:22:13 +00:00
Source Added ImGui.ShowDemo console variable to show/hide ImGui demo. 2017-10-03 21:26:59 +01:00
.gitignore Initial commit: 2017-03-17 23:22:13 +00:00
ImGui.uplugin Initial commit: 2017-03-17 23:22:13 +00:00
LICENSE Initial commit: 2017-03-17 23:22:13 +00:00
README.md Updated project information. 2017-10-10 23:16:51 +01:00

README.md

Unreal ImGui

MIT licensed

Unreal ImGui is an Unreal Engine 4 plug-in which integrates Dear ImGui framework developed by Omar Cornut.

Dear ImGui simplifies and helps with creation of quality visualisation and debugging tools for your Unreal projects.

About

This plug-in adds to Unreal project ImGui module. Adding it as as a dependency to other modules enables them to use Dear ImGui framework.

The base aim of the project is to provide a basic integration of Dear ImGui, without imposing any patters how it should be used in projects. Right now it doesn't extend ImGui API for Unreal types, but that will change in near future.

This is a work in progress but it supports key Unreal features, like Multi-PIE sessions etc. When running Multi-PIE session, each world gets its own ImGui context where world specific data can be visualised.

The upcoming feature is the ability to invisibly switch contexts when calling ImGui functions from different worlds.

After that I plan to add more usability features, better documentation and integration of Remote ImGui which enables using ImGui from a browser and to investigate possibility of opening ImGui for Blueprints.

How to use it

To use this plug-in, you will need a C++ Unreal project.

Content of this repository needs to be placed in Plugins directory under project's root: /Plugins/ImGui. After you compile and run you should notice that ImGui module is now available.

To use that in other modules you will need to declare it as a public or private dependency in those modules' Build.cs files:

PublicDependencyModuleNames.AddRange(new string[] { "ImGui" });

or

PrivateDependencyModuleNames.AddRange(new string[] { "ImGui" });

You should now be able to use ImGui.

Console variables:

  • ImGui.InputEnabled - Allows to enable or disable ImGui input mode. 0: disabled (default); 1: enabled, input is routed to ImGui and with a few exceptions is consumed. Note: this is going to be supported by a keyboard short-cut, but in the meantime ImGui input can be enabled/disabled using console.
  • ImGui.ShowDemo - Show ImGui demo. 0: disabled (default); 1: enabled.
  • ImGui.Debug.Widget - Show self-debug for the widget that renders ImGui output. 0: disabled (default); 1: enabled.

See also

License

Unreal ImGui is licensed under the MIT License, see LICENSE for more information.