Make initial setup for NimGui easier

[psuong]

TODO

• Add in a warning or error to the setup wizard when
  • When the user has URP, but did not define URP_ENABLED into the scripting define
  • Double check that the error message is obvious or that NimGui early outs before trying to execute logic with an improper setup
• Pack in the Renderer assets so that it's easier to test when importing the package (maybe as an alternative, automatically assign the correct renderer asset if the Demo scene is running)
• Update
  • Documentation PDF
  • Documentation Site
  • Package version
• Test with 2020.3 LTS
• Test with 2021.2
• Published to Asset Store
• Redeploy demo to itch
• Published to itch.io
• Update CHANGELOG in nimgui repo.

[psuong]

I've added a window that is "reactive" to which render pipeline you are using.

URP

URP_ENABLED defined, but missing ImGuiRenderFeature

If you defined URP_ENABLED in your Scripting Defines but are missing the ImGuiRenderFeature in your ForwardRenderer, then the RenderPipeline Setup section will display the following error. Clicking the Fix now button will add the ImGuiRenderFeature to all of your ForwardRenderers' Render Features list.

URP_ENABLED defined, but missing URP Asset in your Graphics Settings

If you defined URP_ENABLED, but forgot to add the RenderPipeline Asset to your graphics settings, the following error will be displayed.

You must add the RenderPipeline Asset to your GraphicSetting's Scriptable Render Pipeline Settings field!

Example of Pressing the Fix Button

setting-up-nimgui.mov

Builtin RP

You're using Builtin RenderPipeline

When using BuiltinRenderPipeline, you will need to setup the camera in code by calling DefaultImGuiInitialization.SetupCamera(camera, CameraEvent). There is no asset setup you need to do directly in your project.

[psuong]

Error Messaging

Here are the following error messages that will display in the console depending on the situation of the error message.

"[ERROR] The SDF shader is missing, please make sure all assets from NimGui are imported and that the SDF shader is in the Always Included Shader settings.",
"[ERROR] You have enabled URP in NimGui, but have not assigned the Scriptable Render Pipeline Settings in your Project.",
"[ERROR] Your Pipeline Asset is missing the ImGuiRenderFeaturePass.",
"[ERROR] Please make sure that you imported the UbuntuMono-Regular_Atlas.png, this is the default fallback texture.",
"[ERROR] Please make sure that you imported the UbuntuMono-Regular_Glyphs.asset, this is the default fallback font data."

If NimGui catches one of these cases, then NimGui will pause the editor so you can review the errors and do the appropriate step to fix them. Again this is an Editor only feature.

[psuong]

Warning message for when the SDF shader is not included in the build.

[psuong]

NimGui 1.0.1 is released on itch & Unity Asset Store.