README
🚀 Unity MCP 中文文档
Unity MCP(Multipurpose Controller Plugin)是一款多功能插件,它能够增强Unity编辑器的功能。用户集成该插件后,可直接在MCP客户端使用Unity工具,极大提升开发效率。
🚀 快速开始
Unity MCP能为Unity编辑器赋予更多强大功能,帮助开发者更高效地进行开发工作。下面为你介绍具体的使用步骤。
📦 安装指南
克隆仓库
在终端运行以下命令以克隆仓库:
git clone https://github.com/justinpbarnett/unity-mcp.git
安装依赖项
进入项目目录并安装Python依赖:
pip install -r requirements.txt
💻 使用示例
基础用法
使用该插件的基本步骤如下:
- 打开Unity编辑器,加载相关项目。
- 启动MCP客户端(如Claude、Cursor等)。
- 在MCP中输入命令以调用插件功能。
高级用法
输入以下命令:
unity-mcp create-player-controller
将创建一个基本的玩家控制器脚本。
🤝 贡献指南
如果你想为这个项目贡献代码,可以按照以下步骤进行:
- Fork主仓库。
- 创建新分支(如
feature/新功能或bugfix/修复问题)。 - 提交更改并推送到远程仓库。
- 提出Pull Request以合并到主分支。
❗ 故障排除
Unity编辑器无法连接
- 确保Unity编辑器已启动。
- 检查MCP窗口状态(Window > Unity MCP)。
- 重启Unity编辑器。
MCP客户端无法连接
- 验证服务端路径是否正确(如
/path/to/unity-mcp/server.py)。 - 使用命令验证Python环境:
python --version
📄 许可证
本项目遵循MIT许可证,具体内容见LICENSE文件。
📞 联系方式
感谢您的支持!
Scan to contact