Unity MCP

🚀 Unity - MCPプロジェクトガイド

Unity - MCP（Unity - Multiplayer Collaboration Protocol）は、UnityゲームエンジンとAIエージェントを統合するためのオープンソースツールキットです。このツールキットにより、AIエージェントはJSON - RPCプロトコルを介してUnityゲームとやり取りし、複雑なゲームロジックタスクを実行することができます。

🚀 クイックスタート

このガイドを通じて、AIエージェントをUnityゲームに簡単に統合し、様々な面白い機能を実現することができます！

✨ 主な機能

Unity - MCPは、AIエージェントとUnityゲームの統合を可能にし、JSON - RPCプロトコルを介して複雑なゲームロジックタスクを実行することができます。また、ログ記録とクエリ機能も備えています。

📦 インストール

リポジトリのクローン

git clone https://github.com/TSavo/unity-mcp.git
cd unity-mcp

.NET SDKのインストール

.NET SDKバージョン5.0以上がインストールされていることを確認してください。インストールされていない場合は、公式リンクからダウンロードしてインストールしてください。

プロジェクトのビルド

dotnet build src/UnityMCP.sln

APIキーの設定

appsettings.jsonに以下の内容を追加します。

{
  "ApiKey": "your_project_key_here",
  "LogLevel": "Information"
}

📚 ドキュメント

ログ記録とクエリ

データ構造

ログエントリは以下のフィールドを含みます。

• id: 一意の識別子（GUID）
• name: ログ名（ツールによって生成されます）
• data: 保存された結果データまたはエラー情報
• timestamp: 記録時間（ISO 8601形式）

クエリ構文

Unityクエリ言語（UQL）を使用して操作します。

// アクティブなプレイヤーのリストを取得
GET /api/players?active=true

// 新しいシーンを作成
POST /api/scenes
{
  "name": "New Scene",
  "settings": { ... }
}

💻 使用例

基本的な使用法

コードの実行

リクエスト例：

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "execute_code",
    "arguments": {
      "code": "Debug.Log(\"你好，Unity!\"); return GameObject.FindObjectsOfType<GameObject>().Length;",
      "超时时间": 5000
    }
  }
}

レスポンス例：

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "内容": [
      {
        "类型": "文本",
        "文本": "{\"状态\":\"成功\",\"日志名称\":\"unity-execute-1712534400000\",\"结果\":{\"成功\":true,\"结果\":42,\"日志\":[\"你好，Unity!\"]}"
      }
    ]
  }
}

オブジェクトのクエリ

リクエスト例：

{
  "jsonrpc": "2.0",
  "id": 2,
  "method": "tools/call",
  "params": {
    "name": "query",
    "arguments": {
      "查询": "Camera.main.transform.position",
      "超时时间": 5000
    }
  }
}

レスポンス例：

{
  "jsonrpc": "2.0",
  "id": 2,
  "result": {
    "内容": [
      {
        "类型": "文本",
        "文本": "{\"x\":10.5,\"y\":-3.2,\"z\":5.8}"
      }
    ]
  }
}

結果の検索

以下のコマンドを使用してログを表示します。

dotnet run -- --query "SELECT * FROM logs"

📄 ライセンス

このプロジェクトはMITライセンスの下で公開されています。詳細はLICENSEファイルを参照してください。

作者情報

• 作者: 张三
• メールアドレス: contact@zhangsan.com
• GitHubリンク: Unity - MCP