Unreal Analyzer MCP

🚀 UnrealCodeAnalyzer

UnrealCodeAnalyzerは、Unreal Engineとカスタムコードライブラリに特化した強力なコード分析ツールです。全面的なコードレビュー、APIドキュメント生成、ゲームタイプ固有の分析機能を提供します。

🚀 クイックスタート

UnrealCodeAnalyzerを使用するには、以下の手順に従ってください。

インストール

1. 依存関係のインストール

npm install

2. コードライブラリのパスを設定

   • 初期化時に、Unreal Engineまたはカスタムコードライブラリのパスを指定します。

3. 分析ツールの実行

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

使用方法

1. クラス階層構造の分析

完全な継承関係とインターフェース実装を取得します。

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

2. メンバー分析

指定されたクラスのすべてのメンバーを解析します。

const members = await analyzer.analyzeMembers('MyClass', true);
// メソッド、属性、イベントの詳細情報を含む

3. 参照検索

コードライブラリ内のシンボルのすべての参照を検索します。

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

4. コード検索

ファイルパターンに基づいてコードスニペットを検索します。

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

5. サブシステム分析

特定のUnrealエンジンサブシステムに関する情報を分析します。

const subsystemInfo = await analyzer.analyzeSubsystem('Physics');
// コアクラス、重要な機能などの情報を返す

✨ 主な機能

コア機能モジュール

1. コード分析ツール

   • クラス階層構造分析: 継承関係とインターフェース実装を通じて、完全なクラス情報を提供します。
   • メンバー分析: 各クラスのメソッド、属性、イベントを詳細に解析します。
   • 参照検索: クラス、メソッド、または変数の使用位置をすばやく特定します。

2. APIドキュメント生成器

   • 構文例や使用方法の説明を含むAPIドキュメントを自動生成します。
   • カテゴリとモジュールごとのフィルタリングをサポートします。

3. ゲームタイプ知識ベース

   • 異なるゲームタイプ（シューティング、RPGなど）に対して特定の機能コンポーネントの分析を提供します。

4. MCPサーバー統合

   • EpicのMaterial Change Protocol (MCP) サーバーとの相互作用機能を提供し、ツールの登録とリクエスト処理をサポートします。

5. 学習リソースセンター

   • Unreal Engineの公式ドキュメント、チュートリアルビデオ、コミュニティリソースを統合します。

ファイル構造

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                  # プロジェクトの依存関係設定

📦 インストール

1. 依存関係のインストール

npm install

2. コードライブラリのパスを設定

   • 初期化時に、Unreal Engineまたはカスタムコードライブラリのパスを指定します。

3. 分析ツールの実行

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

💻 使用例

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');

📚 ドキュメント

エラー処理

• 一般的なエラー
  • パスが設定されていない: 初期化時にコードライブラリのパスを指定する必要があります。
  • 無効な検索パターン: 検索パターンが正しいことを確認してください。

パフォーマンスに関する考慮事項

• 最適化の提案
  • デフォルトのフィルターを使用して分析範囲を減らします。
  • 大規模なプロジェクトの場合は、モジュールごとに分析することをお勧めします。

テスト

1. テストの実行

npm test

2. カスタムテストの作成

describe('UnrealCodeAnalyzer', () => {
    it('should analyze class hierarchy', async () => {
        // テストロジック
    });
});

貢献ガイド

1. 問題の提出

   • GitHubを通じてissueを提出して、問題を報告または提案を行ってください。

2. 開発への参加

   • リポジトリをForkし、自分のブランチで開発を行い、完了したらPull Requestを送信してください。

🔧 技術詳細

プロジェクトの特徴

• モジュール化設計: 各機能モジュールは独立して拡張可能です。
• 高性能分析: 最適化されたコード処理プロセスにより、迅速な応答が保証されます。
• マルチプラットフォームサポート: Windows、Linux、macOSシステムをサポートしています。

📄 ライセンス

[プロジェクトのライセンス情報]

詳細な情報については、プロジェクトのGitHubリポジトリを参照するか、開発チームにお問い合わせください。