unity-mcp-cli 0.57.0 → 0.57.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,7 +1,7 @@
1
1
  <div align="center" width="100%">
2
2
  <h1>Unity MCP — <i>CLI</i></h1>
3
3
 
4
- [![npm](https://img.shields.io/npm/v/unity-mcp-cli?label=npm&labelColor=333A41 'npm package')](https://www.npmjs.com/package/unity-mcp-cli)
4
+ [![npm](https://img.shields.io/npm/v/unity-mcp-cli?label=npm&labelColor=333A41 'npm 包')](https://www.npmjs.com/package/unity-mcp-cli)
5
5
  [![Node.js](https://img.shields.io/badge/Node.js-%5E20.19.0%20%7C%7C%20%3E%3D22.12.0-5FA04E?logo=nodedotjs&labelColor=333A41 'Node.js')](https://nodejs.org/)
6
6
  [![License](https://img.shields.io/github/license/IvanMurzak/Unity-MCP?label=License&labelColor=333A41)](https://github.com/IvanMurzak/Unity-MCP/blob/main/LICENSE)
7
7
  [![Stand With Ukraine](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraine.svg)](https://stand-with-ukraine.pp.ua)
@@ -25,52 +25,69 @@
25
25
 
26
26
  </div>
27
27
 
28
- <b>[English](https://github.com/IvanMurzak/Unity-MCP/blob/main/cli/README.md) | [日本語](https://github.com/IvanMurzak/Unity-MCP/blob/main/cli/docs/README.ja.md) | [Español](https://github.com/IvanMurzak/Unity-MCP/blob/main/cli/docs/README.es.md)</b>
28
+ <b>[中文](https://github.com/IvanMurzak/Unity-MCP/blob/main/cli/docs/README.zh-CN.md) | [日本語](https://github.com/IvanMurzak/Unity-MCP/blob/main/cli/docs/README.ja.md) | [Español](https://github.com/IvanMurzak/Unity-MCP/blob/main/cli/docs/README.es.md)</b>
29
29
 
30
- 适用于 **[Unity MCP](https://github.com/IvanMurzak/Unity-MCP)** 的跨平台 CLI 工具 — 创建项目、安装插件、配置 MCP 工具,并启动带有活跃 MCP 连接的 Unity。一切操作均可通过单一命令行完成。
30
+ 跨平台 CLI 工具,适用于 **[Unity MCP](https://github.com/IvanMurzak/Unity-MCP)** — 创建项目、安装插件、配置 MCP 工具,以及启动带有活跃 MCP 连接的 Unity。所有操作只需一行命令。
31
31
 
32
- ## ![AI Game Developer — Unity MCP](https://github.com/IvanMurzak/Unity-MCP/blob/main/docs/img/promo/hazzard-features.svg?raw=true)
32
+ ## ![AI Game Developer — Unity SKILLS and MCP](https://github.com/IvanMurzak/Unity-MCP/blob/main/docs/img/promo/hazzard-features.svg?raw=true)
33
33
 
34
- - :white_check_mark: **创建项目** — 通过 Unity Editor 快速搭建新 Unity 项目
35
- - :white_check_mark: **安装编辑器** — 从命令行安装任意 Unity Editor 版本
36
- - :white_check_mark: **安装插件** — 将 Unity-MCP 插件连同所有必要的作用域注册表添加到 `manifest.json`
34
+ - :white_check_mark: **创建项目** — 通过 Unity 编辑器搭建新的 Unity 项目
35
+ - :white_check_mark: **安装编辑器** — 从命令行安装任意版本的 Unity 编辑器
36
+ - :white_check_mark: **安装插件** — 将 Unity-MCP 插件连同所有必需的作用域注册表添加到 `manifest.json`
37
37
  - :white_check_mark: **移除插件** — 从 `manifest.json` 中移除 Unity-MCP 插件
38
- - :white_check_mark: **配置** — 启用/禁用 MCP 工具、提示词和资源
38
+ - :white_check_mark: **配置** — 启用/禁用 MCP 工具、提示和资源
39
39
  - :white_check_mark: **运行工具** — 直接从命令行执行 MCP 工具
40
- - :white_check_mark: **设置 MCP** — 为 14 种支持的 AI 代理写入 MCP 配置文件
40
+ - :white_check_mark: **设置 MCP** — 为 14 个受支持的 AI 代理中的任何一个编写 MCP 配置文件
41
41
  - :white_check_mark: **设置技能** — 通过 MCP 服务器为 AI 代理生成技能文件
42
- - :white_check_mark: **打开并连接** — 启动 Unity,可选携带 MCP 环境变量实现自动化服务器连接
42
+ - :white_check_mark: **打开并连接** — 启动 Unity,可选设置 MCP 环境变量以实现自动服务器连接
43
43
  - :white_check_mark: **跨平台** — 支持 Windows、macOS 和 Linux
44
- - :white_check_mark: **CI 友好** — 自动检测非交互式终端,禁用加载动画和颜色输出
45
- - :white_check_mark: **详细模式** — 对任何命令使用 `--verbose` 获取详细诊断输出
46
- - :white_check_mark: **版本感知** — 从不降级插件版本,自动从 OpenUPM 解析最新版本
44
+ - :white_check_mark: **CI 友好** — 自动检测非交互式终端并禁用加载动画/颜色
45
+ - :white_check_mark: **详细模式** — 在任何命令中使用 `--verbose` 获取详细的诊断输出
46
+ - :white_check_mark: **版本感知** — 绝不降级插件版本,从 OpenUPM 解析最新版本
47
47
 
48
- ![AI Game Developer — Unity MCP](https://github.com/IvanMurzak/Unity-MCP/blob/main/docs/img/promo/hazzard-divider.svg?raw=true)
48
+ ![AI Game Developer — Unity SKILLS and MCP](https://github.com/IvanMurzak/Unity-MCP/blob/main/docs/img/promo/hazzard-divider.svg?raw=true)
49
49
 
50
50
  # 快速开始
51
51
 
52
52
  全局安装并运行:
53
53
 
54
54
  ```bash
55
- npm install -g unity-mcp-cli
56
- unity-mcp-cli install-plugin /path/to/unity/project
55
+ # 1.1 Install unity-mcp-cli # ┌────────────────────┐
56
+ npm install -g unity-mcp-cli # │ Available AI agent │
57
+ # ├────────────────────┤
58
+ # 1.2 (Optional) Install Unity # │ antigravity │
59
+ unity-mcp-cli install-unity # │ claude-code │
60
+ # │ claude-desktop │
61
+ # 1.3 (Optional) Create Unity project # │ cline │
62
+ unity-mcp-cli create-project ./MyUnityProject # │ codex │
63
+ # │ cursor │
64
+ # 2. Install "AI Game Developer" in Unity project # │ gemini │
65
+ unity-mcp-cli install-plugin ./MyUnityProject # │ github-copilot-cli │
66
+ # │ kilo-code │
67
+ # 3. Setup Skills for Claude Code # │ open-code │
68
+ unity-mcp-cli setup-skills claude-code ./MyUnityProject # │ rider-junie │
69
+ # │ unity-ai │
70
+ # (Optional) Setup MCP for Claude Code # │ vs-copilot │
71
+ unity-mcp-cli setup-mcp claude-code ./MyUnityProject # │ vscode-copilot │
72
+ # └────────────────────┘
73
+ # (It depends...) Open Unity project
74
+ unity-mcp-cli open ./MyUnityProject
57
75
  ```
58
76
 
59
- 或使用 `npx` 即时运行任意命令,无需全局安装:
77
+ 或使用 `npx` 即时运行任何命令 — 无需全局安装:
60
78
 
61
79
  ```bash
62
80
  npx unity-mcp-cli install-plugin /path/to/unity/project
63
81
  ```
64
82
 
65
- > **环境要求:** [Node.js](https://nodejs.org/) ^20.19.0 || >=22.12.0。若未检测到 [Unity Hub](https://unity.com/download),将自动下载安装。
83
+ > **系统要求:** [Node.js](https://nodejs.org/) ^20.19.0 || >=22.12.0。如果未找到 [Unity Hub](https://unity.com/download),将自动安装。
66
84
 
67
- ![AI Game Developer — Unity MCP](https://github.com/IvanMurzak/Unity-MCP/blob/main/docs/img/promo/hazzard-divider.svg?raw=true)
85
+ ![AI Game Developer — Unity SKILLS and MCP](https://github.com/IvanMurzak/Unity-MCP/blob/main/docs/img/promo/hazzard-divider.svg?raw=true)
68
86
 
69
87
  # 目录
70
88
 
71
- - [快速开始](#快速开始)
72
- - [目录](#目录)
73
- - [命令](#命令)
89
+ - [快速开始](#quick-start)
90
+ - [命令](#commands)
74
91
  - [`configure`](#configure)
75
92
  - [`create-project`](#create-project)
76
93
  - [`install-plugin`](#install-plugin)
@@ -80,21 +97,21 @@ npx unity-mcp-cli install-plugin /path/to/unity/project
80
97
  - [`setup-mcp`](#setup-mcp)
81
98
  - [`setup-skills`](#setup-skills)
82
99
  - [`remove-plugin`](#remove-plugin)
83
- - [全局选项](#全局选项)
84
- - [完整自动化示例](#完整自动化示例)
85
- - [工作原理](#工作原理)
86
- - [确定性端口](#确定性端口)
87
- - [插件安装](#插件安装)
88
- - [配置文件](#配置文件)
89
- - [Unity Hub 集成](#unity-hub-集成)
100
+ - [全局选项](#global-options)
101
+ - [完整自动化示例](#full-automation-example)
102
+ - [工作原理](#how-it-works)
103
+ - [确定性端口](#deterministic-port)
104
+ - [插件安装](#plugin-installation)
105
+ - [配置文件](#configuration-file)
106
+ - [Unity Hub 集成](#unity-hub-integration)
90
107
 
91
- ![AI Game Developer — Unity MCP](https://github.com/IvanMurzak/Unity-MCP/blob/main/docs/img/promo/hazzard-divider.svg?raw=true)
108
+ ![AI Game Developer — Unity SKILLS and MCP](https://github.com/IvanMurzak/Unity-MCP/blob/main/docs/img/promo/hazzard-divider.svg?raw=true)
92
109
 
93
110
  # 命令
94
111
 
95
112
  ## `configure`
96
113
 
97
- 在 `UserSettings/AI-Game-Developer-Config.json` 中配置 MCP 工具、提示词和资源。
114
+ 在 `UserSettings/AI-Game-Developer-Config.json` 中配置 MCP 工具、提示和资源。
98
115
 
99
116
  ```bash
100
117
  unity-mcp-cli configure ./MyGame --list
@@ -102,22 +119,22 @@ unity-mcp-cli configure ./MyGame --list
102
119
 
103
120
  | 选项 | 必需 | 描述 |
104
121
  |---|---|---|
105
- | `[path]` | 是 | Unity 项目的路径(位置参数或 `--path`) |
122
+ | `[path]` | 是 | Unity 项目路径(位置参数或 `--path`) |
106
123
  | `--list` | 否 | 列出当前配置并退出 |
107
124
  | `--enable-tools <names>` | 否 | 启用指定工具(逗号分隔) |
108
125
  | `--disable-tools <names>` | 否 | 禁用指定工具(逗号分隔) |
109
126
  | `--enable-all-tools` | 否 | 启用所有工具 |
110
127
  | `--disable-all-tools` | 否 | 禁用所有工具 |
111
- | `--enable-prompts <names>` | 否 | 启用指定提示词(逗号分隔) |
112
- | `--disable-prompts <names>` | 否 | 禁用指定提示词(逗号分隔) |
113
- | `--enable-all-prompts` | 否 | 启用所有提示词 |
114
- | `--disable-all-prompts` | 否 | 禁用所有提示词 |
128
+ | `--enable-prompts <names>` | 否 | 启用指定提示(逗号分隔) |
129
+ | `--disable-prompts <names>` | 否 | 禁用指定提示(逗号分隔) |
130
+ | `--enable-all-prompts` | 否 | 启用所有提示 |
131
+ | `--disable-all-prompts` | 否 | 禁用所有提示 |
115
132
  | `--enable-resources <names>` | 否 | 启用指定资源(逗号分隔) |
116
133
  | `--disable-resources <names>` | 否 | 禁用指定资源(逗号分隔) |
117
134
  | `--enable-all-resources` | 否 | 启用所有资源 |
118
135
  | `--disable-all-resources` | 否 | 禁用所有资源 |
119
136
 
120
- **示例 — 启用指定工具并禁用所有提示词:**
137
+ **示例 — 启用指定工具并禁用所有提示:**
121
138
 
122
139
  ```bash
123
140
  unity-mcp-cli configure ./MyGame \
@@ -125,7 +142,7 @@ unity-mcp-cli configure ./MyGame \
125
142
  --disable-all-prompts
126
143
  ```
127
144
 
128
- **示例 — 启用所有功能:**
145
+ **示例 — 启用全部:**
129
146
 
130
147
  ```bash
131
148
  unity-mcp-cli configure ./MyGame \
@@ -134,11 +151,11 @@ unity-mcp-cli configure ./MyGame \
134
151
  --enable-all-resources
135
152
  ```
136
153
 
137
- ![AI Game Developer — Unity MCP](https://github.com/IvanMurzak/Unity-MCP/blob/main/docs/img/promo/hazzard-divider.svg?raw=true)
154
+ ![AI Game Developer — Unity SKILLS and MCP](https://github.com/IvanMurzak/Unity-MCP/blob/main/docs/img/promo/hazzard-divider.svg?raw=true)
138
155
 
139
156
  ## `create-project`
140
157
 
141
- 使用 Unity Editor 创建新的 Unity 项目。
158
+ 使用 Unity 编辑器创建新的 Unity 项目。
142
159
 
143
160
  ```bash
144
161
  unity-mcp-cli create-project /path/to/new/project
@@ -146,8 +163,8 @@ unity-mcp-cli create-project /path/to/new/project
146
163
 
147
164
  | 选项 | 必需 | 描述 |
148
165
  |---|---|---|
149
- | `[path]` | 是 | 项目将被创建的路径(位置参数或 `--path`) |
150
- | `--unity <version>` | 否 | 要使用的 Unity Editor 版本(默认为已安装的最高版本) |
166
+ | `[path]` | 是 | 项目创建路径(位置参数或 `--path`) |
167
+ | `--unity <version>` | 否 | 使用的 Unity 编辑器版本(默认为已安装的最高版本) |
151
168
 
152
169
  **示例 — 使用指定编辑器版本创建项目:**
153
170
 
@@ -155,7 +172,7 @@ unity-mcp-cli create-project /path/to/new/project
155
172
  unity-mcp-cli create-project ./MyGame --unity 2022.3.62f1
156
173
  ```
157
174
 
158
- ![AI Game Developer — Unity MCP](https://github.com/IvanMurzak/Unity-MCP/blob/main/docs/img/promo/hazzard-divider.svg?raw=true)
175
+ ![AI Game Developer — Unity SKILLS and MCP](https://github.com/IvanMurzak/Unity-MCP/blob/main/docs/img/promo/hazzard-divider.svg?raw=true)
159
176
 
160
177
  ## `install-plugin`
161
178
 
@@ -167,27 +184,27 @@ unity-mcp-cli install-plugin ./MyGame
167
184
 
168
185
  | 选项 | 必需 | 描述 |
169
186
  |---|---|---|
170
- | `[path]` | 是 | Unity 项目的路径(位置参数或 `--path`) |
171
- | `--plugin-version <version>` | 否 | 要安装的插件版本(默认为来自 [OpenUPM](https://openupm.com/packages/com.ivanmurzak.unity.mcp/) 的最新版本) |
187
+ | `[path]` | 是 | Unity 项目路径(位置参数或 `--path`) |
188
+ | `--plugin-version <version>` | 否 | 要安装的插件版本(默认为 [OpenUPM](https://openupm.com/packages/com.ivanmurzak.unity.mcp/) 上的最新版本) |
172
189
 
173
- 此命令将:
174
- 1. 添加 **OpenUPM 作用域注册表**及所有必要的作用域
190
+ 该命令将:
191
+ 1. 添加 **OpenUPM 作用域注册表**及所有必需的作用域
175
192
  2. 将 `com.ivanmurzak.unity.mcp` 添加到 `dependencies`
176
- 3. **从不降级** — 若已安装更高版本,则保留现有版本
193
+ 3. **绝不降级** — 如果已安装更高版本,将保留现有版本
177
194
 
178
- **示例 — 安装指定插件版本:**
195
+ **示例 — 安装指定的插件版本:**
179
196
 
180
197
  ```bash
181
198
  unity-mcp-cli install-plugin ./MyGame --plugin-version 0.51.6
182
199
  ```
183
200
 
184
- > 运行此命令后,请在 Unity Editor 中打开项目以完成包安装。
201
+ > 运行此命令后,请在 Unity 编辑器中打开项目以完成包安装。
185
202
 
186
- ![AI Game Developer — Unity MCP](https://github.com/IvanMurzak/Unity-MCP/blob/main/docs/img/promo/hazzard-divider.svg?raw=true)
203
+ ![AI Game Developer — Unity SKILLS and MCP](https://github.com/IvanMurzak/Unity-MCP/blob/main/docs/img/promo/hazzard-divider.svg?raw=true)
187
204
 
188
205
  ## `install-unity`
189
206
 
190
- 通过 Unity Hub CLI 安装指定版本的 Unity Editor。
207
+ 通过 Unity Hub CLI 安装 Unity 编辑器版本。
191
208
 
192
209
  ```bash
193
210
  unity-mcp-cli install-unity 6000.3.1f1
@@ -195,10 +212,10 @@ unity-mcp-cli install-unity 6000.3.1f1
195
212
 
196
213
  | 参数 / 选项 | 必需 | 描述 |
197
214
  |---|---|---|
198
- | `[version]` | 否 | 要安装的 Unity Editor 版本(例如 `6000.3.1f1`) |
215
+ | `[version]` | 否 | 要安装的 Unity 编辑器版本(例如 `6000.3.1f1`) |
199
216
  | `--path <path>` | 否 | 从现有项目中读取所需版本 |
200
217
 
201
- 若参数和选项均未提供,命令将从 Unity Hub 发布列表中安装最新稳定版本。
218
+ 如果既未提供参数也未提供选项,该命令将从 Unity Hub 的发行列表中安装最新的稳定版本。
202
219
 
203
220
  **示例 — 安装项目所需的编辑器版本:**
204
221
 
@@ -206,11 +223,11 @@ unity-mcp-cli install-unity 6000.3.1f1
206
223
  unity-mcp-cli install-unity --path ./MyGame
207
224
  ```
208
225
 
209
- ![AI Game Developer — Unity MCP](https://github.com/IvanMurzak/Unity-MCP/blob/main/docs/img/promo/hazzard-divider.svg?raw=true)
226
+ ![AI Game Developer — Unity SKILLS and MCP](https://github.com/IvanMurzak/Unity-MCP/blob/main/docs/img/promo/hazzard-divider.svg?raw=true)
210
227
 
211
228
  ## `open`
212
229
 
213
- 在 Unity Editor 中打开 Unity 项目。默认情况下,若提供了连接选项,将设置 MCP 连接环境变量。使用 `--no-connect` 可在不建立 MCP 连接的情况下打开项目。
230
+ 在 Unity 编辑器中打开 Unity 项目。默认情况下,如果提供了连接选项,将设置 MCP 连接环境变量。使用 `--no-connect` 可在不建立 MCP 连接的情况下打开。
214
231
 
215
232
  ```bash
216
233
  unity-mcp-cli open ./MyGame
@@ -218,20 +235,20 @@ unity-mcp-cli open ./MyGame
218
235
 
219
236
  | 选项 | 环境变量 | 必需 | 描述 |
220
237
  |---|---|---|---|
221
- | `[path]` | — | 是 | Unity 项目的路径(位置参数或 `--path`) |
222
- | `--unity <version>` | — | 否 | 要使用的特定 Unity Editor 版本(默认为项目设置中的版本,回退为已安装的最高版本) |
223
- | `--no-connect` | — | 否 | 不携带 MCP 连接环境变量打开项目 |
238
+ | `[path]` | — | 是 | Unity 项目路径(位置参数或 `--path`) |
239
+ | `--unity <version>` | — | 否 | 使用指定的 Unity 编辑器版本(默认为项目设置中的版本,回退到已安装的最高版本) |
240
+ | `--no-connect` | — | 否 | 不设置 MCP 连接环境变量直接打开 |
224
241
  | `--url <url>` | `UNITY_MCP_HOST` | 否 | 要连接的 MCP 服务器 URL |
225
- | `--keep-connected` | `UNITY_MCP_KEEP_CONNECTED` | 否 | 强制保持连接 |
226
- | `--token <token>` | `UNITY_MCP_TOKEN` | 否 | 身份验证令牌 |
242
+ | `--keep-connected` | `UNITY_MCP_KEEP_CONNECTED` | 否 | 强制保持连接活跃 |
243
+ | `--token <token>` | `UNITY_MCP_TOKEN` | 否 | 认证令牌 |
227
244
  | `--auth <option>` | `UNITY_MCP_AUTH_OPTION` | 否 | 认证模式:`none` 或 `required` |
228
245
  | `--tools <names>` | `UNITY_MCP_TOOLS` | 否 | 要启用的工具列表(逗号分隔) |
229
246
  | `--transport <method>` | `UNITY_MCP_TRANSPORT` | 否 | 传输方式:`streamableHttp` 或 `stdio` |
230
- | `--start-server <value>` | `UNITY_MCP_START_SERVER` | 否 | 设置为 `true` 或 `false` 以控制 MCP 服务器的自动启动 |
247
+ | `--start-server <value>` | `UNITY_MCP_START_SERVER` | 否 | 设置为 `true` 或 `false` 以控制 MCP 服务器自动启动 |
231
248
 
232
- 编辑器进程以分离模式启动 — CLI 会立即返回。
249
+ 编辑器进程以分离模式启动 — CLI 将立即返回。
233
250
 
234
- **示例 — 携带 MCP 连接打开:**
251
+ **示例 — 使用 MCP 连接打开:**
235
252
 
236
253
  ```bash
237
254
  unity-mcp-cli open ./MyGame \
@@ -239,13 +256,13 @@ unity-mcp-cli open ./MyGame \
239
256
  --keep-connected
240
257
  ```
241
258
 
242
- **示例 — 不携带 MCP 连接打开(简单打开):**
259
+ **示例 — 不使用 MCP 连接打开(简单打开):**
243
260
 
244
261
  ```bash
245
262
  unity-mcp-cli open ./MyGame --no-connect
246
263
  ```
247
264
 
248
- **示例 — 携带身份验证和指定工具打开:**
265
+ **示例 — 使用认证和指定工具打开:**
249
266
 
250
267
  ```bash
251
268
  unity-mcp-cli open ./MyGame \
@@ -255,11 +272,11 @@ unity-mcp-cli open ./MyGame \
255
272
  --tools gameobject-create,gameobject-find
256
273
  ```
257
274
 
258
- ![AI Game Developer — Unity MCP](https://github.com/IvanMurzak/Unity-MCP/blob/main/docs/img/promo/hazzard-divider.svg?raw=true)
275
+ ![AI Game Developer — Unity SKILLS and MCP](https://github.com/IvanMurzak/Unity-MCP/blob/main/docs/img/promo/hazzard-divider.svg?raw=true)
259
276
 
260
277
  ## `run-tool`
261
278
 
262
- 通过 HTTP API 直接执行 MCP 工具。服务器 URL 和授权令牌会根据当前连接模式(自定义或云端),从项目配置文件(`UserSettings/AI-Game-Developer-Config.json`)中**自动解析**。
279
+ 通过 HTTP API 直接执行 MCP 工具。服务器 URL 和授权令牌会根据当前连接模式(自定义或云端)从项目的配置文件(`UserSettings/AI-Game-Developer-Config.json`)中**自动解析**。
263
280
 
264
281
  ```bash
265
282
  unity-mcp-cli run-tool gameobject-create ./MyGame --input '{"name":"Cube"}'
@@ -269,43 +286,43 @@ unity-mcp-cli run-tool gameobject-create ./MyGame --input '{"name":"Cube"}'
269
286
  |---|---|---|
270
287
  | `<tool-name>` | 是 | 要执行的 MCP 工具名称 |
271
288
  | `[path]` | 否 | Unity 项目路径(位置参数或 `--path`)— 用于读取配置和检测端口 |
272
- | `--url <url>` | 否 | 直接指定服务器 URL(跳过配置) |
273
- | `--token <token>` | 否 | Bearer 令牌覆盖(跳过配置) |
289
+ | `--url <url>` | 否 | 直接覆盖服务器 URL(绕过配置) |
290
+ | `--token <token>` | 否 | 覆盖 Bearer 令牌(绕过配置) |
274
291
  | `--input <json>` | 否 | 工具参数的 JSON 字符串(默认为 `{}`) |
275
- | `--input-file <file>` | 否 | 从文件中读取 JSON 参数 |
292
+ | `--input-file <file>` | 否 | 从文件读取 JSON 参数 |
276
293
  | `--raw` | 否 | 输出原始 JSON(无格式化、无加载动画) |
277
- | `--timeout <ms>` | 否 | 请求超时时间(毫秒,默认:60000) |
294
+ | `--timeout <ms>` | 否 | 请求超时时间(毫秒)(默认:60000) |
278
295
 
279
296
  **URL 解析优先级:**
280
297
  1. `--url` → 直接使用
281
- 2. 配置文件 → `host`(自定义模式)或硬编码的云端点(云端模式)
298
+ 2. 配置文件 → `host`(自定义模式)或硬编码的云端端点(云端模式)
282
299
  3. 根据项目路径生成的确定性端口
283
300
 
284
- **授权**会从项目配置中自动读取(自定义模式使用 `token`,云端模式使用 `cloudToken`)。使用 `--token` 可显式覆盖从配置派生的令牌。
301
+ **授权信息**会自动从项目配置中读取(自定义模式下为 `token`,云端模式下为 `cloudToken`)。使用 `--token` 可显式覆盖从配置中获取的令牌。
285
302
 
286
- **示例 — 调用工具(URL 和授权来自配置):**
303
+ **示例 — 调用工具(URL 和认证来自配置):**
287
304
 
288
305
  ```bash
289
306
  unity-mcp-cli run-tool gameobject-find ./MyGame --input '{"query":"Player"}'
290
307
  ```
291
308
 
292
- **示例 — 显式指定 URL:**
309
+ **示例 — 显式覆盖 URL:**
293
310
 
294
311
  ```bash
295
312
  unity-mcp-cli run-tool scene-save --url http://localhost:8080
296
313
  ```
297
314
 
298
- **示例 — 管道传输原始 JSON 输出:**
315
+ **示例 — 管道输出原始 JSON:**
299
316
 
300
317
  ```bash
301
318
  unity-mcp-cli run-tool assets-list ./MyGame --raw | jq '.results'
302
319
  ```
303
320
 
304
- ![AI Game Developer — Unity MCP](https://github.com/IvanMurzak/Unity-MCP/blob/main/docs/img/promo/hazzard-divider.svg?raw=true)
321
+ ![AI Game Developer — Unity SKILLS and MCP](https://github.com/IvanMurzak/Unity-MCP/blob/main/docs/img/promo/hazzard-divider.svg?raw=true)
305
322
 
306
323
  ## `setup-mcp`
307
324
 
308
- 为 AI 代理写入 MCP 配置文件,支持在无 Unity Editor UI 的情况下进行无头/CI 设置。支持全部 14 种代理(Claude Code、Cursor、Gemini、Codex 等)。
325
+ 为 AI 代理编写 MCP 配置文件,支持无界面/CI 环境设置,无需 Unity 编辑器 UI。支持全部 14 个代理(Claude Code、Cursor、Gemini、Codex 等)。
309
326
 
310
327
  ```bash
311
328
  unity-mcp-cli setup-mcp claude-code ./MyGame
@@ -316,8 +333,8 @@ unity-mcp-cli setup-mcp claude-code ./MyGame
316
333
  | `[agent-id]` | 是 | 要配置的代理(使用 `--list` 查看全部) |
317
334
  | `[path]` | 否 | Unity 项目路径(默认为当前目录) |
318
335
  | `--transport <transport>` | 否 | 传输方式:`stdio` 或 `http`(默认:`http`) |
319
- | `--url <url>` | 否 | 服务器 URL 覆盖(用于 http 传输) |
320
- | `--token <token>` | 否 | 授权令牌覆盖 |
336
+ | `--url <url>` | 否 | 覆盖服务器 URL(用于 http 传输) |
337
+ | `--token <token>` | 否 | 覆盖认证令牌 |
321
338
  | `--list` | 否 | 列出所有可用的代理 ID |
322
339
 
323
340
  **示例 — 列出所有支持的代理:**
@@ -326,17 +343,17 @@ unity-mcp-cli setup-mcp claude-code ./MyGame
326
343
  unity-mcp-cli setup-mcp --list
327
344
  ```
328
345
 
329
- **示例 — 使用 stdio 传输方式配置 Cursor:**
346
+ **示例 — 使用 stdio 传输配置 Cursor:**
330
347
 
331
348
  ```bash
332
349
  unity-mcp-cli setup-mcp cursor ./MyGame --transport stdio
333
350
  ```
334
351
 
335
- ![AI Game Developer — Unity MCP](https://github.com/IvanMurzak/Unity-MCP/blob/main/docs/img/promo/hazzard-divider.svg?raw=true)
352
+ ![AI Game Developer — Unity SKILLS and MCP](https://github.com/IvanMurzak/Unity-MCP/blob/main/docs/img/promo/hazzard-divider.svg?raw=true)
336
353
 
337
354
  ## `setup-skills`
338
355
 
339
- 通过调用 MCP 服务器的系统工具 API 为 AI 代理生成技能文件。需要 Unity Editor 正在运行且已安装 MCP 插件。
356
+ 通过调用 MCP 服务器的系统工具 API 为 AI 代理生成技能文件。需要 Unity 编辑器正在运行且已安装 MCP 插件。
340
357
 
341
358
  ```bash
342
359
  unity-mcp-cli setup-skills claude-code ./MyGame
@@ -346,10 +363,10 @@ unity-mcp-cli setup-skills claude-code ./MyGame
346
363
  |---|---|---|
347
364
  | `[agent-id]` | 是 | 要生成技能的代理(使用 `--list` 查看全部) |
348
365
  | `[path]` | 否 | Unity 项目路径(默认为当前目录) |
349
- | `--url <url>` | 否 | 服务器 URL 覆盖 |
350
- | `--token <token>` | 否 | 授权令牌覆盖 |
366
+ | `--url <url>` | 否 | 覆盖服务器 URL |
367
+ | `--token <token>` | 否 | 覆盖认证令牌 |
351
368
  | `--list` | 否 | 列出所有代理及其技能支持状态 |
352
- | `--timeout <ms>` | 否 | 请求超时时间(毫秒,默认:60000) |
369
+ | `--timeout <ms>` | 否 | 请求超时时间(毫秒)(默认:60000) |
353
370
 
354
371
  **示例 — 列出支持技能的代理:**
355
372
 
@@ -357,7 +374,7 @@ unity-mcp-cli setup-skills claude-code ./MyGame
357
374
  unity-mcp-cli setup-skills --list
358
375
  ```
359
376
 
360
- ![AI Game Developer — Unity MCP](https://github.com/IvanMurzak/Unity-MCP/blob/main/docs/img/promo/hazzard-divider.svg?raw=true)
377
+ ![AI Game Developer — Unity SKILLS and MCP](https://github.com/IvanMurzak/Unity-MCP/blob/main/docs/img/promo/hazzard-divider.svg?raw=true)
361
378
 
362
379
  ## `remove-plugin`
363
380
 
@@ -369,16 +386,16 @@ unity-mcp-cli remove-plugin ./MyGame
369
386
 
370
387
  | 选项 | 必需 | 描述 |
371
388
  |---|---|---|
372
- | `[path]` | 是 | Unity 项目的路径(位置参数或 `--path`) |
389
+ | `[path]` | 是 | Unity 项目路径(位置参数或 `--path`) |
373
390
 
374
- 此命令将:
391
+ 该命令将:
375
392
  1. 从 `dependencies` 中移除 `com.ivanmurzak.unity.mcp`
376
393
  2. **保留作用域注册表和作用域** — 其他包可能依赖它们
377
- 3. 若插件未安装,则**不执行任何操作**
394
+ 3. 如果插件未安装则**不执行任何操作**
378
395
 
379
- > 运行此命令后,请在 Unity Editor 中打开项目以应用更改。
396
+ > 运行此命令后,请在 Unity 编辑器中打开项目以应用更改。
380
397
 
381
- ![AI Game Developer — Unity MCP](https://github.com/IvanMurzak/Unity-MCP/blob/main/docs/img/promo/hazzard-divider.svg?raw=true)
398
+ ![AI Game Developer — Unity SKILLS and MCP](https://github.com/IvanMurzak/Unity-MCP/blob/main/docs/img/promo/hazzard-divider.svg?raw=true)
382
399
 
383
400
  ## 全局选项
384
401
 
@@ -386,71 +403,74 @@ unity-mcp-cli remove-plugin ./MyGame
386
403
 
387
404
  | 选项 | 描述 |
388
405
  |---|---|
389
- | `-v, --verbose` | 启用详细诊断输出,用于故障排查 |
406
+ | `-v, --verbose` | 启用详细的诊断输出以进行故障排查 |
390
407
  | `--version` | 显示 CLI 版本 |
391
408
  | `--help` | 显示命令帮助信息 |
392
409
 
393
- **示例 — 以详细输出运行任意命令:**
410
+ **示例 — 以详细模式运行任何命令:**
394
411
 
395
412
  ```bash
396
413
  unity-mcp-cli install-plugin ./MyGame --verbose
397
414
  ```
398
415
 
399
- ![AI Game Developer — Unity MCP](https://github.com/IvanMurzak/Unity-MCP/blob/main/docs/img/promo/hazzard-divider.svg?raw=true)
416
+ ![AI Game Developer — Unity SKILLS and MCP](https://github.com/IvanMurzak/Unity-MCP/blob/main/docs/img/promo/hazzard-divider.svg?raw=true)
400
417
 
401
418
  # 完整自动化示例
402
419
 
403
- 通过一个脚本从零搭建完整的 Unity MCP 项目:
420
+ 使用一个脚本从零开始搭建完整的 Unity MCP 项目:
404
421
 
405
422
  ```bash
406
- # 1. 创建新的 Unity 项目
423
+ # 1. Create a new Unity project
407
424
  unity-mcp-cli create-project ./MyAIGame --unity 6000.3.1f1
408
425
 
409
- # 2. 安装 Unity-MCP 插件
426
+ # 2. Install the Unity-MCP plugin
410
427
  unity-mcp-cli install-plugin ./MyAIGame
411
428
 
412
- # 3. 启用所有 MCP 工具
429
+ # 3. Enable all MCP tools
413
430
  unity-mcp-cli configure ./MyAIGame --enable-all-tools
414
431
 
415
- # 4. 配置 Claude Code MCP 集成
432
+ # 4. Setup Skills for Claude Code (requires Unity Editor running)
433
+ unity-mcp-cli setup-skills claude-code ./MyAIGame
434
+
435
+ # 5. Configure Claude Code MCP integration
416
436
  unity-mcp-cli setup-mcp claude-code ./MyAIGame
417
437
 
418
- # 5. 打开项目并建立 MCP 连接
438
+ # 6. Open the project with MCP connection
419
439
  unity-mcp-cli open ./MyAIGame \
420
440
  --url http://localhost:8080 \
421
441
  --keep-connected
422
442
  ```
423
443
 
424
- ![AI Game Developer — Unity MCP](https://github.com/IvanMurzak/Unity-MCP/blob/main/docs/img/promo/hazzard-divider.svg?raw=true)
444
+ ![AI Game Developer — Unity SKILLS and MCP](https://github.com/IvanMurzak/Unity-MCP/blob/main/docs/img/promo/hazzard-divider.svg?raw=true)
425
445
 
426
446
  # 工作原理
427
447
 
428
448
  ### 确定性端口
429
449
 
430
- CLI 根据 Unity 项目的目录路径生成**确定性端口**(SHA256 哈希值映射到端口范围 20000-29999)。该端口生成机制与 Unity 插件中的实现完全一致,确保服务器与插件无需手动配置即可自动协商使用同一端口。
450
+ CLI 根据 Unity 项目的目录路径生成**确定性端口**(SHA256 哈希映射到端口范围 20000-29999)。这与 Unity 插件中的端口生成方式一致,确保服务器和插件自动使用相同的端口,无需手动配置。
431
451
 
432
452
  ### 插件安装
433
453
 
434
454
  `install-plugin` 命令直接修改 `Packages/manifest.json`:
435
455
  - 添加 [OpenUPM](https://openupm.com/) 作用域注册表(`package.openupm.com`)
436
- - 注册所有必要的作用域(`com.ivanmurzak`、`extensions.unity`、`org.nuget.*`)
437
- - 以版本感知的方式添加 `com.ivanmurzak.unity.mcp` 依赖(从不降级)
456
+ - 注册所有必需的作用域(`com.ivanmurzak`、`extensions.unity`、`org.nuget.*`)
457
+ - 添加 `com.ivanmurzak.unity.mcp` 依赖项,支持版本感知更新(绝不降级)
438
458
 
439
459
  ### 配置文件
440
460
 
441
461
  `configure` 命令读写 `UserSettings/AI-Game-Developer-Config.json`,该文件控制:
442
- - **工具** — AI 代理可用的 MCP 工具
443
- - **提示词** — 注入到 LLM 对话中的预定义提示词
444
- - **资源** — 暴露给 AI 代理的只读数据
445
- - **连接设置** — 主机 URL、认证令牌、传输方式、超时配置
462
+ - **工具** — 可供 AI 代理使用的 MCP 工具
463
+ - **提示** — 注入 LLM 对话中的预定义提示
464
+ - **资源** — 向 AI 代理公开的只读数据
465
+ - **连接设置** — 主机 URL、认证令牌、传输方式、超时时间
446
466
 
447
467
  ### Unity Hub 集成
448
468
 
449
- 管理编辑器或创建项目的命令使用 **Unity Hub CLI**(`--headless` 模式)。若未安装 Unity Hub,CLI 将**自动下载并安装**:
469
+ 管理编辑器或创建项目的命令使用 **Unity Hub CLI**(`--headless` 模式)。如果未安装 Unity Hub,CLI 将**自动下载并安装**:
450
470
  - **Windows** — 通过 `UnityHubSetup.exe /S` 静默安装(可能需要管理员权限)
451
471
  - **macOS** — 下载 DMG,挂载后将 `Unity Hub.app` 复制到 `/Applications`
452
472
  - **Linux** — 将 `UnityHub.AppImage` 下载到 `~/Applications/`
453
473
 
454
- > 完整的 Unity-MCP 项目文档请参阅[主 README](https://github.com/IvanMurzak/Unity-MCP/blob/main/README.md)。
474
+ > 如需完整的 Unity-MCP 项目文档,请参阅[主 README](https://github.com/IvanMurzak/Unity-MCP/blob/main/README.md)。
455
475
 
456
- ![AI Game Developer — Unity MCP](https://github.com/IvanMurzak/Unity-MCP/blob/main/docs/img/promo/hazzard-divider.svg?raw=true)
476
+ ![AI Game Developer — Unity SKILLS and MCP](https://github.com/IvanMurzak/Unity-MCP/blob/main/docs/img/promo/hazzard-divider.svg?raw=true)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "unity-mcp-cli",
3
- "version": "0.57.0",
3
+ "version": "0.57.2",
4
4
  "description": "Cross-platform CLI tool for AI Game Developer (Skills & MCP). Full AI develop and test loop. Efficient token usage, advanced tools. Creates Unity project, installs plugins, configures tools, and manages HTTP connection with Unity Editor and a game made with Unity. Works with Claude Code, Gemini, Copilot, Cursor and any other absolutely for free.",
5
5
  "type": "module",
6
6
  "main": "dist/index.js",