Unity AI Bridge

🚀 Unity-MCP

Unity-MCP は、UnityエンジンとAIアシスタントを接続するためのブリッジプロジェクトです。JSON-RPCプロトコルを通じて、AIアシスタントとUnityアプリケーション間の通信と相互作用を可能にします。

🚀 クイックスタート

Unity-MCP を使うことで、AIアシスタントとUnityエンジンの間でJSON-RPCプロトコルを介した通信が可能になります。これにより、Unityの実行時環境でコードを実行したり、オブジェクトをクエリしたり、ログを取得したりすることができます。

✨ 主な機能

• Unityの実行時環境で直接コードスニペットを実行できます。
• Unityオブジェクトモデルへの読み取り専用アクセスインターフェイスを提供します。
• 拡張可能なアーキテクチャ設計で、さらなる機能モジュールの追加が容易です。
• 強力なエラー処理メカニズムが備わっています。
• 統一されたログ記録とトラッキング機能を持っています。

📦 インストール

原READMEにインストール手順に関する内容が記載されていないため、このセクションは省略されます。

💻 使用例

基本的な使用法

コードの実行

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "execute_code", 
    "arguments": {
      "code": "Debug.Log(\"Hello from Unity!\"); return GameObject.FindObjectsOfType<GameObject>().Length;",
      "timeout": 5000
    }
  }
}

オブジェクトのクエリ

{
  "jsonrpc": "2.0",
  "id": 2,
  "method": "tools/call", 
  "params": {
    "name": "query",
    "arguments": {
      "query": "Camera.main.transform.position",
      "timeout": 5000
    }
  }
}

ログの取得

{
  "jsonrpc": "2.0",
  "id": 3,
  "method": "tools/call", 
  "params": {
    "name": "get_log_by_name",
    "arguments": {
      "log_name": "unity-execute-1712534400000",
      "limit": 1
    }
  }
}

高度な使用法

AIアシスタントがUnityツールへのアクセス権を取得した後、以下の操作が可能です。

你能在这个Unity中执行下面的C#代码吗？

GameObject.Find("Player").transform.position = new Vector3(0, 1, 0);

📚 ドキュメント

核心アーキテクチャ

• JSON-RPCインターフェイス: このプロジェクトはJSON-RPC 2.0仕様に基づいて設計されており、Unityエンジンとの相互作用のための一連のRPCメソッドを提供します。
• ツールセット: 複数の機能モジュールを提供します。
  • execute_code: Unityの実行時環境で任意のC#コードを実行します。
  • query: ドット表記法を使用してUnityオブジェクト、属性、およびメソッドをクエリします。
  • get_log_by_name: AILoggerから特定のログエントリを取得します。
• 非同期実行: すべての操作は非同期実行をサポートしており、高性能で応答性の高い体験を保証します。

🔧 技術詳細

原READMEに技術詳細に関する具体的な内容が十分に記載されていないため、このセクションは省略されます。

📄 ライセンス

このプロジェクトはMITライセンスの下で公開されています。

👨‍💻 作者

T Savo (@TSavo)