Back to MCP directory
publicPublicdnsLocal runtime

unity-mcp

Unity MCP是一个连接Unity编辑器与大型语言模型(LLM)的桥梁工具,通过本地MCP客户端实现自然语言控制Unity编辑器功能,支持资产管理、场景控制、脚本编辑等自动化操作。

article

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

💻 使用示例

基础用法

使用该插件的基本步骤如下:

  1. 打开Unity编辑器,加载相关项目。
  2. 启动MCP客户端(如Claude、Cursor等)。
  3. 在MCP中输入命令以调用插件功能。

高级用法

输入以下命令:

unity-mcp create-player-controller

将创建一个基本的玩家控制器脚本。

🤝 贡献指南

如果你想为这个项目贡献代码,可以按照以下步骤进行:

  1. Fork主仓库。
  2. 创建新分支(如feature/新功能bugfix/修复问题)。
  3. 提交更改并推送到远程仓库。
  4. 提出Pull Request以合并到主分支。

❗ 故障排除

Unity编辑器无法连接

  • 确保Unity编辑器已启动。
  • 检查MCP窗口状态(Window > Unity MCP)。
  • 重启Unity编辑器。

MCP客户端无法连接

  • 验证服务端路径是否正确(如/path/to/unity-mcp/server.py)。
  • 使用命令验证Python环境:
python --version

📄 许可证

本项目遵循MIT许可证,具体内容见LICENSE文件。

📞 联系方式


感谢您的支持!

help

Runtime guide

cloud

Hosted runtime

Hosted servers run from a provider-managed environment. You usually connect the MCP client to the hosted endpoint or follow the provider's authorization flow, without keeping a local process alive

  1. Open provider connection page
  2. Authorize or copy endpoint
  3. Connect from your MCP client
terminal

Local runtime / other methods

Local servers run on your own machine or infrastructure. You normally copy the server_config into your MCP client, install the required package, and provide env variables from env_schema when needed

  1. Copy server_config
  2. Install required package
  3. Fill env variables and restart client