Unreal Analyzer MCP

🚀 UnrealCodeAnalyzer

UnrealCodeAnalyzer 是一款多功能工具鏈，可對 Unreal Engine 和自定義代碼庫進行全面分析。它提供了豐富強大的分析工具，如代碼搜索、API 文檔生成、子系統分析等，能有效提升代碼分析和管理的效率。

🚀 快速開始

1. 安裝工具：克隆項目倉庫並安裝依賴。

git clone https://github.com/yourusername/unreal-code-analyzer.git
cd unreal-code-analyzer
npm install

2. 初始化配置（可選）：創建 config.json 文件以指定代碼庫路徑和其他選項。
3. 運行基本分析：

node index.js --analyze-classes AActor,APawn

✨ 主要特性

• 自動解析：支持從 Unreal Engine 到自定義 C++ 代碼庫的全棧分析。
• 智能搜索：集成 Tree - sitter 解析器，提供精準的代碼結構分析和搜索功能。
• 文檔生成：從源碼註釋中提取信息，自動生成詳細的 API 文檔。
• 模式匹配：支持正則表達式搜索、語法高亮以及複雜的文件匹配規則。
• 子系統分析：對 Unreal Engine 的核心子系統進行全面剖析。

📦 安裝指南

1. 克隆項目倉庫：

git clone https://github.com/yourusername/unreal-code-analyzer.git
cd unreal-code-analyzer

2. 安裝依賴：

npm install

3. 初始化配置（可選）：創建 config.json 文件以指定代碼庫路徑和其他選項。

💻 使用示例

基礎用法

分析 Unreal Engine 或自定義代碼庫

const analyzer = new UnrealCodeAnalyzer({
  // 必填：設置 Unreal Engine 路徑或自定義代碼庫路徑
  codebasePath: '/path/to/unreal/engine',
  // 可選：啟用詳細日誌記錄
  verbose: true,
  // 可選：指定要分析的模塊或組件（按逗號分隔）
  modules: ['Physics', 'Rendering']
});

自動生成 API 文檔

const docGenerator = new DocumentationGenerator(analyzer);
docGenerator.generate('/path/to/output/docs');

語法分析器

const parser = new CodeParser();
parser.parseFile('/path/to/source/file.cpp');

類分析工具

const classAnalysis = analyzer.analyzeClass('AMyActor');
// 輸出: {
//   name: 'AMyActor',
//   hierarchy: ['AActor', 'APawn'],
//   properties: [...],
//   functions: [...],
//   comments: [...] 
// }

代碼搜索工具

const searchResults = analyzer.searchCode({
  query: 'UE4.*_STRUCT',
  options: {
    caseSensitive: true,
    regex: false
  }
});

物理子系統分析

const physicsSubsystem = analyzer.analyzeSubsystem('Physics');
// 輸出: 包含物理系統的詳細組件和功能模塊的結構報告。

使用正則表達式搜索

const regexSearch = analyzer.searchWithRegex(/\bUE4_\w+_STRUCT\b/g);
// 輸出匹配結果

單元測試

test('應正確分析 Actor 類', () => {
  const analyzer = new UnrealCodeAnalyzer({ codebasePath: '/' });
  const result = analyzer.analyzeClass('AActor');
  expect(result.hierarchy).toContain('AActor');
});

高級用法

文檔生成 - 簡單用法

node docs/generate.js --path /path/to/engine --output ./docs

文檔生成 - 高級配置

在 package.json 中添加以下內容：

{
  "scripts": {
    "generate-docs": "doc-generator --config config.json"
  }
}

命令行工具 - 快速運行

node src/index.js --help

命令行工具 - 分析命令

node src/index.js --analyze AMyActor,AMyOtherActor

📚 詳細文檔

常見問題

• Q: 如何指定自定義代碼庫？
• A: 在 config.json 中添加 customCodebasePath 屬性，或在初始化時通過選項傳遞。

錯誤處理

常見錯誤及解決方案

1. 未指定代碼庫路徑
   • 問題: 在初始化時未提供 codebasePath。
   • 解決: 添加 codebasePath 到配置文件或直接傳遞給構造函數。
2. 模塊不存在
   • 問題: 嘗試分析的類、子系統或模塊不存在。
   • 解決: 確保提供的名稱正確無誤，或者參考文檔中的可用選項。

性能考慮

優化建議

1. 多線程支持：利用多核處理器加速代碼解析和搜索操作。
2. 內存管理：對於大型項目，確保有足夠的內存以避免性能瓶頸。

貢獻指南

如何貢獻代碼

1. Fork 倉庫
2. 提交改進
3. 創建 Pull Request

我們歡迎任何形式的貢獻，包括功能增強、bug 修復和文檔更新。

學習資源

推薦以下學習資料以深入理解 Unreal Engine 的內部機制：

1. Unreal Engine 官方文檔
2. UE4 教程合集
3. 遊戲開發基礎知識

最佳實踐

1. 配置日誌記錄：建議在生產環境中啟用詳細日誌以方便調試。
2. 模塊化分析：針對大型項目，分模塊進行代碼分析可以提高效率。

🔧 技術細節

項目結構

unreal-code-analyzer/
├── src/                 # 源代碼目錄
│   ├── Analyzer.js     # 主分析器類
│   ├── CodeParser.js   # 語法解析器
│   └── DocumentationGenerator.js # 文檔生成工具
├── docs/               # 文檔和示例
├── test/              # 單元測試文件
└── package.json       # 項目依賴管理

📄 許可證

本項目遵循 MIT 協議。歡迎 fork 和貢獻。