UnityMCP

UnityMCP 是一个强大的 Unity 编辑器插件，实现了 Model Context Protocol (MCP)，使 Unity 与 AI 助手之间的集成无缝衔接。它提供实时编辑器状态监控、远程命令执行和全面的日志记录功能。

项目简介

• 核心功能：通过 WebSocket 实现双向实时通信，支持 JSON 格式的消息传输。
• 应用场景：适用于需要实时交互的场景，如游戏开发、实时协作工具或其他需要动态数据交换的应用。
• 目标用户：开发者、设计师和研究人员。

安装与配置

1. 使用 Smithery 安装

# 示例代码：通过 Smithery 进行安装

2. 手动安装

• 插件安装：

  • 将 UnityMCP 文件夹放入你的 Unity 项目中。
  • 在 Unity 中导入该文件夹以完成插件安装。

• 服务器配置：

  • 确保 Node.js 和 npm 已安装。
  • 在项目目录下运行：

    npm install
    

使用说明

启动服务器

node server.js

连接插件

1. 打开 Unity 编辑器。
2. 在 Assets/Editor 文件夹中添加 MCPManager.cs 脚本。
3. 将脚本附加到任意空物体上。
4. 配置 WebSocket 服务器地址（默认为 ws://localhost:8080）。

开发指南

编译与构建

npm run build

监控代码变更

npm run watch

调试通信

npm run inspector

技术细节

通信协议

• 传输方式：基于 WebSocket 的实时双向通信。
• 端口号：默认使用 8080 端口。
• 消息格式：所有通信均采用 JSON 格式。

安全机制

• 命令超时保护：防止长时间未响应的命令执行。
• 错误处理：包括连接异常、命令失败、编译错误和运行时异常的全面处理。
• 日志管理：提供可靠的日志记录和缓冲功能。
• 状态监控：实时跟踪连接状态，确保系统稳定性。

错误处理

系统针对以下情况提供了完善的处理机制：

• 连接中断
• 命令执行失败
• 编译错误
• 运行时异常
• 超时问题

项目贡献

1. 代码仓库：访问 GitHub 仓库。
2. 参与方式：
   • Fork 仓库到你的账号。
   • 创建功能分支（例如 feature/amazing-feature）。
   • 提交更改并添加提交说明。
   • 推送到远程仓库。
   • 提交 Pull Request。

许可证

本项目采用 Creative Commons Attribution-NonCommercial 4.0 International (CC BY-NC 4.0) 协议进行许可。