asdlei99 / netimgui

'Dear Imgui' remote access library and application

Summary

NetImgui is a library to remotely display and control Dear ImGui menus with an associated netImgui server application. Designed to painlessly integrate into existing codebase with few changes required to the existing logic.

Purpose

Initially created to assist game developers in debugging their game from a PC while it runs on console. However, its use can easily be extended to other fields.

1. Input ease of use

For programs running on hardware without easy access to a keyboard and mouse, netImgui provides the comfort of your computer's inputs while controlling it remotely.

2. Declutter display

Dear ImGui is often used to display relevant debug information during development, but its UI elements can obscure the regular window content. NetImgui sends the debug menus to a separate window, leaving the original display clutter-free and with freedom to use the entire screen for more elaborate debug content.

Before

With netImgui

Integration

• Download the latest version of netImgui.
• Generate solutions and compile the netImguiServer application.
• Add the content of Code\Client to your codebase.
• In your codebase :
  • [once] Call NetImgui::Connect(...) (starts connection to netImguiServer).
  • [once] Call NetImgui::SendDataTexture(...) (upload your font texture to netImguiServer).
  • [Every Redraw]
    • Replace ImGui::NewFrame() call, with NetImgui::NewFrame().
    • Draw your ImGui menu as usual.
    • Replace ImGui::Render() call, with NetImgui::EndFrame().

(More integration details can be found on the Wiki and netImgui_Sample project can provides insights)

Note

• Different Dear ImGui content can be displayed locally and remotely at the same time.
• NetImgui::IsConnected and NetImgui::IsRemoteDraw can be used during menu udpate, to make decisions on what content to draw.

Release notes

To do

• Support of additional texture formats
• Commands to assign custom backgrounds
• Handle Linear/sRGB vertex color format
• Add logging information in netImgui server application
• Profile and optimize performances
• Add copy/paste support
• Add new Dear ImGui multi windows support (docking branch)
• Networking: Add support of client accepting connection from netImgui App

Version 1.1.001

(2020/07/02)

• Added ImGui 1.77 support

Version 1.1

(2020/06/23)

• Few fixes
• Added support to Posix sockets (Unix/Mac/Android support)
• Added texture format A8

Version 1.0

(2020/06/13)

• Initial Release
• netImgui server application
• netImgui client code (for integration into external codebase)

Older

Release Notes

Contact

Author can be reached for feedbacks / comments at: sammyfreg (at) gmail . com

Credits

Sincere thanks to Omar Cornut for the incredible work on Dear ImGui.

Support of image formats via stb_image.h by Sean Barrett (public domain).

Support of Solutions generation via Sharpmake by Ubisoft (public domain).

support of Posix sockets thanks to Aaron Lieberman.