unity-mcp-cli 0.54.0 → 0.55.0

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.
@@ -8,6 +8,21 @@
8
8
 
9
9
  <img src="https://github.com/IvanMurzak/Unity-MCP/raw/main/docs/img/promo/ai-developer-banner-glitch.gif" alt="AI Game Developer" title="Unity MCP CLI" width="100%">
10
10
 
11
+ <p>
12
+ <a href="https://claude.ai/download"><img src="https://github.com/IvanMurzak/Unity-MCP/raw/main/docs/img/mcp-clients/claude-64.png" alt="Claude" title="Claude" height="36"></a>&nbsp;&nbsp;
13
+ <a href="https://openai.com/index/introducing-codex/"><img src="https://github.com/IvanMurzak/Unity-MCP/raw/main/docs/img/mcp-clients/codex-64.png" alt="Codex" title="Codex" height="36"></a>&nbsp;&nbsp;
14
+ <a href="https://www.cursor.com/"><img src="https://github.com/IvanMurzak/Unity-MCP/raw/main/docs/img/mcp-clients/cursor-64.png" alt="Cursor" title="Cursor" height="36"></a>&nbsp;&nbsp;
15
+ <a href="https://code.visualstudio.com/docs/copilot/overview"><img src="https://github.com/IvanMurzak/Unity-MCP/raw/main/docs/img/mcp-clients/github-copilot-64.png" alt="GitHub Copilot" title="GitHub Copilot" height="36"></a>&nbsp;&nbsp;
16
+ <a href="https://gemini.google.com/"><img src="https://github.com/IvanMurzak/Unity-MCP/raw/main/docs/img/mcp-clients/gemini-64.png" alt="Gemini" title="Gemini" height="36"></a>&nbsp;&nbsp;
17
+ <a href="https://antigravity.google/"><img src="https://github.com/IvanMurzak/Unity-MCP/raw/main/docs/img/mcp-clients/antigravity-64.png" alt="Antigravity" title="Antigravity" height="36"></a>&nbsp;&nbsp;
18
+ <a href="https://code.visualstudio.com/"><img src="https://github.com/IvanMurzak/Unity-MCP/raw/main/docs/img/mcp-clients/vs-code-64.png" alt="VS Code" title="VS Code" height="36"></a>&nbsp;&nbsp;
19
+ <a href="https://www.jetbrains.com/rider/"><img src="https://github.com/IvanMurzak/Unity-MCP/raw/main/docs/img/mcp-clients/rider-64.png" alt="Rider" title="Rider" height="36"></a>&nbsp;&nbsp;
20
+ <a href="https://visualstudio.microsoft.com/"><img src="https://github.com/IvanMurzak/Unity-MCP/raw/main/docs/img/mcp-clients/visual-studio-64.png" alt="Visual Studio" title="Visual Studio" height="36"></a>&nbsp;&nbsp;
21
+ <a href="https://github.com/anthropics/claude-code"><img src="https://github.com/IvanMurzak/Unity-MCP/raw/main/docs/img/mcp-clients/open-code-64.png" alt="Open Code" title="Open Code" height="36"></a>&nbsp;&nbsp;
22
+ <a href="https://github.com/cline/cline"><img src="https://github.com/IvanMurzak/Unity-MCP/raw/main/docs/img/mcp-clients/cline-64.png" alt="Cline" title="Cline" height="36"></a>&nbsp;&nbsp;
23
+ <a href="https://github.com/kilocode/kilo-code"><img src="https://github.com/IvanMurzak/Unity-MCP/raw/main/docs/img/mcp-clients/kilo-code-64.png" alt="Kilo Code" title="Kilo Code" height="36"></a>
24
+ </p>
25
+
11
26
  </div>
12
27
 
13
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>
@@ -50,13 +65,13 @@ unity-mcp-cli install-plugin /path/to/unity/project
50
65
 
