-
Notifications
You must be signed in to change notification settings - Fork 29
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
NetImgui branch update #1
base: master
Are you sure you want to change the base?
Changes from 9 commits
0e4fa23
e522028
297e09d
f7d1262
112a12b
832e697
1a2a9b6
e65fd85
daf94c1
e67c885
2995b10
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
{ | ||
"CompressionEnable": true, | ||
"Configs": [ | ||
{ | ||
"Auto": true, | ||
"HostPort": 8889, | ||
"Hostname": "localhost", | ||
"Name": "UE Game" | ||
}, | ||
{ | ||
"Auto": true, | ||
"HostPort": 8890, | ||
"Hostname": "localhost", | ||
"Name": "UE Editor" | ||
}, | ||
{ | ||
"Auto": true, | ||
"HostPort": 8891, | ||
"Hostname": "localhost", | ||
"Name": "UE Server" | ||
} | ||
], | ||
"Note": "netImgui Server's list of Clients (Using JSON format).", | ||
"RefreshFPSActive": 30.0, | ||
"RefreshFPSInactive": 30.0, | ||
"ServerPort": 8888, | ||
"Version": 2 | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -9,6 +9,7 @@ Dear ImGui is an immediate-mode graphical user interface library that is very li | |
Status | ||
------ | ||
- [ImGui `v1.89.6`](https://github.com/ocornut/imgui/releases/tag/v1.89.6) | ||
- [NetImgui `v1.9`](https://github.com/sammyfreg/netImgui/releases/tag/v1.9.0) | ||
- [ImPlot `v0.14+18758e23`](https://github.com/epezent/implot/tree/18758e237e8906a97ddf42de1e75793526f30ce9) | ||
|
||
Supported Unreal Engine version: `4.26`, `5.0`, `5.1`, `5.2` | ||
|
@@ -104,6 +105,19 @@ void Init() | |
SceneCaptureComponent2D->CaptureSource = ESceneCaptureSource::SCS_FinalToneCurveHDR; | ||
} | ||
``` | ||
How to Set up NetImgui | ||
---------------------- | ||
|
||
To use NetImgui, use content of the *net_imgui* branch in place of *master*. This will be gradually merged into the *master* but until then you need to use that experimental branch. | ||
|
||
Similarly like ImGui, NetImgui is built as part of the UnrealImGui plugin and no other integration steps are required. | ||
|
||
To be able to connect to the Unreal editor or application that use NetImgui, you need to run a server (netImguiServer). Please, see the [NetImgui](https://github.com/sammyfreg/netImgui) page for instructions how to get it. | ||
|
||
After launching the server for the first time, you need to add two client configurations, for ports 8889 and 8890. After that, you can either initialise connection from the server or set it to autoconnection mode. More info will be added later. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Is this still true if There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. You are right this is no longuer needed with provided config (the 2 basics config). Still need to add console config. It'll update this info. |
||
|
||
Once you establish connection, you can use a top bar to switch between contexts and modes. In standalone game it should be one context and in the editor one editor context, plus one for each PIE instance. | ||
Please, note that all those features are experimental and might evolve. Any input is welcomed. | ||
|
||
### Troubleshooting | ||
If you're using a scene capture and your quad is not drawing at all, make sure your scene capture "Capture Source" is set to "Final Color (with tone curve) in Linear sRGB gamut" to avoid alpha being set to 0 (since there's no way to instruct ImGui to ignore alpha without modding the core UnrealImGui plugin). | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Don't like this, including binaries in the repository. This should be a separate download, ideally from NetImgui itself?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The server app needs to match the client code included. Since the .exe is small, I always included it pre-compiled together to keep simple for users. I could store it on a github wiki, like I do for the github webpage's images. I guess it will also need to have an updated webpage documentation to include the link.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I removed the server application and updated the documentation.