项目介绍

Unity-MCP 是一个用于连接 Unity 引擎与 AI 助手的桥梁项目。它允许通过 JSON-RPC 协议在 AI 助手和 Unity 应用程序之间进行通信和交互。

核心架构

• JSON-RPC 接口: 项目基于 JSON-RPC 2.0 规范设计，提供了一系列 RPC 方法用于与 Unity 引擎交互。
• 工具集: 提供多个功能模块：
  • execute_code: 在 Unity 运行时环境中执行任意 C# 代码
  • query: 使用点表示法查询unity对象、属性和方法
  • get_log_by_name: 从AILogger中检索特定日志条目
• 异步执行: 所有操作均支持异步执行，确保高性能和响应式体验

功能亮点

• 支持直接在Unity运行时环境中执行代码片段
• 提供对unity对象模型的只读访问接口
• 可扩展架构设计，便于添加更多功能模块
• 强大的错误处理机制
• 统一的日志记录和跟踪能力

使用示例

执行代码

{
  "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);

许可证

MIT

作者

T Savo (@TSavo)