内容
# Unity MCP 软件包
一个专注于增强材质编辑的 Unity 软件包,基于原有的 MCP 功能。目前仅实现了材质增强,但该项目正在积极开发中,频繁更新。即将到来的功能包括照明效果、先进材质属性、物理集成、地形增强等。该软件包通过模型上下文协议(MCP)实现 Unity 和大型语言模型(LLMs)之间的无缝通信,作为一个桥梁,允许 Unity 发送命令并接收来自符合 MCP 的工具的响应。
## 概述
Unity MCP 服务器提供了一个 Unity(通过 C#)和 Python 服务器之间的双向通信通道,实现了:
- **资产管理**:以编程方式创建、导入和操作 Unity 资产。
- **场景控制**:管理场景、对象及其属性。
- **增强材质编辑**:应用和修改具有改进照明和着色器支持的材质。
- **脚本集成**:在 Unity 中创建、查看和更新 C# 脚本。
- **编辑器自动化**:控制 Unity 编辑器功能,如撤销、重做、播放模式和构建过程。
- **其他 Unity 功能**:利用新的实验性功能,如高级照明控制和后期处理效果。
该项目非常适合希望利用 LLMs 增强其 Unity 项目或自动化重复任务的开发者。
## 安装
要使用 Unity MCP 软件包,请确保已安装以下内容:
- **Unity 2020.3 LTS 或更新版本**(⚠️ 目前仅在 URP 项目中有效)
- **Python 3.12 或更新版本**
- **uv 包管理器**
### 步骤 1:安装 Python
从 [python.org](https://www.python.org/downloads/) 下载并安装 Python 3.12 或更新版本。确保在安装过程中将 Python 添加到系统的 PATH 中。
### 步骤 2:安装 uv
uv 是一个 Python 包管理器,简化了依赖项管理。根据您的操作系统,使用以下命令安装:
- **Mac**:
```bash
brew install uv
```
- **Windows**:
```bash
powershell -c "irm https://astral.sh/uv/install.ps1 | iex"
```
然后,将 uv 添加到您的 PATH 中:
```bash
set Path=%USERPROFILE%\.local\bin;%Path%
```
- **Linux**:
```bash
curl -LsSf https://astral.sh/uv/install.sh | sh
```
有关其他安装方法,请参阅 [uv 安装指南](https://docs.astral.sh/uv/getting-started/installation/)。
**重要**:在安装 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 和 LLMs 之间无缝发送和接收数据。
- **资产管理**:以编程方式导入资产、实例化预制件和创建新预制件。
- **场景控制**:打开、保存和修改场景,以及创建和操作游戏对象。
- **增强材质编辑和照明**:改进材质属性控制、高级照明、着色器集成和后期处理效果。
- **脚本集成**:在 Unity 中创建、查看和更新 C# 脚本。
- **编辑器自动化**:自动化 Unity 编辑器任务,如构建项目或进入播放模式。
- **实验性功能**:正在测试其他 Unity 功能;欢迎提供反馈。
## 故障排除
遇到问题?尝试这些解决方法:
- **Unity Bridge 未运行**
确保 Unity 编辑器已打开,MCP 窗口处于活动状态。如有必要,请重启 Unity。
- **Python 服务器未连接**
验证 Python 和 uv 是否正确安装,以及 Unity MCP 软件包是否正确设置。
- **与 Claude Desktop 或 Cursor 的配置问题**
确保您的 MCP 客户端配置为与 Unity MCP 服务器通信。
- **连接卡住或无进展**
在某些特殊情况下,如果进程似乎卡住且无进展,请尝试关闭 Claude 和 Unity 项目,然后重新连接以重新建立连接。
## 联系
对该项目有疑问?联系我们!
- **X**:[@reavorse](https://x.com/q_thomax)
## 致谢
原始作者:非常感谢 justinpbarnett 创建了原始的 Unity MCP 软件包。增强版建立在他的工作基础上。
特别感谢 Unity Technologies 提供的优秀编辑器 API 和社区的持续反馈。