🚀 MCP Unity 项目文档

MCP Unity 项目提供了一个强大的插件，用于在 Unity 环境中实现模型上下文支持和 WebSocket 通信等功能，帮助开发者优化编辑器性能，实现模型间的数据交互。

🚀 快速开始

安装与配置

下载与安装

1. 下载 MCP Unity 插件。
2. 解压 文件并将其放置在合适的位置。

配置步骤

1. 打开 Unity 编辑器，进入Edit > Project Settings。
2. 选择MCP Settings标签。
3. 在Server Location中指定你的 MCP 服务器路径。
4. 点击Apply保存设置。

服务器配置

Node.js 安装

1. 访问Node.js 官网下载并安装最新版本的 LTS 版本。
2. 确保npm命令在终端中可用。

服务端代码编译

# 切换到 Server 目录
cd 绝对路径/To/mcp-unity/Server

# 安装依赖项
npm install

# 编译项目
npm run build

✨ 主要特性

核心功能

• 模型上下文支持：实现模型间的数据交互。
• WebSocket 通信：通过实时通信优化编辑器性能。

使用指南

1. 在 Unity 中创建新场景或打开现有场景。
2. 添加 MCP 组件到目标物体上。
3. 配置组件参数以满足项目需求。

📦 安装指南

插件安装

1. 下载 MCP Unity 插件。
2. 解压文件并将其放置在合适的位置。

服务器安装

1. 安装 Node.js 的 LTS 版本。
2. 编译服务端代码：

# 切换到 Server 目录
cd 绝对路径/To/mcp-unity/Server

# 安装依赖项
npm install

# 编译项目
npm run build

💻 使用示例

基础用法

在 Unity 中使用 MCP 插件的基本步骤：

1. 在 Unity 中创建新场景或打开现有场景。
2. 添加 MCP 组件到目标物体上。
3. 配置组件参数以满足项目需求。

📚 详细文档

插件调试

调试配置

1. 在 Unity 编辑器中启用调试模式。
2. 使用浏览器访问localhost:8080查看调试信息。

日志记录

• 控制台日志：默认启用，输出到终端或指定文件。
• 详细日志：通过设置环境变量DEBUG=*启用详细日志。

常见问题

连接问题

1. 确保服务器正在运行（检查 Unity 控制台）。
2. 检查防火墙设置，确保端口未被阻止。
3. 验证端口号是否正确（默认为 8080）。

服务启动失败

• 检查 Unity 控制台中的错误信息。
• 确保 Node.js 已正确安装并添加到路径中。
• 核对服务器目录下所有依赖项是否齐全。

支持与反馈

如需帮助或有任何建议，请在GitHub 仓库中提交问题。

联系方式：

• LinkedIn：Miguel Tomás
• Discord：gamester7178
• 邮箱：game.gamester@gmail.com

贡献指南

欢迎贡献！请遵循Conventional Commits格式提交 Pull Request 或 Issues。

📄 许可证

本项目使用MIT License开源协议。

致谢

感谢以下项目的贡献：

• Model Context Protocol
• Unity Technologies
• Node.js
• WebSocket-Sharp