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.
- 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/docs/README.es.md
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
<div align="center" width="100%">
|
|
2
2
|
<h1>Unity MCP — <i>CLI</i></h1>
|
|
3
3
|
|
|
4
|
-
[](https://www.npmjs.com/package/unity-mcp-cli)
|
|
5
5
|
[](https://nodejs.org/)
|
|
6
6
|
[](https://github.com/IvanMurzak/Unity-MCP/blob/main/LICENSE)
|
|
7
7
|
[](https://stand-with-ukraine.pp.ua)
|
|
@@ -25,52 +25,69 @@
|
|
|
25
25
|
|
|
26
26
|
</div>
|
|
27
27
|
|
|
28
|
-
<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
|
-
Herramienta CLI multiplataforma para **[Unity MCP](https://github.com/IvanMurzak/Unity-MCP)** — crea proyectos, instala plugins, configura herramientas MCP e inicia Unity con conexiones MCP activas. Todo desde una sola
|
|
30
|
+
Herramienta CLI multiplataforma para **[Unity MCP](https://github.com/IvanMurzak/Unity-MCP)** — crea proyectos, instala plugins, configura herramientas MCP e inicia Unity con conexiones MCP activas. Todo desde una sola linea de comandos.
|
|
31
31
|
|
|
32
|
-
## 
|
|
32
|
+
## 
|
|
33
33
|
|
|
34
|
-
- :white_check_mark: **
|
|
35
|
-
- :white_check_mark: **
|
|
36
|
-
- :white_check_mark: **
|
|
37
|
-
- :white_check_mark: **
|
|
38
|
-
- :white_check_mark: **
|
|
39
|
-
- :white_check_mark: **
|
|
40
|
-
- :white_check_mark: **
|
|
41
|
-
- :white_check_mark: **
|
|
42
|
-
- :white_check_mark: **
|
|
43
|
-
- :white_check_mark: **
|
|
44
|
-
- :white_check_mark: **CI
|
|
45
|
-
- :white_check_mark: **
|
|
46
|
-
- :white_check_mark: **
|
|
34
|
+
- :white_check_mark: **Crear proyectos** — crea nuevos proyectos de Unity mediante el Editor de Unity
|
|
35
|
+
- :white_check_mark: **Instalar editores** — instala cualquier version del Editor de Unity desde la linea de comandos
|
|
36
|
+
- :white_check_mark: **Instalar plugin** — agrega el plugin Unity-MCP a `manifest.json` con todos los registros de ambito requeridos
|
|
37
|
+
- :white_check_mark: **Eliminar plugin** — elimina el plugin Unity-MCP de `manifest.json`
|
|
38
|
+
- :white_check_mark: **Configurar** — activa/desactiva herramientas, prompts y recursos MCP
|
|
39
|
+
- :white_check_mark: **Ejecutar herramientas** — ejecuta herramientas MCP directamente desde la linea de comandos
|
|
40
|
+
- :white_check_mark: **Configurar MCP** — escribe archivos de configuracion MCP para agentes de IA en cualquiera de los 14 agentes soportados
|
|
41
|
+
- :white_check_mark: **Configurar habilidades** — genera archivos de habilidades para agentes de IA a traves del servidor MCP
|
|
42
|
+
- :white_check_mark: **Abrir y conectar** — inicia Unity con variables de entorno MCP opcionales para la conexion automatica al servidor
|
|
43
|
+
- :white_check_mark: **Multiplataforma** — Windows, macOS y Linux
|
|
44
|
+
- :white_check_mark: **Compatible con CI** — detecta automaticamente terminales no interactivas y desactiva spinners/colores
|
|
45
|
+
- :white_check_mark: **Modo detallado** — usa `--verbose` en cualquier comando para obtener salida de diagnostico detallada
|
|
46
|
+
- :white_check_mark: **Control de versiones** — nunca degrada versiones del plugin, resuelve la ultima version desde OpenUPM
|
|
47
47
|
|
|
48
|
-
|
|
48
|
+
|
|
49
49
|
|
|
50
|
-
# Inicio
|
|
50
|
+
# Inicio rapido
|
|
51
51
|
|
|
52
52
|
Instala globalmente y ejecuta:
|
|
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
|
-
O ejecuta cualquier comando al instante con `npx` — sin necesidad de
|
|
77
|
+
O ejecuta cualquier comando al instante con `npx` — sin necesidad de instalacion global:
|
|
60
78
|
|
|
61
79
|
```bash
|
|
62
80
|
npx unity-mcp-cli install-plugin /path/to/unity/project
|
|
63
81
|
```
|
|
64
82
|
|
|
65
|
-
> **Requisitos:** [Node.js](https://nodejs.org/) ^20.19.0 || >=22.12.0. [Unity Hub](https://unity.com/download) se instala
|
|
83
|
+
> **Requisitos:** [Node.js](https://nodejs.org/) ^20.19.0 || >=22.12.0. [Unity Hub](https://unity.com/download) se instala automaticamente si no se encuentra.
|
|
66
84
|
|
|
67
|
-
|
|
85
|
+
|
|
68
86
|
|
|
69
87
|
# Contenidos
|
|
70
88
|
|
|
71
|
-
- [Inicio
|
|
72
|
-
- [
|
|
73
|
-
- [Comandos](#comandos)
|
|
89
|
+
- [Inicio rapido](#quick-start)
|
|
90
|
+
- [Comandos](#commands)
|
|
74
91
|
- [`configure`](#configure)
|
|
75
92
|
- [`create-project`](#create-project)
|
|
76
93
|
- [`install-plugin`](#install-plugin)
|
|
@@ -80,15 +97,15 @@ 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
|
-
- [Opciones
|
|
84
|
-
- [Ejemplo de
|
|
85
|
-
- [
|
|
86
|
-
- [Puerto
|
|
87
|
-
- [
|
|
88
|
-
- [Archivo de
|
|
89
|
-
- [
|
|
100
|
+
- [Opciones globales](#global-options)
|
|
101
|
+
- [Ejemplo de automatizacion completa](#full-automation-example)
|
|
102
|
+
- [Como funciona](#how-it-works)
|
|
103
|
+
- [Puerto determinista](#deterministic-port)
|
|
104
|
+
- [Instalacion del plugin](#plugin-installation)
|
|
105
|
+
- [Archivo de configuracion](#configuration-file)
|
|
106
|
+
- [Integracion con Unity Hub](#unity-hub-integration)
|
|
90
107
|
|
|
91
|
-
|
|
108
|
+
|
|
92
109
|
|
|
93
110
|
# Comandos
|
|
94
111
|
|
|
@@ -100,24 +117,24 @@ Configura herramientas, prompts y recursos MCP en `UserSettings/AI-Game-Develope
|
|
|
100
117
|
unity-mcp-cli configure ./MyGame --list
|
|
101
118
|
```
|
|
102
119
|
|
|
103
|
-
|
|
|
120
|
+
| Opcion | Requerido | Descripcion |
|
|
104
121
|
|---|---|---|
|
|
105
|
-
| `[path]` |
|
|
106
|
-
| `--list` | No | Muestra la
|
|
107
|
-
| `--enable-tools <names>` | No | Activa herramientas
|
|
108
|
-
| `--disable-tools <names>` | No | Desactiva herramientas
|
|
122
|
+
| `[path]` | Si | Ruta al proyecto de Unity (posicional o `--path`) |
|
|
123
|
+
| `--list` | No | Muestra la configuracion actual y termina |
|
|
124
|
+
| `--enable-tools <names>` | No | Activa herramientas especificas (separadas por comas) |
|
|
125
|
+
| `--disable-tools <names>` | No | Desactiva herramientas especificas (separadas por comas) |
|
|
109
126
|
| `--enable-all-tools` | No | Activa todas las herramientas |
|
|
110
127
|
| `--disable-all-tools` | No | Desactiva todas las herramientas |
|
|
111
|
-
| `--enable-prompts <names>` | No | Activa prompts
|
|
112
|
-
| `--disable-prompts <names>` | No | Desactiva prompts
|
|
128
|
+
| `--enable-prompts <names>` | No | Activa prompts especificos (separados por comas) |
|
|
129
|
+
| `--disable-prompts <names>` | No | Desactiva prompts especificos (separados por comas) |
|
|
113
130
|
| `--enable-all-prompts` | No | Activa todos los prompts |
|
|
114
131
|
| `--disable-all-prompts` | No | Desactiva todos los prompts |
|
|
115
|
-
| `--enable-resources <names>` | No | Activa recursos
|
|
116
|
-
| `--disable-resources <names>` | No | Desactiva recursos
|
|
132
|
+
| `--enable-resources <names>` | No | Activa recursos especificos (separados por comas) |
|
|
133
|
+
| `--disable-resources <names>` | No | Desactiva recursos especificos (separados por comas) |
|
|
117
134
|
| `--enable-all-resources` | No | Activa todos los recursos |
|
|
118
135
|
| `--disable-all-resources` | No | Desactiva todos los recursos |
|
|
119
136
|
|
|
120
|
-
**Ejemplo — activar herramientas
|
|
137
|
+
**Ejemplo — activar herramientas especificas y desactivar todos los prompts:**
|
|
121
138
|
|
|
122
139
|
```bash
|
|
123
140
|
unity-mcp-cli configure ./MyGame \
|
|
@@ -134,7 +151,7 @@ unity-mcp-cli configure ./MyGame \
|
|
|
134
151
|
--enable-all-resources
|
|
135
152
|
```
|
|
136
153
|
|
|
137
|
-
|
|
154
|
+
|
|
138
155
|
|
|
139
156
|
## `create-project`
|
|
140
157
|
|
|
@@ -144,18 +161,18 @@ Crea un nuevo proyecto de Unity utilizando el Editor de Unity.
|
|
|
144
161
|
unity-mcp-cli create-project /path/to/new/project
|
|
145
162
|
```
|
|
146
163
|
|
|
147
|
-
|
|
|
164
|
+
| Opcion | Requerido | Descripcion |
|
|
148
165
|
|---|---|---|
|
|
149
|
-
| `[path]` |
|
|
150
|
-
| `--unity <version>` | No |
|
|
166
|
+
| `[path]` | Si | Ruta donde se creara el proyecto (posicional o `--path`) |
|
|
167
|
+
| `--unity <version>` | No | Version del Editor de Unity a utilizar (por defecto, la mas alta instalada) |
|
|
151
168
|
|
|
152
|
-
**Ejemplo — crear un proyecto con una
|
|
169
|
+
**Ejemplo — crear un proyecto con una version especifica del editor:**
|
|
153
170
|
|
|
154
171
|
```bash
|
|
155
172
|
unity-mcp-cli create-project ./MyGame --unity 2022.3.62f1
|
|
156
173
|
```
|
|
157
174
|
|
|
158
|
-
|
|
175
|
+
|
|
159
176
|
|
|
160
177
|
## `install-plugin`
|
|
161
178
|
|
|
@@ -165,73 +182,73 @@ Instala el plugin Unity-MCP en el archivo `Packages/manifest.json` de un proyect
|
|
|
165
182
|
unity-mcp-cli install-plugin ./MyGame
|
|
166
183
|
```
|
|
167
184
|
|
|
168
|
-
|
|
|
185
|
+
| Opcion | Requerido | Descripcion |
|
|
169
186
|
|---|---|---|
|
|
170
|
-
| `[path]` |
|
|
171
|
-
| `--plugin-version <version>` | No |
|
|
187
|
+
| `[path]` | Si | Ruta al proyecto de Unity (posicional o `--path`) |
|
|
188
|
+
| `--plugin-version <version>` | No | Version del plugin a instalar (por defecto, la ultima desde [OpenUPM](https://openupm.com/packages/com.ivanmurzak.unity.mcp/)) |
|
|
172
189
|
|
|
173
190
|
Este comando:
|
|
174
|
-
1. Agrega el **registro de
|
|
191
|
+
1. Agrega el **registro de ambito de OpenUPM** con todos los ambitos requeridos
|
|
175
192
|
2. Agrega `com.ivanmurzak.unity.mcp` a `dependencies`
|
|
176
|
-
3. **Nunca degrada** — si ya hay instalada una
|
|
193
|
+
3. **Nunca degrada** — si ya hay instalada una version superior, se conserva
|
|
177
194
|
|
|
178
|
-
**Ejemplo — instalar una
|
|
195
|
+
**Ejemplo — instalar una version especifica del plugin:**
|
|
179
196
|
|
|
180
197
|
```bash
|
|
181
198
|
unity-mcp-cli install-plugin ./MyGame --plugin-version 0.51.6
|
|
182
199
|
```
|
|
183
200
|
|
|
184
|
-
>
|
|
201
|
+
> Despues de ejecutar este comando, abre el proyecto en el Editor de Unity para completar la instalacion del paquete.
|
|
185
202
|
|
|
186
|
-
|
|
203
|
+
|
|
187
204
|
|
|
188
205
|
## `install-unity`
|
|
189
206
|
|
|
190
|
-
Instala una
|
|
207
|
+
Instala una version del Editor de Unity mediante la CLI de Unity Hub.
|
|
191
208
|
|
|
192
209
|
```bash
|
|
193
210
|
unity-mcp-cli install-unity 6000.3.1f1
|
|
194
211
|
```
|
|
195
212
|
|
|
196
|
-
| Argumento /
|
|
213
|
+
| Argumento / Opcion | Requerido | Descripcion |
|
|
197
214
|
|---|---|---|
|
|
198
|
-
| `[version]` | No |
|
|
199
|
-
| `--path <path>` | No | Lee la
|
|
215
|
+
| `[version]` | No | Version del Editor de Unity a instalar (ej. `6000.3.1f1`) |
|
|
216
|
+
| `--path <path>` | No | Lee la version requerida desde un proyecto existente |
|
|
200
217
|
|
|
201
|
-
Si no se proporciona
|
|
218
|
+
Si no se proporciona ningun argumento ni opcion, el comando instala la ultima version estable desde la lista de lanzamientos de Unity Hub.
|
|
202
219
|
|
|
203
|
-
**Ejemplo — instalar la
|
|
220
|
+
**Ejemplo — instalar la version del editor que necesita un proyecto:**
|
|
204
221
|
|
|
205
222
|
```bash
|
|
206
223
|
unity-mcp-cli install-unity --path ./MyGame
|
|
207
224
|
```
|
|
208
225
|
|
|
209
|
-
|
|
226
|
+
|
|
210
227
|
|
|
211
228
|
## `open`
|
|
212
229
|
|
|
213
|
-
Abre un proyecto de Unity en el Editor de Unity. Por defecto, establece variables de entorno de
|
|
230
|
+
Abre un proyecto de Unity en el Editor de Unity. Por defecto, establece variables de entorno de conexion MCP si se proporcionan opciones de conexion. Usa `--no-connect` para abrir sin conexion MCP.
|
|
214
231
|
|
|
215
232
|
```bash
|
|
216
233
|
unity-mcp-cli open ./MyGame
|
|
217
234
|
```
|
|
218
235
|
|
|
219
|
-
|
|
|
236
|
+
| Opcion | Variable de entorno | Requerido | Descripcion |
|
|
220
237
|
|---|---|---|---|
|
|
221
|
-
| `[path]` | — |
|
|
222
|
-
| `--unity <version>` | — | No |
|
|
223
|
-
| `--no-connect` | — | No | Abrir sin variables de entorno de
|
|
238
|
+
| `[path]` | — | Si | Ruta al proyecto de Unity (posicional o `--path`) |
|
|
239
|
+
| `--unity <version>` | — | No | Version especifica del Editor de Unity a utilizar (por defecto, la version de la configuracion del proyecto; si no esta disponible, la mas alta instalada) |
|
|
240
|
+
| `--no-connect` | — | No | Abrir sin variables de entorno de conexion MCP |
|
|
224
241
|
| `--url <url>` | `UNITY_MCP_HOST` | No | URL del servidor MCP al que conectarse |
|
|
225
|
-
| `--keep-connected` | `UNITY_MCP_KEEP_CONNECTED` | No | Fuerza mantener la
|
|
226
|
-
| `--token <token>` | `UNITY_MCP_TOKEN` | No | Token de
|
|
227
|
-
| `--auth <option>` | `UNITY_MCP_AUTH_OPTION` | No | Modo de
|
|
242
|
+
| `--keep-connected` | `UNITY_MCP_KEEP_CONNECTED` | No | Fuerza mantener la conexion activa |
|
|
243
|
+
| `--token <token>` | `UNITY_MCP_TOKEN` | No | Token de autenticacion |
|
|
244
|
+
| `--auth <option>` | `UNITY_MCP_AUTH_OPTION` | No | Modo de autenticacion: `none` o `required` |
|
|
228
245
|
| `--tools <names>` | `UNITY_MCP_TOOLS` | No | Lista de herramientas a activar, separadas por comas |
|
|
229
|
-
| `--transport <method>` | `UNITY_MCP_TRANSPORT` | No |
|
|
230
|
-
| `--start-server <value>` | `UNITY_MCP_START_SERVER` | No | Establece `true` o `false` para controlar el inicio
|
|
246
|
+
| `--transport <method>` | `UNITY_MCP_TRANSPORT` | No | Metodo de transporte: `streamableHttp` o `stdio` |
|
|
247
|
+
| `--start-server <value>` | `UNITY_MCP_START_SERVER` | No | Establece `true` o `false` para controlar el inicio automatico del servidor MCP |
|
|
231
248
|
|
|
232
249
|
El proceso del editor se lanza en modo desacoplado — la CLI regresa inmediatamente.
|
|
233
250
|
|
|
234
|
-
**Ejemplo — abrir con
|
|
251
|
+
**Ejemplo — abrir con conexion 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
|
-
**Ejemplo — abrir sin
|
|
259
|
+
**Ejemplo — abrir sin conexion MCP (apertura simple):**
|
|
243
260
|
|
|
244
261
|
```bash
|
|
245
262
|
unity-mcp-cli open ./MyGame --no-connect
|
|
246
263
|
```
|
|
247
264
|
|
|
248
|
-
**Ejemplo — abrir con
|
|
265
|
+
**Ejemplo — abrir con autenticacion y herramientas especificas:**
|
|
249
266
|
|
|
250
267
|
```bash
|
|
251
268
|
unity-mcp-cli open ./MyGame \
|
|
@@ -255,35 +272,35 @@ unity-mcp-cli open ./MyGame \
|
|
|
255
272
|
--tools gameobject-create,gameobject-find
|
|
256
273
|
```
|
|
257
274
|
|
|
258
|
-
|
|
275
|
+
|
|
259
276
|
|
|
260
277
|
## `run-tool`
|
|
261
278
|
|
|
262
|
-
Ejecuta una herramienta MCP directamente a
|
|
279
|
+
Ejecuta una herramienta MCP directamente a traves de la API HTTP. La URL del servidor y el token de autorizacion se **resuelven automaticamente** desde el archivo de configuracion del proyecto (`UserSettings/AI-Game-Developer-Config.json`), basandose en el modo de conexion actual (Custom o Cloud).
|
|
263
280
|
|
|
264
281
|
```bash
|
|
265
282
|
unity-mcp-cli run-tool gameobject-create ./MyGame --input '{"name":"Cube"}'
|
|
266
283
|
```
|
|
267
284
|
|
|
268
|
-
|
|
|
285
|
+
| Opcion | Requerido | Descripcion |
|
|
269
286
|
|---|---|---|
|
|
270
|
-
| `<tool-name>` |
|
|
271
|
-
| `[path]` | No | Ruta al proyecto de Unity (posicional o `--path`) — se usa para leer la
|
|
272
|
-
| `--url <url>` | No | URL directa del servidor (omite la
|
|
273
|
-
| `--token <token>` | No | Token Bearer (omite la
|
|
287
|
+
| `<tool-name>` | Si | Nombre de la herramienta MCP a ejecutar |
|
|
288
|
+
| `[path]` | No | Ruta al proyecto de Unity (posicional o `--path`) — se usa para leer la configuracion y detectar el puerto |
|
|
289
|
+
| `--url <url>` | No | URL directa del servidor (omite la configuracion) |
|
|
290
|
+
| `--token <token>` | No | Token Bearer (omite la configuracion) |
|
|
274
291
|
| `--input <json>` | No | Cadena JSON con los argumentos de la herramienta (por defecto `{}`) |
|
|
275
292
|
| `--input-file <file>` | No | Lee los argumentos JSON desde un archivo |
|
|
276
293
|
| `--raw` | No | Salida JSON sin formato (sin formato visual, sin spinner) |
|
|
277
294
|
| `--timeout <ms>` | No | Tiempo de espera de la solicitud en milisegundos (por defecto: 60000) |
|
|
278
295
|
|
|
279
|
-
**Prioridad de
|
|
296
|
+
**Prioridad de resolucion de URL:**
|
|
280
297
|
1. `--url` → se usa directamente
|
|
281
|
-
2. Archivo de
|
|
298
|
+
2. Archivo de configuracion → `host` (modo Custom) o URL de nube predefinida (modo Cloud)
|
|
282
299
|
3. Puerto determinista a partir de la ruta del proyecto
|
|
283
300
|
|
|
284
|
-
**La
|
|
301
|
+
**La autorizacion** se lee automaticamente desde la configuracion del proyecto (`token` en modo Custom, `cloudToken` en modo Cloud). Usa `--token` para reemplazar explicitamente el token derivado de la configuracion.
|
|
285
302
|
|
|
286
|
-
**Ejemplo — llamar a una herramienta (URL y
|
|
303
|
+
**Ejemplo — llamar a una herramienta (URL y autenticacion desde la configuracion):**
|
|
287
304
|
|
|
288
305
|
```bash
|
|
289
306
|
unity-mcp-cli run-tool gameobject-find ./MyGame --input '{"query":"Player"}'
|
|
@@ -301,23 +318,23 @@ unity-mcp-cli run-tool scene-save --url http://localhost:8080
|
|
|
301
318
|
unity-mcp-cli run-tool assets-list ./MyGame --raw | jq '.results'
|
|
302
319
|
```
|
|
303
320
|
|
|
304
|
-
|
|
321
|
+
|
|
305
322
|
|
|
306
323
|
## `setup-mcp`
|
|
307
324
|
|
|
308
|
-
Escribe archivos de
|
|
325
|
+
Escribe archivos de configuracion MCP para agentes de IA, permitiendo la configuracion headless/CI sin la interfaz del Editor de Unity. Soporta los 14 agentes (Claude Code, Cursor, Gemini, Codex, etc.).
|
|
309
326
|
|
|
310
327
|
```bash
|
|
311
328
|
unity-mcp-cli setup-mcp claude-code ./MyGame
|
|
312
329
|
```
|
|
313
330
|
|
|
314
|
-
|
|
|
331
|
+
| Opcion | Requerido | Descripcion |
|
|
315
332
|
|---|---|---|
|
|
316
|
-
| `[agent-id]` |
|
|
333
|
+
| `[agent-id]` | Si | Agente a configurar (usa `--list` para ver todos) |
|
|
317
334
|
| `[path]` | No | Ruta al proyecto de Unity (por defecto, el directorio actual) |
|
|
318
|
-
| `--transport <transport>` | No |
|
|
335
|
+
| `--transport <transport>` | No | Metodo de transporte: `stdio` o `http` (por defecto: `http`) |
|
|
319
336
|
| `--url <url>` | No | URL del servidor (para transporte http) |
|
|
320
|
-
| `--token <token>` | No | Token de
|
|
337
|
+
| `--token <token>` | No | Token de autenticacion |
|
|
321
338
|
| `--list` | No | Lista todos los IDs de agentes disponibles |
|
|
322
339
|
|
|
323
340
|
**Ejemplo — listar todos los agentes soportados:**
|
|
@@ -332,22 +349,22 @@ unity-mcp-cli setup-mcp --list
|
|
|
332
349
|
unity-mcp-cli setup-mcp cursor ./MyGame --transport stdio
|
|
333
350
|
```
|
|
334
351
|
|
|
335
|
-
|
|
352
|
+
|
|
336
353
|
|
|
337
354
|
## `setup-skills`
|
|
338
355
|
|
|
339
|
-
Genera archivos de habilidades para un agente de IA llamando a la API de herramientas del sistema del servidor MCP. Requiere que el Editor de Unity
|
|
356
|
+
Genera archivos de habilidades para un agente de IA llamando a la API de herramientas del sistema del servidor MCP. Requiere que el Editor de Unity este en ejecucion con el plugin MCP instalado.
|
|
340
357
|
|
|
341
358
|
```bash
|
|
342
359
|
unity-mcp-cli setup-skills claude-code ./MyGame
|
|
343
360
|
```
|
|
344
361
|
|
|
345
|
-
|
|
|
362
|
+
| Opcion | Requerido | Descripcion |
|
|
346
363
|
|---|---|---|
|
|
347
|
-
| `[agent-id]` |
|
|
364
|
+
| `[agent-id]` | Si | Agente para el que generar habilidades (usa `--list` para ver todos) |
|
|
348
365
|
| `[path]` | No | Ruta al proyecto de Unity (por defecto, el directorio actual) |
|
|
349
366
|
| `--url <url>` | No | URL del servidor |
|
|
350
|
-
| `--token <token>` | No | Token de
|
|
367
|
+
| `--token <token>` | No | Token de autenticacion |
|
|
351
368
|
| `--list` | No | Lista todos los agentes con el estado de soporte de habilidades |
|
|
352
369
|
| `--timeout <ms>` | No | Tiempo de espera de la solicitud en milisegundos (por defecto: 60000) |
|
|
353
370
|
|
|
@@ -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
|
-
|
|
377
|
+
|
|
361
378
|
|
|
362
379
|
## `remove-plugin`
|
|
363
380
|
|
|
@@ -367,27 +384,27 @@ Elimina el plugin Unity-MCP del archivo `Packages/manifest.json` de un proyecto
|
|
|
367
384
|
unity-mcp-cli remove-plugin ./MyGame
|
|
368
385
|
```
|
|
369
386
|
|
|
370
|
-
|
|
|
387
|
+
| Opcion | Requerido | Descripcion |
|
|
371
388
|
|---|---|---|
|
|
372
|
-
| `[path]` |
|
|
389
|
+
| `[path]` | Si | Ruta al proyecto de Unity (posicional o `--path`) |
|
|
373
390
|
|
|
374
391
|
Este comando:
|
|
375
392
|
1. Elimina `com.ivanmurzak.unity.mcp` de `dependencies`
|
|
376
|
-
2. **Conserva los registros de
|
|
377
|
-
3. **No realiza ninguna
|
|
393
|
+
2. **Conserva los registros de ambito y sus ambitos** — otros paquetes pueden depender de ellos
|
|
394
|
+
3. **No realiza ninguna accion** si el plugin no esta instalado
|
|
378
395
|
|
|
379
|
-
>
|
|
396
|
+
> Despues de ejecutar este comando, abre el proyecto en el Editor de Unity para aplicar el cambio.
|
|
380
397
|
|
|
381
|
-
|
|
398
|
+
|
|
382
399
|
|
|
383
|
-
## Opciones
|
|
400
|
+
## Opciones globales
|
|
384
401
|
|
|
385
|
-
Estas opciones
|
|
402
|
+
Estas opciones estan disponibles en todos los comandos:
|
|
386
403
|
|
|
387
|
-
|
|
|
404
|
+
| Opcion | Descripcion |
|
|
388
405
|
|---|---|
|
|
389
|
-
| `-v, --verbose` | Activa la salida de
|
|
390
|
-
| `--version` | Muestra la
|
|
406
|
+
| `-v, --verbose` | Activa la salida de diagnostico detallada para resolucion de problemas |
|
|
407
|
+
| `--version` | Muestra la version de la CLI |
|
|
391
408
|
| `--help` | Muestra la ayuda del comando |
|
|
392
409
|
|
|
393
410
|
**Ejemplo — ejecutar cualquier comando con salida detallada:**
|
|
@@ -396,61 +413,64 @@ Estas opciones están disponibles en todos los comandos:
|
|
|
396
413
|
unity-mcp-cli install-plugin ./MyGame --verbose
|
|
397
414
|
```
|
|
398
415
|
|
|
399
|
-
|
|
416
|
+
|
|
400
417
|
|
|
401
|
-
# Ejemplo de
|
|
418
|
+
# Ejemplo de automatizacion completa
|
|
402
419
|
|
|
403
420
|
Configura un proyecto Unity MCP completo desde cero con un solo script:
|
|
404
421
|
|
|
405
422
|
```bash
|
|
406
|
-
# 1.
|
|
423
|
+
# 1. Create a new Unity project
|
|
407
424
|
unity-mcp-cli create-project ./MyAIGame --unity 6000.3.1f1
|
|
408
425
|
|
|
409
|
-
# 2.
|
|
426
|
+
# 2. Install the Unity-MCP plugin
|
|
410
427
|
unity-mcp-cli install-plugin ./MyAIGame
|
|
411
428
|
|
|
412
|
-
# 3.
|
|
429
|
+
# 3. Enable all MCP tools
|
|
413
430
|
unity-mcp-cli configure ./MyAIGame --enable-all-tools
|
|
414
431
|
|
|
415
|
-
# 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
|
|
416
436
|
unity-mcp-cli setup-mcp claude-code ./MyAIGame
|
|
417
437
|
|
|
418
|
-
#
|
|
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
|
-
|
|
444
|
+
|
|
425
445
|
|
|
426
|
-
#
|
|
446
|
+
# Como funciona
|
|
427
447
|
|
|
428
|
-
### Puerto
|
|
448
|
+
### Puerto determinista
|
|
429
449
|
|
|
430
|
-
La CLI genera un **puerto determinista** para cada proyecto de Unity
|
|
450
|
+
La CLI genera un **puerto determinista** para cada proyecto de Unity basandose en la ruta de su directorio (hash SHA256 mapeado al rango de puertos 20000–29999). Esto coincide con la generacion de puertos del plugin de Unity, garantizando que el servidor y el plugin acuerden automaticamente el mismo puerto sin necesidad de configuracion manual.
|
|
431
451
|
|
|
432
|
-
###
|
|
452
|
+
### Instalacion del plugin
|
|
433
453
|
|
|
434
454
|
El comando `install-plugin` modifica `Packages/manifest.json` directamente:
|
|
435
|
-
- Agrega el registro de
|
|
436
|
-
- Registra todos los
|
|
437
|
-
- Agrega la dependencia `com.ivanmurzak.unity.mcp` con actualizaciones que respetan la
|
|
455
|
+
- Agrega el registro de ambito de [OpenUPM](https://openupm.com/) (`package.openupm.com`)
|
|
456
|
+
- Registra todos los ambitos requeridos (`com.ivanmurzak`, `extensions.unity`, `org.nuget.*`)
|
|
457
|
+
- Agrega la dependencia `com.ivanmurzak.unity.mcp` con actualizaciones que respetan la version (nunca degrada)
|
|
438
458
|
|
|
439
|
-
### Archivo de
|
|
459
|
+
### Archivo de configuracion
|
|
440
460
|
|
|
441
461
|
El comando `configure` lee y escribe `UserSettings/AI-Game-Developer-Config.json`, que controla:
|
|
442
462
|
- **Tools** — herramientas MCP disponibles para los agentes de IA
|
|
443
463
|
- **Prompts** — prompts predefinidos inyectados en las conversaciones con el LLM
|
|
444
464
|
- **Resources** — datos de solo lectura expuestos a los agentes de IA
|
|
445
|
-
- **Connection settings** — URL del host, token de
|
|
465
|
+
- **Connection settings** — URL del host, token de autenticacion, metodo de transporte, tiempos de espera
|
|
446
466
|
|
|
447
|
-
###
|
|
467
|
+
### Integracion con Unity Hub
|
|
448
468
|
|
|
449
|
-
Los comandos que gestionan editores o crean proyectos usan la **CLI de Unity Hub** (modo `--headless`). Si Unity Hub no
|
|
450
|
-
- **Windows** —
|
|
469
|
+
Los comandos que gestionan editores o crean proyectos usan la **CLI de Unity Hub** (modo `--headless`). Si Unity Hub no esta instalado, la CLI **lo descarga e instala automaticamente**:
|
|
470
|
+
- **Windows** — instalacion silenciosa mediante `UnityHubSetup.exe /S` (puede requerir privilegios de administrador)
|
|
451
471
|
- **macOS** — descarga el DMG, lo monta y copia `Unity Hub.app` en `/Applications`
|
|
452
472
|
- **Linux** — descarga `UnityHub.AppImage` en `~/Applications/`
|
|
453
473
|
|
|
454
|
-
> Para la
|
|
474
|
+
> Para la documentacion completa del proyecto Unity-MCP, consulta el [README principal](https://github.com/IvanMurzak/Unity-MCP/blob/main/README.md).
|
|
455
475
|
|
|
456
|
-
|
|
476
|
+
|