diff --git a/README.md b/README.md index fe136ec..47afd45 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,9 @@ + +> [!NOTE] +> 本文档由 WeHub 基于上游 README 翻译整理，属于社区翻译，非官方中文文档。 +> [English](./README.en.md) · [原始项目](https://github.com/CoplayDev/unity-mcp) · [上游 README](https://github.com/CoplayDev/unity-mcp/blob/HEAD/README.md) +> 原作者、版权与许可证归属以原始项目及本仓库 LICENSE 文件为准。 +

@@ -9,22 +15,22 @@ [English](README.md) ↔ [简体中文](docs/i18n/README-zh.md)    |    [Discord](https://discord.gg/y4p8KfzrN4) ↔ [Wiki](https://coplaydev.github.io/unity-mcp/) -#### Proudly sponsored and maintained by [Aura](https://www.tryaura.dev/) — the AI assistant for Unreal & Unity. -##### And don't miss [Godot AI](https://github.com/hi-godot/godot-ai), the new open source project from the makers of MCP for Unity. +#### 由 [Aura](https://www.tryaura.dev/) 自豪赞助并维护 —— 面向 Unreal 与 Unity 的 AI 助手。 +##### 另请关注 [Godot AI](https://github.com/hi-godot/godot-ai), —— MCP for Unity 团队推出的全新开源项目。 -

Create your Unity apps with LLMs. MCP for Unity bridges AI assistants — Claude, Codex, VS Code, local LLMs, and more — with your Unity Editor via Model Context Protocol. Give your LLM the tools to manage assets, control scenes, edit scripts, run tests, and automate your game dev workflows.

+

用 LLM 构建你的 Unity 应用。 MCP for Unity 通过 Model Context Protocol（模型上下文协议），将 AI 助手 —— Claude、Codex、VS Code、本地 LLM 等 —— 与你的 Unity Editor 连接起来。让你的 LLM 能够管理资源、控制场景、编辑脚本、运行测试，并自动化你的游戏开发工作流。

- MCP for Unity building a scene + MCP for Unity 构建场景

---
-Recent Updates +最近更新 * **[v10.0.0](https://github.com/CoplayDev/unity-mcp/releases/tag/v10.0.0)** (2026-06-30) * **[v9.7.3](https://github.com/CoplayDev/unity-mcp/releases/tag/v9.7.3)** (2026-06-15) @@ -32,58 +38,58 @@ * **[v9.7.0](https://github.com/CoplayDev/unity-mcp/releases/tag/v9.7.0)** (2026-05-22) * **[v9.6.8](https://github.com/CoplayDev/unity-mcp/releases/tag/v9.6.8)** (2026-04-27) -Full history: [Release Notes](https://coplaydev.github.io/unity-mcp/releases). +完整历史：[发布说明](https://coplaydev.github.io/unity-mcp/releases).
--- -## What it does +## 功能概览 -Control the Unity Editor in natural language from any MCP client — create scenes & GameObjects, edit C# scripts, manage assets, run tests, profile, and build. 47 focused MCP tool entrypoints, any client, free & MIT. +通过任意 MCP 客户端，用自然语言控制 Unity Editor —— 创建场景与 GameObject、编辑 C# 脚本、管理资源、运行测试、性能分析并构建项目。47 个聚焦的 MCP 工具入口，兼容任意客户端，免费且采用 MIT 许可。 -**[Browse the full tool catalog →](https://coplaydev.github.io/unity-mcp/reference/tools/)** +**[浏览完整工具目录 →](https://coplaydev.github.io/unity-mcp/reference/tools/)** --- -## Quickstart +## 快速开始 -**Requirements:** Unity **2021.3 LTS → 6.x** · Python **3.10+** (via [`uv`](https://docs.astral.sh/uv/)). Works with **any MCP client** — Claude Desktop & Code, Cursor, VS Code, Windsurf, Cline, Gemini CLI, and more. +**环境要求：** Unity **2021.3 LTS → 6.x** · Python **3.10+**（通过 [`uv`](https://docs.astral.sh/uv/)). 兼容**任意 MCP 客户端** —— Claude Desktop & Code、Cursor、VS Code、Windsurf、Cline、Gemini CLI 等。 -1. **Install** — Unity → Package Manager → Add from git URL: - `https://github.com/CoplayDev/unity-mcp.git?path=/MCPForUnity#main`  _(pin `#v10.0.0` for this release, or `openupm add com.coplaydev.unity-mcp`)_ -2. **Configure** — `Window → MCP for Unity → Configure All Detected Clients`. -3. **Prompt** — *"Create a cube at the origin and add a Rigidbody."* The cube appears in seconds. +1. **安装** —— Unity → Package Manager → Add from git URL： + `https://github.com/CoplayDev/unity-mcp.git?path=/MCPForUnity#main`  _(固定使用 `#v10.0.0` 以匹配本版本，或使用 `openupm add com.coplaydev.unity-mcp`)_ +2. **配置** —— `Window → MCP for Unity → Configure All Detected Clients`。 +3. **提示** —— *"Create a cube at the origin and add a Rigidbody."* 数秒内即可看到立方体出现。 --- -## Community +## 社区 -- [Discord](https://discord.gg/y4p8KfzrN4) — chat with maintainers and other contributors -- [Issues](https://github.com/CoplayDev/unity-mcp/issues) — bugs and feature requests -- [Discussions](https://github.com/CoplayDev/unity-mcp/discussions) — design ideas and broader questions -- Security: see [SECURITY.md](SECURITY.md) for private reporting +- [Discord](https://discord.gg/y4p8KfzrN4) —— 与维护者及其他贡献者交流 +- [Issues](https://github.com/CoplayDev/unity-mcp/issues) —— 提交 Bug 与功能请求 +- [Discussions](https://github.com/CoplayDev/unity-mcp/discussions) —— 设计想法与更广泛的问题讨论 +- 安全：请参阅 [SECURITY.md](SECURITY.md) 进行私密报告 -## Contributing +## 贡献 -See [CONTRIBUTING.md](CONTRIBUTING.md). Branch off `beta`, not `main`. The full dev setup, testing, and release process live in the [Contributing](https://coplaydev.github.io/unity-mcp/contributing/dev-setup) docs. +请参阅 [CONTRIBUTING.md](CONTRIBUTING.md)。请从 `beta` 分支，而非 `main`。完整的开发环境搭建、测试与发布流程见 [Contributing](https://coplaydev.github.io/unity-mcp/contributing/dev-setup) 文档。 -## Advanced +## 高级 -- **Multiple Unity instances** — [Multi-Instance Routing](https://coplaydev.github.io/unity-mcp/guides/multi-instance) -- **Tool groups (vfx / animation / ui / testing / etc.)** — [Tool Groups](https://coplaydev.github.io/unity-mcp/guides/tool-groups) -- **v10 asset generation and upgrade notes** — [v10 Migration](https://coplaydev.github.io/unity-mcp/migrations/v10) -- **Roslyn script validation** — [Roslyn Validation](https://coplaydev.github.io/unity-mcp/guides/roslyn) -- **Remote-hosted server with auth** — [Remote Server Auth](https://coplaydev.github.io/unity-mcp/guides/remote-server-auth) +- **多个 Unity 实例** —— [Multi-Instance Routing（多实例路由）](https://coplaydev.github.io/unity-mcp/guides/multi-instance) +- **工具分组（vfx / animation / ui / testing / 等）** —— [Tool Groups（工具分组）](https://coplaydev.github.io/unity-mcp/guides/tool-groups) +- **v10 资源生成与升级说明** —— [v10 Migration（v10 迁移）](https://coplaydev.github.io/unity-mcp/migrations/v10) +- **Roslyn 脚本验证** —— [Roslyn Validation](https://coplaydev.github.io/unity-mcp/guides/roslyn) +- **带身份验证的远程托管服务器** —— [Remote Server Auth（远程服务器认证）](https://coplaydev.github.io/unity-mcp/guides/remote-server-auth) ## Star History [![Star History Chart](https://api.star-history.com/svg?repos=CoplayDev/unity-mcp&type=Date)](https://www.star-history.com/#CoplayDev/unity-mcp&Date) -## Citation +## 引用 -If MCP for Unity helped your research, please cite it. +如果 MCP for Unity 对你的研究有所帮助，欢迎引用。 ```bibtex @inproceedings{wu2025mcpunity, @@ -99,16 +105,16 @@ If MCP for Unity helped your research, please cite it. } ``` -## Unity AI Tools by Aura +## Aura 的 Unity AI 工具 -Aura offers 2 AI tools for Unity: -- **MCP for Unity** is available freely under the MIT license. -- **Aura for Unity** is a premium Unity/Unreal AI assistant built for game devs. +Aura 为 Unity 提供 2 款 AI 工具： +- **MCP for Unity** 在 MIT 许可下免费提供。 +- **Aura for Unity** 是面向游戏开发者的付费 Unity/Unreal AI 助手。 -## Disclaimer +## 免责声明 -This project is a free and open-source tool for the Unity Editor, and is not affiliated with Unity Technologies. +本项目是面向 Unity Editor 的免费开源工具，与 Unity Technologies 无任何关联。 --- -**License:** MIT — see [LICENSE](LICENSE). +**许可证：** MIT —— 详见 [LICENSE](LICENSE)。