mcpField
U
ue5-architecture

ue5-architecture

github.com/unrealxu开发53348 次安装9 周前更新
代码仓库

关于 ue5-architecture

ue5-architecture 是用于规划 Unreal Engine 5 模块边界与依赖的技能，帮助开发者梳理现有代码、明确 API 归属，并在重构前识别架构风险。

主要功能

  1. 01梳理运行时、编辑器、UI、网络和数据模块
  2. 02定义模块职责与公共 API
  3. 03规划 Build.cs 依赖边界
  4. 04识别循环依赖和跨层引用
  5. 05标记类与资源迁移风险

适用场景

  1. 01实现前规划模块结构
  2. 02检查依赖与包含边界
  3. 03评估模块拆分风险

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/unrealxu/unrealengine5-skills --skill ue5-architecture

安装后在 Claude Code 中输入/ue5-architecture确认已加载。

包含的文件

除 SKILL.md 外，安装时一起下载的参考资料和脚本。

agents/
openai.yaml
references/
build-cs-patterns.md
module-layout.md
project-adapter.md
ue5-engine-module-index-v2.csv
ue5-engine-module-index-v2.md
ue5-engine-module-index.csv
ue5-engine-module-index.md
ue5-module-routing-table-draft.csv
ue5-module-routing-table-final.csv
scripts/
generate_module_index_v2.py

详细介绍

快速开始

  • 收集当前模块列表、*.Build.cs 和主要的玩法/UI 系统。
  • 编写代码前，先提出一个目标模块图。
  • 使用表格列出模块职责和所有权。

工作流

  • 根据当前代码库识别运行时、编辑器、UI、网络和数据模块。
  • 为每个模块定义最小化的头文件和 Blueprint 接口，作为其 Public API。
  • 定义 Private 实现边界和包含规则。
  • 为每个模块定义 PublicDependencyModuleNames 和 PrivateDependencyModuleNames。
  • 报告风险：循环包含、过度暴露的反射类型，以及跨层引用。

约束

  • 仅在需要反射时使用 UCLASS/USTRUCT/UENUM。
  • 优先在头文件中使用前向声明；在 .cpp 中包含具体头文件。
  • 未列出迁移影响时，不要跨模块移动类型。
  • 命名应遵循 Unreal 约定（U、A、F、E 前缀）。

故障处理

  • 如果类的所有权不明确，先将其放入运行时模块，并记录 TODO，在完成使用情况梳理后再拆分。
  • 如果依赖图出现循环，将共享契约提取到一个精简的公共模块中。
  • 如果无法确定 Build.cs 依赖项，选择最小集合，并立即验证编译路径。

升级处理

  • 重构需要资源重定向器、类重命名或包路径迁移时，升级处理。
  • 模块拆分会改变现有内容使用的公共 Blueprint 类路径时，升级处理。

评论

支持 Markdown