51
66
  - [快速开始](#快速开始)
52
67
  - [命令](#命令)
68
+ - [`configure`](#configure) — 配置 MCP 工具、提示词和资源
69
+ - [`connect`](#connect) — 启动 Unity 并建立 MCP 连接
53
70
  - [`create-project`](#create-project) — 创建新 Unity 项目
71
+ - [`install-plugin`](#install-plugin) — 将 Unity-MCP 插件安装到项目中
54
72
  - [`install-unity`](#install-unity) — 通过 Unity Hub 安装 Unity Editor
55
73
  - [`open`](#open) — 在编辑器中打开 Unity 项目
56
- - [`install-plugin`](#install-plugin) — 将 Unity-MCP 插件安装到项目中
57
74
  - [`remove-plugin`](#remove-plugin) — 从项目中移除 Unity-MCP 插件
58
- - [`configure`](#configure) — 配置 MCP 工具、提示词和资源
59
- - [`connect`](#connect) — 启动 Unity 并建立 MCP 连接
60
75
  - [完整自动化示例](#完整自动化示例)
61
76
  - [工作原理](#工作原理)
62
77
 
@@ -64,116 +79,6 @@ unity-mcp-cli install-plugin /path/to/unity/project
64
79
 
65
80
  # 命令
66
81
 
67
- ## `create-project`
68
-
69
- 使用 Unity Editor 创建新的 Unity 项目。
70
-
71
- ```bash
72
- npx unity-mcp-cli create-project /path/to/new/project
73
- ```
74
-
75
- | 选项 | 必需 | 描述 |
76
- |---|---|---|
77
- | `[path]` | 是 | 项目将被创建的路径(位置参数或 `--path`) |
78
- | `--unity <version>` | 否 | 要使用的 Unity Editor 版本(默认为已安装的最高版本) |
79
-
80
- **示例 — 使用指定编辑器版本创建项目:**
81
-
82
- ```bash
83
- npx unity-mcp-cli create-project ./MyGame --unity 2022.3.62f1
84
- ```
85
-
86
- ![AI Game Developer — Unity MCP](https://github.com/IvanMurzak/Unity-MCP/blob/main/docs/img/promo/hazzard-divider.svg?raw=true)
87
-
88
- ## `install-unity`
89
-
90
- 通过 Unity Hub CLI 安装指定版本的 Unity Editor。
91
-
92
- ```bash
93
- npx unity-mcp-cli install-unity 6000.3.1f1
94
- ```
95
-
96
- | 参数 / 选项 | 必需 | 描述 |
97
- |---|---|---|
98
- | `[version]` | 否 | 要安装的 Unity Editor 版本(例如 `6000.3.1f1`) |
99
- | `--path <path>` | 否 | 从现有项目中读取所需版本 |
100
-
101
- 若参数和选项均未提供,命令将从 Unity Hub 发布列表中安装最新稳定版本。
102
-
103
- **示例 — 安装项目所需的编辑器版本:**
104
-
105
- ```bash
106
- npx unity-mcp-cli install-unity --path ./MyGame
107
- ```
108
-
109
- ![AI Game Developer — Unity MCP](https://github.com/IvanMurzak/Unity-MCP/blob/main/docs/img/promo/hazzard-divider.svg?raw=true)
110
-
111
- ## `open`
112
-
113
- 在 Unity Editor 中打开 Unity 项目。
114
-
115
- ```bash
116
- npx unity-mcp-cli open ./MyGame
117
- ```
118
-
119
- | 选项 | 必需 | 描述 |
120
- |---|---|---|
121
- | `[path]` | 是 | Unity 项目的路径(位置参数或 `--path`) |
122
- | `--unity <version>` | 否 | 要使用的特定 Unity Editor 版本(默认为项目设置中的版本,回退为已安装的最高版本) |
123
-
124
- 编辑器进程以分离模式启动 — CLI 会立即返回。
125
-
126
- ![AI Game Developer — Unity MCP](https://github.com/IvanMurzak/Unity-MCP/blob/main/docs/img/promo/hazzard-divider.svg?raw=true)
127
-
128
- ## `install-plugin`
129
-
130
- 将 Unity-MCP 插件安装到 Unity 项目的 `Packages/manifest.json` 中。
131
-
132
- ```bash
133
- npx unity-mcp-cli install-plugin ./MyGame
134
- ```
135
-
136
- | 选项 | 必需 | 描述 |
137
- |---|---|---|
138
- | `[path]` | 是 | Unity 项目的路径(位置参数或 `--path`) |
139
- | `--plugin-version <version>` | 否 | 要安装的插件版本(默认为来自 [OpenUPM](https://openupm.com/packages/com.ivanmurzak.unity.mcp/) 的最新版本) |
140
-
141
- 此命令将:
142
- 1. 添加 **OpenUPM 作用域注册表**及所有必要的作用域
143
- 2. 将 `com.ivanmurzak.unity.mcp` 添加到 `dependencies`
144
- 3. **从不降级** — 若已安装更高版本,则保留现有版本
145
-
146
- **示例 — 安装指定插件版本:**
147
-
148
- ```bash
149
- npx unity-mcp-cli install-plugin ./MyGame --plugin-version 0.52.0
150
- ```
151
-
152
- > 运行此命令后,请在 Unity Editor 中打开项目以完成包安装。
153
-
154
- ![AI Game Developer — Unity MCP](https://github.com/IvanMurzak/Unity-MCP/blob/main/docs/img/promo/hazzard-divider.svg?raw=true)
155
-
156
- ## `remove-plugin`
157
-
158
- 从 Unity 项目的 `Packages/manifest.json` 中移除 Unity-MCP 插件。
159
-
160
- ```bash
161
- npx unity-mcp-cli remove-plugin ./MyGame
162
- ```
163
-
164
- | 选项 | 必需 | 描述 |
165
- |---|---|---|
166
- | `[path]` | 是 | Unity 项目的路径(位置参数或 `--path`) |
167
-
168
- 此命令将:
169
- 1. 从 `dependencies` 中移除 `com.ivanmurzak.unity.mcp`
170
- 2. **保留作用域注册表和作用域** — 其他包可能依赖它们
171
- 3. 若插件未安装,则**不执行任何操作**
172
-
173
- > 运行此命令后,请在 Unity Editor 中打开项目以应用更改。
174
-
175
- ![AI Game Developer — Unity MCP](https://github.com/IvanMurzak/Unity-MCP/blob/main/docs/img/promo/hazzard-divider.svg?raw=true)
176
-
177
82
  ## `configure`
178
83
 
179
84
  在 `UserSettings/AI-Game-Developer-Config.json` 中配置 MCP 工具、提示词和资源。
@@ -277,6 +182,116 @@ npx unity-mcp-cli connect \
277
182
 
278
183
  ![AI Game Developer — Unity MCP](https://github.com/IvanMurzak/Unity-MCP/blob/main/docs/img/promo/hazzard-divider.svg?raw=true)
279
184
 
185
+ ## `create-project`
186
+
187
+ 使用 Unity Editor 创建新的 Unity 项目。
188
+
189
+ ```bash
190
+ npx unity-mcp-cli create-project /path/to/new/project
191
+ ```
192
+
193
+ | 选项 | 必需 | 描述 |
194
+ |---|---|---|
195
+ | `[path]` | 是 | 项目将被创建的路径(位置参数或 `--path`) |
196
+ | `--unity <version>` | 否 | 要使用的 Unity Editor 版本(默认为已安装的最高版本) |
197
+
198
+ **示例 — 使用指定编辑器版本创建项目:**
199
+
200
+ ```bash
201
+ npx unity-mcp-cli create-project ./MyGame --unity 2022.3.62f1
202
+ ```
203
+
204
+ ![AI Game Developer — Unity MCP](https://github.com/IvanMurzak/Unity-MCP/blob/main/docs/img/promo/hazzard-divider.svg?raw=true)
205
+
206
+ ## `install-plugin`
207
+
208
+ 将 Unity-MCP 插件安装到 Unity 项目的 `Packages/manifest.json` 中。
209
+
210
+ ```bash
211
+ npx unity-mcp-cli install-plugin ./MyGame
212
+ ```
213
+
214
+ | 选项 | 必需 | 描述 |
215
+ |---|---|---|
216
+ | `[path]` | 是 | Unity 项目的路径(位置参数或 `--path`) |
217
+ | `--plugin-version <version>` | 否 | 要安装的插件版本(默认为来自 [OpenUPM](https://openupm.com/packages/com.ivanmurzak.unity.mcp/) 的最新版本) |
218
+
219
+ 此命令将:
220
+ 1. 添加 **OpenUPM 作用域注册表**及所有必要的作用域
221
+ 2. 将 `com.ivanmurzak.unity.mcp` 添加到 `dependencies`
222
+ 3. **从不降级** — 若已安装更高版本,则保留现有版本
223
+
224
+ **示例 — 安装指定插件版本:**
225
+
226
+ ```bash
227
+ npx unity-mcp-cli install-plugin ./MyGame --plugin-version 0.52.0
228
+ ```
229
+
230
+ > 运行此命令后,请在 Unity Editor 中打开项目以完成包安装。
231
+
232
+ ![AI Game Developer — Unity MCP](https://github.com/IvanMurzak/Unity-MCP/blob/main/docs/img/promo/hazzard-divider.svg?raw=true)
233
+
234
+ ## `install-unity`
235
+
236
+ 通过 Unity Hub CLI 安装指定版本的 Unity Editor。
237
+
238
+ ```bash
239
+ npx unity-mcp-cli install-unity 6000.3.1f1
240
+ ```
241
+
242
+ | 参数 / 选项 | 必需 | 描述 |
243
+ |---|---|---|
244
+ | `[version]` | 否 | 要安装的 Unity Editor 版本(例如 `6000.3.1f1`) |
245
+ | `--path <path>` | 否 | 从现有项目中读取所需版本 |
246
+
247
+ 若参数和选项均未提供,命令将从 Unity Hub 发布列表中安装最新稳定版本。
248
+
249
+ **示例 — 安装项目所需的编辑器版本:**
250
+
251
+ ```bash
252
+ npx unity-mcp-cli install-unity --path ./MyGame
253
+ ```
254
+
255
+ ![AI Game Developer — Unity MCP](https://github.com/IvanMurzak/Unity-MCP/blob/main/docs/img/promo/hazzard-divider.svg?raw=true)
256
+
257
+ ## `open`
258
+
259
+ 在 Unity Editor 中打开 Unity 项目。
260
+
261
+ ```bash
262
+ npx unity-mcp-cli open ./MyGame
263
+ ```
264
+
265
+ | 选项 | 必需 | 描述 |
266
+ |---|---|---|
267
+ | `[path]` | 是 | Unity 项目的路径(位置参数或 `--path`) |
268
+ | `--unity <version>` | 否 | 要使用的特定 Unity Editor 版本(默认为项目设置中的版本,回退为已安装的最高版本) |
269
+
270
+ 编辑器进程以分离模式启动 — CLI 会立即返回。
271
+
272
+ ![AI Game Developer — Unity MCP](https://github.com/IvanMurzak/Unity-MCP/blob/main/docs/img/promo/hazzard-divider.svg?raw=true)
273
+
274
+ ## `remove-plugin`
275
+
276
+ 从 Unity 项目的 `Packages/manifest.json` 中移除 Unity-MCP 插件。
277
+
278
+ ```bash
279
+ npx unity-mcp-cli remove-plugin ./MyGame
280
+ ```
281
+
282
+ | 选项 | 必需 | 描述 |
283
+ |---|---|---|
284
+ | `[path]` | 是 | Unity 项目的路径(位置参数或 `--path`) |
285
+
286
+ 此命令将:
287
+ 1. 从 `dependencies` 中移除 `com.ivanmurzak.unity.mcp`
288
+ 2. **保留作用域注册表和作用域** — 其他包可能依赖它们
289
+ 3. 若插件未安装,则**不执行任何操作**
290
+
291
+ > 运行此命令后,请在 Unity Editor 中打开项目以应用更改。
292
+
293
+ ![AI Game Developer — Unity MCP](https://github.com/IvanMurzak/Unity-MCP/blob/main/docs/img/promo/hazzard-divider.svg?raw=true)
294
+
280
295
  # 完整自动化示例
281
296
 
282
297
  通过一个脚本从零搭建完整的 Unity MCP 项目:
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "unity-mcp-cli",
3
- "version": "0.54.0",
3
+ "version": "0.55.0",
4
4
  "description": "Cross-platform CLI tool for Unity-MCP operations — create projects, install plugins, configure tools, and manage MCP connections",
5
5
  "type": "module",
6
6
  "main": "dist/index.js",