unity-mcp-cli 0.57.1 → 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.
- package/README.md +41 -20
- package/docs/README.es.md +155 -135
- package/docs/README.ja.md +184 -164
- package/docs/README.zh-CN.md +133 -113
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -29,7 +29,7 @@
|
|
|
29
29
|
|
|
30
30
|
Cross-platform CLI tool for **[Unity MCP](https://github.com/IvanMurzak/Unity-MCP)** — create projects, install plugins, configure MCP tools, and launch Unity with active MCP connections. All from a single command line.
|
|
31
31
|
|
|
32
|
-
## 
|
|
32
|
+
## 
|
|
33
33
|
|
|
34
34
|
- :white_check_mark: **Create projects** — scaffold new Unity projects via Unity Editor
|
|
35
35
|
- :white_check_mark: **Install editors** — install any Unity Editor version from the command line
|
|
@@ -45,15 +45,33 @@ Cross-platform CLI tool for **[Unity MCP](https://github.com/IvanMurzak/Unity-MC
|
|
|
45
45
|
- :white_check_mark: **Verbose mode** — use `--verbose` on any command for detailed diagnostic output
|
|
46
46
|
- :white_check_mark: **Version-aware** — never downgrades plugin versions, resolves latest from OpenUPM
|
|
47
47
|
|
|
48
|
-
|
|
48
|
+
|
|
49
49
|
|
|
50
50
|
# Quick Start
|
|
51
51
|
|
|
52
52
|
Install globally and run:
|
|
53
53
|
|
|
54
54
|
```bash
|
|
55
|
-
|
|
56
|
-
unity-mcp-cli
|
|
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
77
|
Or run any command instantly with `npx` — no global installation required:
|
|
@@ -64,7 +82,7 @@ npx unity-mcp-cli install-plugin /path/to/unity/project
|
|
|
64
82
|
|
|
65
83
|
> **Requirements:** [Node.js](https://nodejs.org/) ^20.19.0 || >=22.12.0. [Unity Hub](https://unity.com/download) is installed automatically if not found.
|
|
66
84
|
|
|
67
|
-
|
|
85
|
+
|
|
68
86
|
|
|
69
87
|
# Contents
|
|
70
88
|
|
|
@@ -87,7 +105,7 @@ npx unity-mcp-cli install-plugin /path/to/unity/project
|
|
|
87
105
|
- [Configuration File](#configuration-file)
|
|
88
106
|
- [Unity Hub Integration](#unity-hub-integration)
|
|
89
107
|
|
|
90
|
-
|
|
108
|
+
|
|
91
109
|
|
|
92
110
|
# Commands
|
|
93
111
|
|
|
@@ -133,7 +151,7 @@ unity-mcp-cli configure ./MyGame \
|
|
|
133
151
|
--enable-all-resources
|
|
134
152
|
```
|
|
135
153
|
|
|
136
|
-
|
|
154
|
+
|
|
137
155
|
|
|
138
156
|
## `create-project`
|
|
139
157
|
|
|
@@ -154,7 +172,7 @@ unity-mcp-cli create-project /path/to/new/project
|
|
|
154
172
|
unity-mcp-cli create-project ./MyGame --unity 2022.3.62f1
|
|
155
173
|
```
|
|
156
174
|
|
|
157
|
-
|
|
175
|
+
|
|
158
176
|
|
|
159
177
|
## `install-plugin`
|
|
160
178
|
|
|
@@ -182,7 +200,7 @@ unity-mcp-cli install-plugin ./MyGame --plugin-version 0.51.6
|
|
|
182
200
|
|
|
183
201
|
> After running this command, open the project in Unity Editor to complete the package installation.
|
|
184
202
|
|
|
185
|
-
|
|
203
|
+
|
|
186
204
|
|
|
187
205
|
## `install-unity`
|
|
188
206
|
|
|
@@ -205,7 +223,7 @@ If neither argument nor option is provided, the command installs the latest stab
|
|
|
205
223
|
unity-mcp-cli install-unity --path ./MyGame
|
|
206
224
|
```
|
|
207
225
|
|
|
208
|
-
|
|
226
|
+
|
|
209
227
|
|
|
210
228
|
## `open`
|
|
211
229
|
|
|
@@ -254,7 +272,7 @@ unity-mcp-cli open ./MyGame \
|
|
|
254
272
|
--tools gameobject-create,gameobject-find
|
|
255
273
|
```
|
|
256
274
|
|
|
257
|
-
|
|
275
|
+
|
|
258
276
|
|
|
259
277
|
## `run-tool`
|
|
260
278
|
|
|
@@ -300,7 +318,7 @@ unity-mcp-cli run-tool scene-save --url http://localhost:8080
|
|
|
300
318
|
unity-mcp-cli run-tool assets-list ./MyGame --raw | jq '.results'
|
|
301
319
|
```
|
|
302
320
|
|
|
303
|
-
|
|
321
|
+
|
|
304
322
|
|
|
305
323
|
## `setup-mcp`
|
|
306
324
|
|
|
@@ -331,7 +349,7 @@ unity-mcp-cli setup-mcp --list
|
|
|
331
349
|
unity-mcp-cli setup-mcp cursor ./MyGame --transport stdio
|
|
332
350
|
```
|
|
333
351
|
|
|
334
|
-
|
|
352
|
+
|
|
335
353
|
|
|
336
354
|
## `setup-skills`
|
|
337
355
|
|
|
@@ -356,7 +374,7 @@ unity-mcp-cli setup-skills claude-code ./MyGame
|
|
|
356
374
|
unity-mcp-cli setup-skills --list
|
|
357
375
|
```
|
|
358
376
|
|
|
359
|
-
|
|
377
|
+
|
|
360
378
|
|
|
361
379
|
## `remove-plugin`
|
|
362
380
|
|
|
@@ -377,7 +395,7 @@ This command:
|
|
|
377
395
|
|
|
378
396
|
> After running this command, open the project in Unity Editor to apply the change.
|
|
379
397
|
|
|
380
|
-
|
|
398
|
+
|
|
381
399
|
|
|
382
400
|
## Global Options
|
|
383
401
|
|
|
@@ -395,7 +413,7 @@ These options are available on all commands:
|
|
|
395
413
|
unity-mcp-cli install-plugin ./MyGame --verbose
|
|
396
414
|
```
|
|
397
415
|
|
|
398
|
-
|
|
416
|
+
|
|
399
417
|
|
|
400
418
|
# Full Automation Example
|
|
401
419
|
|
|
@@ -411,16 +429,19 @@ unity-mcp-cli install-plugin ./MyAIGame
|
|
|
411
429
|
# 3. Enable all MCP tools
|
|
412
430
|
unity-mcp-cli configure ./MyAIGame --enable-all-tools
|
|
413
431
|
|
|
414
|
-
# 4.
|
|
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
|
|
415
436
|
unity-mcp-cli setup-mcp claude-code ./MyAIGame
|
|
416
437
|
|
|
417
|
-
#
|
|
438
|
+
# 6. Open the project with MCP connection
|
|
418
439
|
unity-mcp-cli open ./MyAIGame \
|
|
419
440
|
--url http://localhost:8080 \
|
|
420
441
|
--keep-connected
|
|
421
442
|
```
|
|
422
443
|
|
|
423
|
-
|
|
444
|
+
|
|
424
445
|
|
|
425
446
|
# How It Works
|
|
426
447
|
|
|
@@ -452,4 +473,4 @@ Commands that manage editors or create projects use the **Unity Hub CLI** (`--he
|
|
|
452
473
|
|
|
453
474
|
> For the full Unity-MCP project documentation, see the [main README](https://github.com/IvanMurzak/Unity-MCP/blob/main/README.md).
|
|
454
475
|
|
|
455
|
-
|
|
476
|
+
|