Skip to content

Commit a0ee624

Browse files
author
Shutong Wu
committed
docs(readme-zh): sync structure with EN + rewrite copy into natural Chinese
Mirror the EN restructure on the zh README — one-line English↔中文 | Discord↔Wiki nav with the brand connector, Recent Updates moved to the top, brief 它能做什么 with the tool catalog behind a link, combined ## 快速开始, dropped badges/工作原理/Asset Store/ the giant inline tool list. Kept the zh-only detail sections (手动配置, 多实例, Roslyn, 故障排除, 贡献, 遥测) and rewrote the authored copy to read like native dev Chinese, not machine translation.
1 parent aad002e commit a0ee624

1 file changed

Lines changed: 54 additions & 125 deletions

File tree

docs/i18n/README-zh.md

Lines changed: 54 additions & 125 deletions
Original file line numberDiff line numberDiff line change
@@ -7,99 +7,59 @@
77

88
<div align="center">
99

10-
[English](../../README.md) &nbsp;·&nbsp; [简体中文](README-zh.md)
10+
[English](../../README.md) <img src="../images/connector.svg" alt="" height="14"> [简体中文](README-zh.md) &nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp; [Discord](https://discord.gg/y4p8KfzrN4) <img src="../images/connector.svg" alt="" height="14"> [Wiki](https://coplaydev.github.io/unity-mcp/)
1111

1212
#### [Aura](https://www.tryaura.dev/) 荣誉赞助并维护 —— 面向 Unreal 与 Unity 的 AI 助手。
13-
##### 别错过 [Godot AI](https://github.com/hi-godot/godot-ai) 🤖,MCP for Unity 团队推出的全新开源 MCP/AI 项目!
14-
15-
[![Docs](https://img.shields.io/badge/Docs-unity--mcp-4f46e5)](https://coplaydev.github.io/unity-mcp/)
16-
[![Discord](https://img.shields.io/badge/discord-join-red.svg?logo=discord&logoColor=white)](https://discord.gg/y4p8KfzrN4)
17-
[![](https://img.shields.io/badge/Unity-000000?style=flat&logo=unity&logoColor=blue 'Unity')](https://unity.com/releases/editor/archive)
18-
[![python](https://img.shields.io/badge/Python-3.10+-3776AB.svg?style=flat&logo=python&logoColor=white)](https://www.python.org)
19-
[![](https://badge.mcpx.dev?status=on 'MCP Enabled')](https://modelcontextprotocol.io/introduction)
20-
[![](https://img.shields.io/badge/License-MIT-red.svg 'MIT License')](https://opensource.org/licenses/MIT)
21-
[![Downloads](https://static.pepy.tech/badge/mcpforunityserver)](https://pepy.tech/project/mcpforunityserver)
22-
[![Release](https://img.shields.io/github/v/release/CoplayDev/unity-mcp)](https://github.com/CoplayDev/unity-mcp/releases)
23-
[![CI](https://img.shields.io/github/actions/workflow/status/CoplayDev/unity-mcp/python-tests.yml?branch=beta&label=tests)](https://github.com/CoplayDev/unity-mcp/actions/workflows/python-tests.yml)
24-
[![OpenUPM](https://img.shields.io/npm/v/com.coplaydev.unity-mcp?label=OpenUPM&registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.coplaydev.unity-mcp/)
25-
[![Stars](https://img.shields.io/github/stars/CoplayDev/unity-mcp?style=flat)](https://github.com/CoplayDev/unity-mcp/stargazers)
13+
##### 别错过 [Godot AI](https://github.com/hi-godot/godot-ai) 🤖,MCP for Unity 团队推出的全新开源项目!
2614

2715
</div>
2816

29-
<p align="center"><b>用大语言模型创建你的 Unity 应用!</b> MCP for Unity 通过 <a href="https://modelcontextprotocol.io/introduction">Model Context Protocol</a> 将 AI 助手(Claude、Cursor、VS Code 等)与你的 Unity Editor 连接起来。为你的大语言模型提供管理资源、控制场景、编辑脚本和自动化任务的工具。</p>
17+
<p align="center"><b>用大模型来做 Unity 开发。</b> MCP for Unity 通过 <a href="https://modelcontextprotocol.io/introduction">Model Context Protocol</a> Claude、Cursor、VS Code、本地大模型等 AI 助手接入 Unity 编辑器,让它们直接帮你管理资源、搭场景、写脚本、跑测试,把开发流程里的重复活儿都包了。</p>
3018

3119
<p align="center">
3220
<img alt="MCP for Unity building a scene" src="../images/building_scene.gif">
3321
</p>
3422

3523
---
3624

37-
## 它能做什么
38-
39-
用自然语言从任意 MCP 客户端控制 Unity Editor。告诉助手你想做的事
40-
—— "添加一个带 Rigidbody 的玩家"、"写一个存档系统"、"运行测试"
41-
—— 助手将通过 40+ 个专注的工具驱动 Editor。
42-
43-
- **场景与 GameObject** — 创建、查询、修改层级、组件、预制体
44-
- **脚本** — 创建/编辑 C#,带 Roslyn 验证
45-
- **资源与渲染** — 材质、着色器、贴图、VFX
46-
- **构建、测试与性能** — 运行 EditMode/PlayMode 测试、Profiler、构建
47-
- **任意 MCP 客户端** — Claude、Cursor、VS Code、Windsurf、Gemini CLI 等
48-
- **免费 & MIT**,支持多实例
49-
5025
<details>
51-
<summary><b>完整工具目录(40+ 工具,9 组)</b></summary>
52-
53-
查看 [工具参考](https://coplaydev.github.io/unity-mcp/reference/tools/) 了解所有工具:**core**(场景、GameObject、脚本、资源、预制体、组件、编辑器控制、控制台、菜单)、**scripting_ext****vfx**(着色器、贴图)、**ui****animation****testing****probuilder****profiling****docs**
26+
<summary><strong>最近更新</strong></summary>
5427

55-
### 可用工具
56-
`apply_text_edits``batch_execute``create_script``debug_request_context``delete_script``execute_custom_tool``execute_menu_item``find_gameobjects``find_in_file``get_sha``get_test_job``manage_animation``manage_asset``manage_build``manage_camera``manage_components``manage_editor``manage_gameobject``manage_graphics``manage_material``manage_packages``manage_physics``manage_prefabs``manage_probuilder``manage_profiler``manage_scene``manage_script``manage_script_capabilities``manage_scriptable_object``manage_shader``manage_texture``manage_tools``manage_ui``manage_vfx``read_console``refresh_unity``run_tests``script_apply_edits``set_active_instance``unity_docs``unity_reflect``validate_script`
28+
* **[v9.7.0](https://github.com/CoplayDev/unity-mcp/releases/tag/v9.7.0)**(2026-05-22)
29+
* **[v9.6.8](https://github.com/CoplayDev/unity-mcp/releases/tag/v9.6.8)**(2026-04-27)
30+
* **[v9.6.6](https://github.com/CoplayDev/unity-mcp/releases/tag/v9.6.6)**(2026-04-07)
31+
* **[v9.6.5](https://github.com/CoplayDev/unity-mcp/releases/tag/v9.6.5)**(2026-04-03)
32+
* **[v9.6.4](https://github.com/CoplayDev/unity-mcp/releases/tag/v9.6.4)**(2026-03-31)
5733

58-
### 可用资源
59-
`cameras``custom_tools``renderer_features``rendering_stats``volumes``editor_active_tool``editor_prefab_stage``editor_selection``editor_state``editor_windows``gameobject``gameobject_api``gameobject_component``gameobject_components``get_tests``get_tests_for_mode``menu_items``prefab_api``prefab_hierarchy``prefab_info``project_info``project_layers``project_tags``tool_groups``unity_instances`
34+
完整更新历史见 [发布说明](https://coplaydev.github.io/unity-mcp/releases)
6035

61-
**性能提示:** 多个操作请使用 `batch_execute` — 比逐个调用快 10-100 倍!
6236
</details>
6337

6438
---
6539

66-
## 支持的客户端和版本
40+
## 它能做什么
6741

68-
支持**任意 MCP 客户端** —— 包括 Claude Desktop 与 Claude Code、Cursor、VS Code(Copilot)、Windsurf、Cline、Gemini CLI、Qwen Code、Copilot CLI、OpenClaw 和 Antigravity。一步即可全部配置:**Window → MCP for Unity → Configure All Detected Clients**
42+
用自然语言从任意 MCP 客户端操作 Unity 编辑器:搭场景、建 GameObject、写改 C# 脚本、调材质和着色器、跑测试、看性能、出包。40+ 个工具,任意客户端可用,免费、MIT 开源
6943

70-
**环境要求:** Unity **2021.3 LTS → 6.x** · Python **3.10+**(通过 [`uv`](https://docs.astral.sh/uv/) 管理)。
44+
**[查看完整工具目录 →](https://coplaydev.github.io/unity-mcp/reference/tools/)**
7145

7246
---
7347

74-
## 60秒快速开始
48+
## 快速开始
7549

76-
**前置要求** Unity 2021.3 LTS+、一个 MCP 客户端,以及 [uv](https://docs.astral.sh/uv/)(如未安装将自动安装)
50+
**环境要求** Unity **2021.3 LTS → 6.x** · Python **3.10+**(用 [`uv`](https://docs.astral.sh/uv/) 管理)。兼容**任意 MCP 客户端**——Claude Desktop 与 Claude Code、Cursor、VS Code、Windsurf、Cline、Gemini CLI 等等
7751

78-
1. **安装包**(Unity → Package Manager → 从 git URL 添加):
79-
`https://github.com/CoplayDev/unity-mcp.git?path=/MCPForUnity#beta`
80-
2. **配置客户端:** `Window → MCP for Unity → Configure All Detected Clients`
81-
3. **发出提示:** *"在原点创建一个立方体并添加 Rigidbody。"*
82-
几秒内你将看到场景中出现该立方体。
83-
84-
<details>
85-
<summary>其他安装方式(Asset Store、OpenUPM)</summary>
86-
87-
**Unity Asset Store:**
88-
1. 访问 [Asset Store 上的 MCP for Unity](https://assetstore.unity.com/packages/tools/generative-ai/mcp-for-unity-ai-driven-development-329908)
89-
2. 点击 `Add to My Assets`,然后通过 `Window > Package Manager` 导入
90-
91-
**OpenUPM:**
92-
```bash
93-
openupm add com.coplaydev.unity-mcp
94-
```
95-
</details>
52+
1. **安装** —— 在 Unity 里打开 Package Manager,从 git URL 添加:
53+
`https://github.com/CoplayDev/unity-mcp.git?path=/MCPForUnity#beta` &nbsp;_(也可以用 `openupm add com.coplaydev.unity-mcp`)_
54+
2. **配置客户端** —— `Window → MCP for Unity → Configure All Detected Clients`,一键搞定所有检测到的客户端。
55+
3. **发个提示试试** —— *"在原点放一个立方体,加个 Rigidbody。"* 立方体几秒就出现在场景里了。
9656

9757
<details>
9858
<summary><strong>手动配置</strong></summary>
9959

100-
如果自动设置不生效,请把下面内容添加到你的 MCP Client 配置文件中
60+
如果自动配置不生效,把下面的内容加到你的 MCP 客户端配置文件里
10161

102-
**HTTP(默认 — 适用于 Claude Desktop、Cursor、Windsurf):**
62+
**HTTP(默认 — 适用于 Claude Desktop、Cursor、Windsurf):**
10363
```json
10464
{
10565
"mcpServers": {
@@ -153,101 +113,70 @@ openupm add com.coplaydev.unity-mcp
153113

154114
---
155115

156-
## 工作原理
157-
158-
你的提示 → **MCP 客户端**(Claude、Cursor 等)→ **MCP for Unity 服务器****Unity Editor 插件** → 你的**场景、资源与脚本**
159-
160-
详见[架构概览](https://coplaydev.github.io/unity-mcp/architecture/transports),了解传输方式、多实例路由与内部机制。
161-
162-
---
163-
164-
<details>
165-
<summary><strong>最近更新</strong></summary>
166-
167-
* **v9.6.3 (beta)** — 新增 `manage_profiler` 工具(14个操作):Profiler 会话控制(启动/停止/状态/设置区域)、帧时间与计数器读取、对象内存查询、内存快照(通过 com.unity.memoryprofiler 进行拍摄/列表/比较)、帧调试器(启用/禁用/获取事件)。分组:`profiling`
168-
* **v9.6.2** — 新增 `manage_physics` 工具(21个操作):物理设置、层碰撞矩阵、物理材质、关节(5种3D + 9种2D类型)、查询(raycast、raycast_all、linecast、shapecast、overlap)、力施加(AddForce/AddTorque/AddExplosionForce)、刚体配置、场景物理验证与编辑器模式模拟。全面支持3D和2D物理。
169-
* **v9.6.1** — QoL 扩展:`manage_editor` 新增撤销/重做操作。`manage_scene` 新增多场景编辑(叠加加载、关闭、设置活动场景、跨场景移动物体)、场景模板(3d_basic、2d_basic 等)、场景验证与自动修复。新增 `manage_build` 工具:触发玩家构建、切换平台、配置玩家设置、管理构建场景和配置文件(Unity 6+)、跨多平台批量构建、异步任务跟踪与轮询。新增 `MaxPollSeconds` 基础设施,支持长时间运行的工具操作。
170-
* **v9.5.4** — 新增 `unity_reflect``unity_docs` 工具用于 API 验证:通过反射检查实时 C# API,获取官方 Unity 文档(ScriptReference、Manual、包文档)。新增 `manage_packages` 工具:安装、移除、搜索和管理 Unity 包及作用域注册表。包含输入验证、移除时依赖检查和 git URL 警告。
171-
* **v9.5.3** — 新增 `manage_graphics` 工具(33个操作):体积/后处理、光照烘焙、渲染统计、管线设置、URP渲染器特性。3个新资源:`volumes``rendering_stats``renderer_features`
172-
* **v9.5.2** — 新增 `manage_camera` 工具,支持 Cinemachine(预设、优先级、噪声、混合、扩展)、`cameras` 资源、通过 SerializedProperty 修复优先级持久化问题。
173-
174-
<details>
175-
<summary>更早的版本</summary>
176-
177-
* **v9.4.8** — 新编辑器 UI、通过 `manage_tools` 实时切换工具、技能同步窗口、多视图截图、一键 Roslyn 安装器、支持 Qwen Code 与 Gemini CLI 客户端、通过 `manage_probuilder` 进行 ProBuilder 网格编辑。
178-
* **v9.4.7** — 支持按调用路由 Unity 实例、修复 macOS pyenv PATH 问题、脚本工具的域重载稳定性提升。
179-
* **v9.4.6** — 新增 `manage_animation` 工具、支持 Cline 客户端、失效连接检测、工具状态跨重载持久化。
180-
* **v9.4.4** — 可配置 `batch_execute` 限制、按会话状态过滤工具、修复 IPv6/IPv4 回环问题。
181-
182-
</details>
183-
</details>
184-
185-
---
186-
187116
<details>
188117
<summary><strong>多个 Unity 实例</strong></summary>
189118

190-
MCP for Unity 支持多个 Unity Editor 实例。要将操作定向到某个特定实例
119+
MCP for Unity 支持同时开多个 Unity 编辑器实例。想把操作定向到某个实例
191120

192-
1. 让你的大语言模型检查 `unity_instances` 资源
193-
2. 使用 `set_active_instance` 并传入 `Name@hash`例如 `MyProject@abc123`
194-
3. 后续所有工具都会路由到该实例
121+
1. 让大模型读一下 `unity_instances` 资源
122+
2. `set_active_instance` 传入 `Name@hash`比如 `MyProject@abc123`
123+
3. 之后所有工具调用都会走这个实例
195124
</details>
196125

197126
<details>
198-
<summary><strong>Roslyn 脚本验证(高级)</strong></summary>
127+
<summary><strong>Roslyn 脚本验证(进阶)</strong></summary>
199128

200-
要使用能捕获未定义命名空间、类型和方法的 **Strict** 验证:
129+
想用能查出未定义命名空间、类型和方法的 **Strict** 验证:
201130

202-
1. 安装 [NuGetForUnity](https://github.com/GlitchEnzo/NuGetForUnity)
131+
1. [NuGetForUnity](https://github.com/GlitchEnzo/NuGetForUnity)
203132
2. `Window > NuGet Package Manager` → 安装 `Microsoft.CodeAnalysis` v5.0
204-
3. 同时安装 `SQLitePCLRaw.core``SQLitePCLRaw.bundle_e_sqlite3` v3.0.2
205-
4.`Player Settings > Scripting Define Symbols` 中添加 `USE_ROSLYN`
133+
3. 再装 `SQLitePCLRaw.core``SQLitePCLRaw.bundle_e_sqlite3` v3.0.2
134+
4.`Player Settings > Scripting Define Symbols` 里加上 `USE_ROSLYN`
206135
5. 重启 Unity
207136

208137
<details>
209-
<summary>手动 DLL 安装(如果 NuGetForUnity 不可用)</summary>
138+
<summary>手动安装 DLLNuGetForUnity 用不了时)</summary>
210139

211-
1.[NuGet](https://www.nuget.org/packages/Microsoft.CodeAnalysis.CSharp/) 下载 `Microsoft.CodeAnalysis.CSharp.dll` 及其依赖项
212-
2. DLL 放到 `Assets/Plugins/` 目录
213-
3. 确保 .NET 兼容性设置正确
214-
4. 在 Scripting Define Symbols 中添加 `USE_ROSLYN`
140+
1.[NuGet](https://www.nuget.org/packages/Microsoft.CodeAnalysis.CSharp/) 下载 `Microsoft.CodeAnalysis.CSharp.dll` 及其依赖
141+
2. DLL 放进 `Assets/Plugins/`
142+
3. 确认 .NET 兼容性设置正确
143+
4. 在 Scripting Define Symbols 里加上 `USE_ROSLYN`
215144
5. 重启 Unity
216145
</details>
217146
</details>
218147

219148
<details>
220149
<summary><strong>故障排除</strong></summary>
221150

222-
* **Unity Bridge 无法连接** 检查 `Window > MCP for Unity` 状态,重启 Unity
223-
* **Server 无法启动** 确认 `uv --version` 可用,并检查终端错误
224-
* **Client 无法连接** 确认 HTTP server 正在运行,并且 URL 与你的配置一致
151+
* **Unity Bridge 连不上** 看一下 `Window > MCP for Unity` 的状态,重启 Unity
152+
* **服务器起不来** 确认 `uv --version` 能跑,并看看终端报错
153+
* **客户端连不上** 确认 HTTP 服务在运行,且 URL 和你的配置一致
225154

226-
**详细的设置指南**
227-
* [Fix Unity MCP and Cursor, VSCode & Windsurf](https://github.com/CoplayDev/unity-mcp/wiki/1.-Fix-Unity-MCP-and-Cursor,-VSCode-&-Windsurf) — uv/Python 安装、PATH 问题
228-
* [Fix Unity MCP and Claude Code](https://github.com/CoplayDev/unity-mcp/wiki/2.-Fix-Unity-MCP-and-Claude-Code) — Claude CLI 安装
229-
* [Common Setup Problems](https://github.com/CoplayDev/unity-mcp/wiki/3.-Common-Setup-Problems) — macOS dyld 错误、FAQ
155+
**详细配置指南**
156+
* [Fix Unity MCP and Cursor, VSCode & Windsurf](https://github.com/CoplayDev/unity-mcp/wiki/1.-Fix-Unity-MCP-and-Cursor,-VSCode-&-Windsurf) uv/Python 安装、PATH 问题
157+
* [Fix Unity MCP and Claude Code](https://github.com/CoplayDev/unity-mcp/wiki/2.-Fix-Unity-MCP-and-Claude-Code) Claude CLI 安装
158+
* [Common Setup Problems](https://github.com/CoplayDev/unity-mcp/wiki/3.-Common-Setup-Problems) macOS dyld 错误、常见问题
230159

231-
还是卡住?[开一个 Issue](https://github.com/CoplayDev/unity-mcp/issues) [加入 Discord](https://discord.gg/y4p8KfzrN4)
160+
还是搞不定?[提个 Issue](https://github.com/CoplayDev/unity-mcp/issues) 或者 [ Discord](https://discord.gg/y4p8KfzrN4)
232161
</details>
233162

234163
<details>
235-
<summary><strong>贡献</strong></summary>
164+
<summary><strong>参与贡献</strong></summary>
236165

237-
开发环境设置见 [README-DEV.md](../development/README-DEV.md)自定义工具见 [CUSTOM_TOOLS.md](../reference/CUSTOM_TOOLS.md)
166+
开发环境配置见 [README-DEV.md](../development/README-DEV.md)自定义工具见 [CUSTOM_TOOLS.md](../reference/CUSTOM_TOOLS.md)
238167

239-
1. Fork → 创建 issue → 新建分支`feature/your-idea`)→ 修改 → 提 PR
168+
1. Fork → issue → 建分支`feature/your-idea`)→ → 提 PR
240169
</details>
241170

242171
<details>
243172
<summary><strong>遥测与隐私</strong></summary>
244173

245-
匿名、注重隐私的遥测(不包含代码、项目名或个人数据)。可通过 `DISABLE_TELEMETRY=true` 关闭。详见 [TELEMETRY.md](../reference/TELEMETRY.md)
174+
匿名、注重隐私的遥测(不收集代码、项目名或任何个人数据),用 `DISABLE_TELEMETRY=true` 就能关掉。详见 [TELEMETRY.md](../reference/TELEMETRY.md)
246175
</details>
247176

248177
---
249178

250-
**许可证:** MIT — 查看 [LICENSE](../../LICENSE) | **需要帮助?** [Discord](https://discord.gg/y4p8KfzrN4) | [Issues](https://github.com/CoplayDev/unity-mcp/issues)
179+
**许可证:** MIT —— 见 [LICENSE](../../LICENSE) | **需要帮助?** [Discord](https://discord.gg/y4p8KfzrN4) | [Issues](https://github.com/CoplayDev/unity-mcp/issues)
251180

252181
---
253182

@@ -256,8 +185,8 @@ MCP for Unity 支持多个 Unity Editor 实例。要将操作定向到某个特
256185
[![Star History Chart](https://api.star-history.com/svg?repos=CoplayDev/unity-mcp&type=Date)](https://www.star-history.com/#CoplayDev/unity-mcp&Date)
257186

258187
<details>
259-
<summary><strong>研究引用</strong></summary>
260-
如果你正在进行与 Unity-MCP 相关的研究,请引用我们
188+
<summary><strong>论文引用</strong></summary>
189+
如果 MCP for Unity 对你的研究有帮助,欢迎引用我们
261190

262191
```bibtex
263192
@inproceedings{10.1145/3757376.3771417,
@@ -276,10 +205,10 @@ series = {SA Technical Communications '25}
276205

277206
## Aura 的 Unity AI 工具
278207

279-
Aura 提供 2 个 Unity AI 工具:
280-
- **MCP for Unity** MIT 许可证下免费提供
281-
- **Aura for Unity** 是一款面向游戏开发者打造的高级 Unity/Unreal AI 助手。
208+
Aura 出品两款 Unity AI 工具:
209+
- **MCP for Unity** —— MIT 许可证,免费开源
210+
- **Aura for Unity** —— 面向游戏开发者的高级 Unity/Unreal AI 助手。
282211

283212
## 免责声明
284213

285-
本项目是一个免费开源的 Unity Editor 工具,与 Unity Technologies 无关。
214+
本项目是一个免费开源的 Unity 编辑器工具,与 Unity Technologies 无关。

0 commit comments

Comments
 (0)