Git Product home page Git Product logo

imguiplugin's Introduction

ImGuiPlugin

A simple plugin for integrating Dear ImGui in Unreal Engine 5.

⚠️About

  • The plugin is not production ready.
  • The plugin is just something silly built to add QOL improvements to editor.
  • The plugin is not compatible with UE4.

Installation

  • Clone the repo in GameProject/Plugins folder along with submodule dependency
    git clone --recurse-submodules [email protected]:amuTBKT/ImGuiPlugin.git
  • ImGui and Implot binaries need to be compiled separately. The way unreal build setup works makes it difficult to include third party libraries, so they have to be compiled separately.
    Source/Thirdparty/ImGui/Build.bat, might require some modifications to patch cmake reference and setting compiler options (visual studio version etc)
    Running the batch script should generate required libs under "/ImGuiPlugin/Source/Thirdparty/ImGui/Binaries" and "/ImGuiPlugin/Source/Thirdparty/ImGui/Intermediate" directories.
  • Include the plugin in your own modules.

👷Usage

At it's core the plugin is just a Slate widget with ImGui renderer, yes it's that simple :)
The plugin manages a global widget/window which can be used to add global widgets (managers, stats visualizer etc.)
User can also create SImGuiWidget widget which works like any other Slate widget with an addition of Tick delegate which can be used to add ImGui widgets.

Adding to main window

  • Using IMGUI_REGISTER_STATIC_WIDGET(InitFunction, TickFunction)
  • Dynamically binding to main window delegate
    UImGuiSubsystem* Subsystem = UImGuiSubsystem::Get();
    MainWindowTickHandle = Subsystem->GetMainWindowTickDelegate().Add(TickDelegate);`
    

Creating a standalone window

UImGuiSubsystem* Subsystem = UImGuiSubsystem::Get();
ImGuiWindow = Subsystem->CreateWindow("TestWindow", { 300., 300. }, TickDelegate);

Creating a slate widget

Users can create SImGuiWidget widget and add them to viewport or Slate containers, works similar to any other slate widget.

imguiplugin's People

Contributors

amutbkt avatar

Stargazers

SeyoungKim✝ avatar Eugene Esaulenko avatar Crash Angel Arts avatar David avatar Hiko ひこ 黑口 avatar mohamad hani janaty avatar Yevhenii Shcherbyna avatar 幽姝 avatar  avatar  avatar Arne Koenig avatar juaxix avatar hola avatar Kornel Meszaros avatar Shenjie(沈杰) avatar David Mórász avatar Yuan-Man avatar lipengzha avatar  avatar Doeke Wartena avatar Corentin Demougeot avatar Jonathan Lacasse avatar  avatar Gabor Papp avatar Jorden Hill avatar Omid Ghajar avatar Tianqi Li avatar Doğa Can Yanıkoğlu avatar Oprea Alexandru avatar Q.Levin avatar Victor Pagani avatar Paul Evans avatar Karl avatar Datee avatar Ryosuke avatar  avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.