微信扫一扫README
🚀 Unity MCP 包
Unity MCP 包是一个专注于增强材料编辑功能的工具，它基于原始 MCP 功能构建。目前虽仅实现材料增强功能，但项目正积极开发且会定期更新。未来将推出光照效果、高级材料属性、物理集成、地形增强等特性。此包还能充当 Unity 和大型语言模型 (LLMs) 之间的桥梁，借助 Model Context Protocol (MCP) 实现 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 包管理器
步骤 1：安装 Python
从 python.org 下载并安装 Python 3.12 或更高版本。安装时请确保将 Python 添加到系统 PATH 中。
步骤 2：安装 uv
uv 是一个简化依赖管理的 Python 包管理器。根据你的操作系统使用以下命令进行安装：
- Mac：
brew install uv
- Windows：
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 安装指南。
⚠️ 重要提示
未安装 uv 则无法继续。
步骤 3：安装 Unity 包
- 打开 Unity 并转到
Window > Package Manager。 - 点击
+按钮，选择从 Git URL 添加包。 - 输入:
https://github.com/HuangChILun/reavorse-mcp.git
安装完成后，Unity MCP 包将在你的 Unity 项目中可用。使用 Claude Desktop 或 Cursor 等 MCP 客户端时，服务器会自动启动。
✨ 主要特性
- 双向通信：在 Unity 和 Python 之间实现高效的命令发送和响应接收。
- 资产管理：轻松管理 Unity 资产，提升开发效率。
- 场景控制：对场景对象进行精细控制，优化编辑流程。
- 增强的材料编辑：通过改进的光照和着色器支持，实现更高质量的材料效果。
- 脚本集成：无缝集成 C# 脚本，扩展 Unity 功能。
- 编辑自动化：自动化常见编辑任务，提高开发效率。
- 其他功能：利用新的实验性功能，探索更多可能性。
🔧 故障排除
问题 1: Unity Bridge 没有运行
确保 Unity 编辑器已启动，并且 MCP 服务器正在运行。如果需要帮助，请参考 官方文档。
问题 2: 安装 Python 出错
检查你的操作系统是否支持 Python 的最低版本要求（3.12 或更高）。如果仍然有问题，可以联系 Python 社区寻求帮助。
问题 3: uv 工具未安装
按照上述步骤重新安装 uv 工具，并确保其路径配置正确。如果问题持续，请访问 uv 官网 查找更多信息。
📞 联系
如需联系开发者或获取支持，请访问 GitHub 仓库 或通过电子邮件与我们联系：contact@unitymcp.com。
🙏 鸣谢
感谢以下人员和项目的贡献：
- 原始 MCP 协议的作者。
- Unity 社区的支持和反馈。
- 所有为改进此项目做出贡献的开发人员。