UE5Coro 开源项目教程
1. 项目的目录结构及介绍
UE5Coro 项目的目录结构如下:
ue5coro/
├── .github/
│ └── workflows/
├── .gitignore
├── .pre-commit-config.yaml
├── .prettierrc
├── LICENSE
├── README.md
├── Source/
│ ├── UE5Coro/
│ │ ├── Private/
│ │ │ ├── UE5Coro.cpp
│ │ │ ├── UE5CoroModule.cpp
│ │ │ └── UE5CoroModule.h
│ │ └── Public/
│ │ └── UE5Coro.h
│ └── UE5CoroEditor/
│ ├── Private/
│ │ ├── UE5CoroEditor.cpp
│ │ ├── UE5CoroEditorModule.cpp
│ │ └── UE5CoroEditorModule.h
│ └── Public/
│ └── UE5CoroEditor.h
├── .editorconfig
├── .clang-format
├── .clang-tidy
├── .cmake-format.yaml
├── CMakeLists.txt
├── .vscode/
│ └── settings.json
└── .idea/
└── workspace.xml
目录结构介绍
.github/
:包含 GitHub 工作流配置文件。.gitignore
:Git 忽略文件配置。.pre-commit-config.yaml
:预提交钩子配置。.prettierrc
:代码格式化配置。LICENSE
:项目许可证。README.md
:项目说明文档。Source/
:源代码目录。UE5Coro/
:UE5Coro 核心代码。Private/
:私有代码文件。Public/
:公共代码文件。
UE5CoroEditor/
:UE5Coro 编辑器扩展代码。Private/
:私有代码文件。Public/
:公共代码文件。
.editorconfig
:编辑器配置文件。.clang-format
:Clang 格式化配置。.clang-tidy
:Clang 静态分析配置。.cmake-format.yaml
:CMake 格式化配置。CMakeLists.txt
:CMake 构建配置文件。.vscode/
:Visual Studio Code 配置文件。.idea/
:JetBrains IDE 配置文件。
2. 项目的启动文件介绍
UE5Coro 项目的启动文件主要位于 Source/UE5Coro/Private/
目录下,包括:
UE5Coro.cpp
:项目主文件,包含项目的初始化和运行逻辑。UE5CoroModule.cpp
:模块定义文件,定义了 UE5Coro 模块的初始化和关闭逻辑。UE5CoroModule.h
:模块头文件,声明了 UE5Coro 模块的接口和类。
启动文件介绍
-
UE5Coro.cpp
:- 包含项目的初始化函数
StartupModule
和关闭函数ShutdownModule
。 - 负责注册和注销项目所需的资源和事件。
- 包含项目的初始化函数
-
UE5CoroModule.cpp
:- 定义了
FUE5CoroModule
类,继承自IModuleInterface
。 - 实现了
StartupModule
和ShutdownModule
方法,用于模块的启动和关闭。
- 定义了
-
UE5CoroModule.h
:- 声明了
FUE5CoroModule
类,提供了模块的接口定义。
- 声明了
3. 项目的配置文件介绍
UE5Coro 项目的配置文件主要包括:
.gitignore
:指定 Git 忽略的文件和目录。.pre-commit-config.yaml
:配置预提交钩子,用于代码格式化和静态分析。.prettierrc
:配置代码格式化规则。.editorconfig
:配置编辑器行为和代码风格。.clang-format
:配置 Clang 格式化规则。.clang-tidy
:配置 Clang 静态分析规则。.cmake-format.yaml
:配置 CMake 格式化规则。- `CMakeLists