Unreal Analyzer MCP

🚀 UnrealCodeAnalyzer 中文文檔

UnrealCodeAnalyzer 是一款強大的代碼分析工具，專為 Unreal Engine 和自定義代碼庫量身打造。它具備全面的代碼審查、API 文檔生成以及遊戲類型特定分析等功能，能有效提升代碼開發和管理的效率。

🚀 快速開始

安裝與配置

1. 安裝依賴

npm install

2. 設置代碼庫路徑 在初始化時指定 Unreal Engine 或自定義代碼庫的路徑。
3. 運行分析工具

node src/UnrealCodeAnalyzer.ts --path /your/unreal/engine/path

運行測試

npm test

✨ 主要特性

核心功能模塊

1. 代碼分析工具
   • 類層次結構分析：通過繼承關係和接口實現，提供完整的類信息。
   • 成員分析：深入解析每個類的方法、屬性和事件。
   • 引用查找：快速定位類、方法或變量的使用位置。
2. API 文檔生成器
   • 自動生成 API 文檔，包括語法示例和用法說明。
   • 支持按類別和模塊進行過濾。
3. 遊戲類型知識庫
   • 針對不同遊戲類型（如射擊、RPG）提供特定功能組件分析。
4. MCP 服務器集成
   • 提供與 Epic 的 Material Change Protocol (MCP) 服務器的交互能力，支持工具註冊和請求處理。
5. 學習資源中心
   • 整合 Unreal Engine 官方文檔、教程視頻和社區資源。

項目特點

• 模塊化設計：各功能模塊獨立可擴展。
• 高性能分析：優化的代碼處理流程確保快速響應。
• 多平臺支持：支持 Windows、Linux 和 macOS 系統。

📦 安裝指南

安裝依賴

npm install

設置代碼庫路徑

在初始化時指定 Unreal Engine 或自定義代碼庫的路徑。

運行分析工具

node src/UnrealCodeAnalyzer.ts --path /your/unreal/engine/path

💻 使用示例

基礎用法

分析類層次結構

獲取完整的繼承關係和接口實現：

const analyzer = new UnrealCodeAnalyzer();
const classHierarchy = analyzer.analyzeClass('MyClass');

成員分析

解析指定類的所有成員：

const members = await analyzer.analyzeMembers('MyClass', true);
// 包含方法、屬性和事件的詳細信息

引用查找

查找符號在代碼庫中的所有引用：

const references = analyzer.findReferences('MyFunction');

代碼搜索

根據文件模式搜索代碼片段：

const results = await analyzer.searchCode(
    'some search pattern',
    { extensions: ['.cpp', '.h'], directories: ['src'] }
);

子系統分析

分析特定 Unreal 引擎子系統的相關信息：

const subsystemInfo = await analyzer.analyzeSubsystem('Physics');
// 返回核心類、關鍵特性等信息

高級用法

分析 Unreal Engine 類

const analyzer = new UnrealCodeAnalyzer('/path/to/UnrealEngine');
const FVectorClass = await analyzer.getClass('FVector');
console.log(FVectorClass.hierarchy); // 輸出繼承關係

生成 API 文檔

const docGenerator = new ApidocGenerator();
docGenerator.generateDocumentation('MyClass', '/output/path');

📚 詳細文檔

文件結構

unreal-code-analyzer/
├── src/
│   ├── UnrealCodeAnalyzer.ts       # 核心分析類
│   ├── Analyzers/                 # 各種代碼分析器
│   │   └── CodeSearchAnalyzer.ts  # 代碼搜索分析器
│   ├── Servers/                   # MCP 服務器實現
│   │   └── McpServer.ts          # MCP 服務端邏輯
│   ├── Documenters/              # 文檔生成工具
│   │   └──apidoc-generator.ts    # 自動文檔生工具
│   └── TestSuites/               # 測試套件
│       └── UnrealCodeAnalyzer.test.ts  # 核心功能測試
├── public/
│   ├── index.html                 # 主界面
│   └── assets/                   # 靜態資源文件夾
└── package.json                  # 項目依賴配置

使用說明

分析類層次結構

獲取完整的繼承關係和接口實現：

const analyzer = new UnrealCodeAnalyzer();
const classHierarchy = analyzer.analyzeClass('MyClass');

成員分析

解析指定類的所有成員：

const members = await analyzer.analyzeMembers('MyClass', true);
// 包含方法、屬性和事件的詳細信息

引用查找

查找符號在代碼庫中的所有引用：

const references = analyzer.findReferences('MyFunction');

代碼搜索

根據文件模式搜索代碼片段：

const results = await analyzer.searchCode(
    'some search pattern',
    { extensions: ['.cpp', '.h'], directories: ['src'] }
);

子系統分析

分析特定 Unreal 引擎子系統的相關信息：

const subsystemInfo = await analyzer.analyzeSubsystem('Physics');
// 返回核心類、關鍵特性等信息

錯誤處理

• 常見錯誤
  • 路徑未設置：初始化時必須指定代碼庫路徑。
  • 無效搜索模式：確保搜索模式正確無誤。

性能考慮

• 優化建議
  • 使用默認過濾器減少分析範圍。
  • 對大型項目，建議分模塊進行分析。

測試

運行測試

npm test

編寫自定義測試

describe('UnrealCodeAnalyzer', () => {
    it('should analyze class hierarchy', async () => {
        // 測試邏輯
    });
});

貢獻指南

1. 提交問題 通過 GitHub 提交 issue 報告問題或提出建議。
2. 參與開發 Fork 倉庫並在自己的分支上進行開發，完成後發起 Pull Request。

🔧 技術細節

代碼分析工具

• 類層次結構分析：通過繼承關係和接口實現，提供完整的類信息。
• 成員分析：深入解析每個類的方法、屬性和事件。
• 引用查找：快速定位類、方法或變量的使用位置。

API 文檔生成器

• 自動生成 API 文檔，包括語法示例和用法說明。
• 支持按類別和模塊進行過濾。

遊戲類型知識庫

• 針對不同遊戲類型（如射擊、RPG）提供特定功能組件分析。

MCP 服務器集成

• 提供與 Epic 的 Material Change Protocol (MCP) 服務器的交互能力，支持工具註冊和請求處理。

學習資源中心

• 整合 Unreal Engine 官方文檔、教程視頻和社區資源。

📄 許可證

[項目許可證信息]

如需更多信息，請參考項目的 GitHub 倉庫或聯繫開發團隊。

相關資源

• 官方文檔：Unreal Engine 開發文檔
• 社區論壇：Unreal 引擎社區