Unreal ImGui 项目使用教程

Unreal ImGui 项目使用教程

UnrealImGui Unreal plug-in that integrates Dear ImGui framework into Unreal Engine 4/5. 项目地址: https://gitcode.com/gh_mirrors/unr/UnrealImGui

1. 项目的目录结构及介绍

Unreal ImGui 是一个将 Dear ImGui 集成到 Unreal Engine 4/5 的插件。以下是项目的目录结构及其介绍：

• Source：包含所有的 C++ 源文件和头文件，这里是插件的主体部分。
• Plugins：插件的主目录，包含了插件的编译文件和元数据。
• Resources：存放项目所需的资源文件，如图片、字体等。
• .gitattributes：定义 Git 的一些行为，例如哪些文件应该以二进制形式存储。
• .gitignore：定义 Git 忽略的文件列表，以避免将不必要的文件提交到版本控制。
• CHANGES.md：记录项目的更新和修改历史。
• LICENSE：项目的许可协议文件。
• README.md：项目的说明文件，包含了项目的介绍、安装和使用说明。

2. 项目的启动文件介绍

项目的启动文件主要是 ImGui.uplugin，这是 Unreal Engine 插件的一个元数据文件，包含了插件的名称、版本、作者等信息。Unreal Engine 会读取这个文件来加载和管理插件。

3. 项目的配置文件介绍

Unreal ImGui 的配置主要通过 C++ 代码中的宏定义和函数调用来实现。以下是一些主要的配置选项：

• IMGUI_MODULE_TYPE：定义插件的模块类型，通常设置为 Runtime。
• IMGUI_PLUGIN_NAME：定义插件名称。
• IMGUI_PLUGIN_VERSION：定义插件的版本号。

在插件的源文件中，可以通过修改这些宏的值来配置插件的行为。例如，可以通过修改 IMGUI_MODULE_TYPE 来指定插件只在编辑器中使用，或者在编辑器和游戏中都可以使用。

此外，插件的配置还可能涉及到对 ImGui 类的实例化，以及对特定功能的启用或禁用，例如启用自定义字体支持等。

在使用插件时，开发者需要根据自己的项目需求来调整这些配置，以确保插件能够正确地集成到 Unreal Engine 项目中。

UnrealImGui Unreal plug-in that integrates Dear ImGui framework into Unreal Engine 4/5. 项目地址: https://gitcode.com/gh_mirrors/unr/UnrealImGui