Unity MCP 包

一个增强 Unity 材质编辑和自动化任务的 Unity 包,通过 Model Context Protocol (MCP) 实现 Unity 与大型语言模型 (LLMs) 的双向通信。

  • by HuangChILun
  • C#
  • 本地部署
  • 5 星标
  • 更新于
在 GitHub 查看 HuangChILun/reavorse-mcp

使用说明

Unity MCP包

一个Unity包,专注于增强材料编辑,建立在原始MCP功能的基础上。目前,只实施了材料增强,但该项目正在积极开发中,并经常更新。即将推出的功能包括照明效果、高级材质特性、物理集成、地形增强等。该包通过模型上下文协议(MCP)实现了Unity和大型语言模型(LLM)之间的无缝通信,充当了Unity发送命令和接收MCP兼容工具响应的桥梁。

概述

Unity MCP服务器在Unity(通过C#)和Python服务器之间提供双向通信通道,实现:

  • 资产管理:以编程方式创建、导入和操作Unity资源。
  • 场景控制:管理场景、对象及其属性。
  • 增强材质编辑:使用改进的照明和着色器支持应用和修改材质。
  • 脚本集成:在Unity中创建、查看和更新C#脚本。
  • 编辑器自动化:控制Unity编辑器的功能,如撤消、重做、播放模式和构建过程。
  • Unity附加功能:利用新的实验功能,如高级照明控制和后处理效果。

这个项目非常适合那些想利用LLM来增强Unity项目或自动化重复任务的开发人员。

安装

要使用Unity MCP软件包,请确保已安装以下内容:

  • Unity 2020.3 LTS或更新版本 (⚠️ 目前仅在URP项目中工作)
  • Python 3.12或更高版本
  • uv包管理器

第一步:安装Python

从以下网址下载并安装Python 3.12或更高版本 python.org请确保在安装过程中将Python添加到系统的PATH中。

第二步:安装uv

uv是一个简化依赖管理的Python包管理器。根据您的操作系统,使用以下命令进行安装:

  • 苹果电脑:

    brew install uv
    
  • 视窗:

    powershell -c "irm https://astral.sh/uv/install.ps1 | iex"
    

    然后,将uv添加到PATH中:

    set Path=%USERPROFILE%\.local\bin;%Path%
    
  • Linux:

    curl -LsSf https://astral.sh/uv/install.sh | sh
    

有关替代安装方法,请参阅 紫外线安装指南.

重要:在不安装uv的情况下不要继续。

步骤3:安装Unity软件包

  1. 打开Unity并转到 Window > Package Manager.
  2. 点击 + 按钮并选择 Add package from git URL.
  3. 输入: https://github.com/HuangChILun/reavorse-mcp.git

安装后,Unity MCP包将在您的Unity项目中可用。当与Claude Desktop或Cursor等MCP客户端一起使用时,服务器将自动启动。

特性

  • 双向通信:在Unity和LLM之间无缝发送和接收数据。
  • 资产管理:导入资源,实例化预制件,并以编程方式创建新的预制件。
  • 场景控制:打开、保存和修改场景,以及创建和操纵游戏对象。
  • 增强材质编辑和照明:改进了对材质属性、高级照明、着色器集成和后处理效果的控制。
  • 脚本集成:在Unity中创建、查看和更新C#脚本。
  • 编辑器自动化:自动化Unity编辑器任务,如构建项目或进入播放模式。
  • 实验性功能Unity的其他功能正在测试中;感谢反馈。

故障排除

遇到问题?尝试以下修复:

  • Unity Bridge未运行
    确保Unity编辑器已打开,MCP窗口处于活动状态。如果需要,请重新启动Unity。

  • Python服务器未连接
    验证Python和uv是否已正确安装,Unity MCP包是否已正确设置。

  • Claude Desktop或Cursor的配置问题
    确保您的MCP客户端已配置为与Unity MCP服务器通信。

  • 连接卡住或无进展 在某些特殊情况下,如果流程似乎停滞不前,请尝试关闭Claude和Unity项目,然后重新连接以重建连接。

联系

对项目有疑问吗?伸出手来!

致谢

原作者:非常感谢justinbarnett创建了最初的Unity MCP包。这个增强版本建立在他的工作之上。

特别感谢Unity Technologies的优秀编辑器API,并感谢社区的持续反馈。