返回 MCP 目录
public公开dns本地运行

Unity MCP

Unity编辑器插件,通过AI实现场景自动化操作

article

README

🚀 Unity MCP(模型上下文协议)

Unity MCP是一款强大的Unity编辑器插件,借助模型上下文协议达成AI驱动的场景操作与自动化,极大提升开发效率。

🚀 快速开始

Unity MCP能让你借助AI实现场景操作和自动化。按以下步骤开启使用:

  1. 克隆此仓库。
  2. 打开Unity项目。
  3. UnityMCP文件夹导入到项目的Assets目录中。
  4. 插件将在Unity编辑器的Window > Unity MCP菜单下可见。
  5. Window > Unity MCP打开Unity MCP窗口。
  6. 点击“启动服务器”开始监听AI命令。
  7. 配置您的AI客户端以连接到MCP服务器。
  8. 开始发送命令以操作您的Unity场景。

✨ 主要特性

  • 双向通信:实现AI与Unity编辑器之间的双向通信。
  • 场景操作自动化:支持场景操作与自动化。
  • 对象管理:可进行游戏对象的创建与修改。
  • 组件管理:提供组件管理功能。
  • 资产处理:支持资产导入与管理。
  • 窗口控制:能对编辑器窗口进行控制。

📦 安装指南

  • 克隆此仓库。
  • 打开Unity项目。
  • UnityMCP文件夹导入到项目的Assets目录中。
  • 插件将在Unity编辑器的Window > Unity MCP菜单下可见。

💻 使用示例

基础用法

以下是使用Unity MCP的基本步骤:

1. 从`Window > Unity MCP`打开Unity MCP窗口。
2. 点击“启动服务器”开始监听AI命令。
3. 配置您的AI客户端以连接到MCP服务器。
4. 开始发送命令以操作您的Unity场景。

高级用法

在高级场景中,你可以根据具体需求对AI客户端和MCP服务器进行更精细的配置,以实现复杂的场景操作和自动化任务。

📚 详细文档

兼容性要求

  • Unity 2022.3或更高版本。
  • .NET框架4.7.1或更高版本。
  • Python 3.10或更高版本(用于MCP服务器)。

开发结构

该项目的结构如下:

  • UnityMCP/ - 主插件目录
    • Editor/ - 编辑器脚本和窗口
    • Runtime/ - 运行时组件和工具
    • Server/ - 套接字服务器实现
    • Protocol/ - MCP协议实现

📄 许可证

本项目采用MIT许可证。

help

运行方式说明

cloud

托管运行

托管运行通常表示这个 MCP Server 由服务方环境承载,用户一般按页面提供的连接方式或授权流程接入,不需要在本地长期启动一个 MCP 进程

  1. 打开服务方连接页
  2. 完成授权或复制端点
  3. 在 MCP 客户端中连接
terminal

本地运行 / 其它方式

本地运行通常需要用户在自己的电脑或服务器上安装依赖,把 server_config 复制到 MCP 客户端,并按 env_schema 补齐环境变量、密钥或其它配置

  1. 复制 server_config
  2. 安装所需依赖
  3. 补齐环境变量后重启客户端