Unity Editor

🚀 UnityMCP

UnityMCPは、強力なUnityエディタープラグインです。Model Context Protocol (MCP) を実装することで、UnityとAIアシスタント間のシームレスな統合を実現します。リアルタイムのエディター状態監視、リモートコマンド実行、そして包括的なログ記録機能を提供します。

🚀 クイックスタート

UnityMCPは、UnityエディターとAIアシスタントの間の通信を容易にするためのプラグインです。以下の手順で、簡単にセットアップできます。

✨ 主な機能

• リアルタイム状態更新：WebSocketを通じてエディターの状態をリアルタイムで監視します。
• コマンド実行：MCPサーバーからの指令を受け取り、実行します。
• ログ記録：エディターのログ情報を収集・管理します。

📦 インストール

1. npmを使ったインストール

npm install unitymcp

2. サーバーの起動

npx unitymcp start

3. Unityエディターへのプラグインのインポート

• プラグインフォルダをエディターの Assets/ ディレクトリに追加します。
• UnityでMCPプラグインを有効にします。

💻 使用例

基本的な使用法

1. MCPサーバーの起動

npx unitymcp start --port=8080

2. Unityスクリプトでのプラグインの初期化

using UnityMCP;

public class MCPInitializer : MonoBehaviour {
    void Start() {
        MCPManager.Instance.Connect("ws://localhost:8080");
    }
}

高度な使用法

イベントのサブスクライブ

MCPManager.Instance.OnCommand += HandleCommand;

カスタムコマンドの定義

[MCPCommand("customcommand")]
public class CustomCommandHandler {
    public static void Execute(string[] args) {
        // カスタムコマンドの処理
    }
}

📚 ドキュメント

新しいコマンドの作成

1. 新しいC#クラスの作成

[MCPCommand("newcommand")]
public class NewCommandHandler {
    public static void Execute(string[] args) {
        // ロジックの実装
    }
}

2. コマンドハンドラーの登録

MCPManager.Register(typeof(NewCommandHandler));

プラグイン機能の拡張

1. 新しい機能モジュールの追加

• 新しいフォルダ Assets/Plugins/Extensions を作成します。
• その中にカスタムスクリプトやアセットを追加します。

2. 拡張プログラムの作成

public class ExtensionExample : MonoBehaviour {
    void Update() {
        if (MCPManager.IsConnected) {
            MCPManager.Instance.SendHeartbeat();
        }
    }
}

🔧 技術詳細

通信プロトコル

• WebSocketプロトコルを使用し、ポートは8080です。
• 双方向のリアルタイム更新をサポートします。
• すべての通信はJSON形式に基づいています。

セキュリティ機能

• コマンド実行のタイムアウト保護。
• エラー処理と検証メカニズム。
• ログバッファ管理。
• 接続状態の監視。

📄 ライセンス

このプロジェクトは MIT License のオープンソースライセンスの下で提供されています。

問題解決

接続問題

• サーバーが実行中で、WebSocketポートが開いていることを確認してください。
• ネットワーク設定を確認し、ファイアウォールがポートをブロックしていないことを確認してください。

コマンドが実行されない場合

• コマンドが正しく登録され、処理されていることを確認してください。
• ログを確認して、より詳細なデバッグ情報を取得してください。

貢献のガイドライン

1. リポジトリをForkします。
2. 機能ブランチを作成します (git checkout -b feature/amazing-feature)。
3. 変更をコミットします (git commit -m 'Add amazing feature')。
4. ブランチにプッシュします (git push origin feature/amazing-feature)。
5. Pull Requestを開きます。