@weppy/roblox-mcp 1.3.0 → 1.4.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.
Files changed (42) hide show
  1. package/.claude-plugin/marketplace.json +2 -2
  2. package/.github/ISSUE_TEMPLATE/bug_report.yml +60 -0
  3. package/.github/ISSUE_TEMPLATE/feature_request.yml +30 -0
  4. package/.github/ISSUE_TEMPLATE/install_help.yml +48 -0
  5. package/.github/PULL_REQUEST_TEMPLATE.md +16 -0
  6. package/.github/workflows/deploy-docs.yml +41 -0
  7. package/CHANGELOG.md +45 -0
  8. package/CODE_OF_CONDUCT.md +29 -0
  9. package/CONTRIBUTING.md +36 -0
  10. package/README.md +87 -20
  11. package/SECURITY.md +28 -0
  12. package/SUPPORT.md +27 -0
  13. package/docs/assets/screenshots/roblox-explorer/install-from-vsix.png +3 -0
  14. package/docs/assets/screenshots/roblox-explorer/roblox-explorer-screen.png +3 -0
  15. package/docs/assets/screenshots/sync.png +2 -2
  16. package/docs/compatibility.md +44 -0
  17. package/docs/en/installation/README.md +8 -0
  18. package/docs/en/installation/roblox-explorer.md +68 -0
  19. package/docs/en/sync/overview.md +10 -0
  20. package/docs/es/README.md +49 -20
  21. package/docs/es/installation/README.md +8 -0
  22. package/docs/es/sync/overview.md +10 -0
  23. package/docs/id/README.md +49 -20
  24. package/docs/id/installation/README.md +8 -0
  25. package/docs/id/sync/overview.md +10 -0
  26. package/docs/ja/README.md +51 -22
  27. package/docs/ja/installation/README.md +8 -0
  28. package/docs/ja/sync/overview.md +10 -0
  29. package/docs/ko/README.md +49 -20
  30. package/docs/ko/installation/README.md +8 -0
  31. package/docs/ko/installation/roblox-explorer.md +68 -0
  32. package/docs/ko/sync/overview.md +10 -0
  33. package/docs/pt-br/README.md +49 -20
  34. package/docs/pt-br/installation/README.md +8 -0
  35. package/docs/pt-br/sync/overview.md +10 -0
  36. package/docs/troubleshooting.md +47 -0
  37. package/llms-full.txt +599 -0
  38. package/llms.txt +55 -0
  39. package/package.json +1 -1
  40. package/plugins/weppy-roblox-mcp/.claude-plugin/plugin.json +1 -1
  41. package/plugins/weppy-roblox-mcp/dist/index.js +42 -42
  42. package/smithery.yaml +13 -0
@@ -0,0 +1,68 @@
1
+ # Weepy Roblox Explorer (VSCode Extension)
2
+
3
+ Roblox Studio Explorer-like tree view for VSCode. Browse synced instance trees, open scripts directly, and track sync status — all inside your editor.
4
+
5
+ ![Weepy Roblox Explorer](../../assets/screenshots/roblox-explorer/roblox-explorer-screen.png)
6
+
7
+ ## Requirements
8
+
9
+ - VSCode 1.85+
10
+ - [Roblox MCP](../../../README.md) Sync enabled (Basic or Pro)
11
+
12
+ ## Installation
13
+
14
+ ### 1. Download VSIX
15
+
16
+ Go to the [Releases](https://github.com/hope1026/roblox-mcp/releases) page and download the latest `weppy-roblox-explorer-*.vsix` file.
17
+
18
+ > The VSIX file is attached as a release asset alongside the plugin ZIP.
19
+
20
+ ### 2. Install in VSCode
21
+
22
+ 1. Open VSCode
23
+ 2. Open the Extensions sidebar (`Ctrl+Shift+X` / `Cmd+Shift+X`)
24
+ 3. Click the `...` menu at the top → **Install from VSIX...**
25
+
26
+ ![Install from VSIX](../../assets/screenshots/roblox-explorer/install-from-vsix.png)
27
+
28
+ 4. Select the downloaded `.vsix` file
29
+ 5. Reload VSCode when prompted
30
+
31
+ ## Features
32
+
33
+ - **Instance tree**: Service/instance hierarchy matching Roblox Studio
34
+ - **Roblox class icons**: Dark/light theme support with 200+ class icons
35
+ - **Multi-place**: Separate tree roots per synced place
36
+ - **Click-to-open**: Open backing files (`.server.luau`, `.client.luau`, `.module.luau`, `.props.json`)
37
+ - **Instance search**: QuickPick search across all services
38
+ - **Sync status badges**: See `modified`, `studio`, `conflict` states at a glance
39
+ - **Auto-refresh**: Tree updates automatically when sync files change (500ms debounce)
40
+ - **Copy instance path**: Right-click to copy `game.Workspace.Part` style paths
41
+
42
+ ## Settings
43
+
44
+ | Setting | Default | Description |
45
+ |---------|---------|-------------|
46
+ | `robloxExplorer.syncRoot` | `""` | Absolute path to `roblox-project-sync` root. Auto-discovered if empty. |
47
+ | `robloxExplorer.hidePropsFiles` | `false` | Hide sync artifact files (`.props.json`, `_tree.json`, `.value.json`) in the default VSCode explorer. |
48
+ | `robloxExplorer.autoRefresh` | `true` | Auto-refresh tree when sync files change. |
49
+ | `robloxExplorer.showSyncStatus` | `true` | Show sync status decorations on tree items. |
50
+
51
+ ## Commands
52
+
53
+ | Command | Description |
54
+ |---------|-------------|
55
+ | `Weepy Roblox Explorer: Refresh` | Manually refresh the instance tree |
56
+ | `Weepy Roblox Explorer: Search Instances` | Search instances across all services |
57
+ | `Weepy Roblox Explorer: Open Backing File` | Open the file backing a selected instance |
58
+ | `Weepy Roblox Explorer: Copy Instance Path` | Copy the full instance path (e.g. `game.Workspace.Part`) |
59
+ | `Weepy Roblox Explorer: Reveal in Explorer` | Show the backing file in the default VSCode explorer |
60
+
61
+ ## Updating
62
+
63
+ Download the latest `.vsix` from [Releases](https://github.com/hope1026/roblox-mcp/releases) and repeat the installation steps. VSCode will replace the existing version.
64
+
65
+ ## Related
66
+
67
+ - [Sync Deep Dive](../sync/overview.md)
68
+ - [Installation Guide](README.md)
@@ -20,6 +20,16 @@ Without Sync, AI only sees snippets pasted into chat. With Sync enabled, AI work
20
20
 
21
21
  Default local path is `roblox-project-sync/place_{placeId}/explorer`.
22
22
 
23
+ ### Browse sync data in VSCode
24
+
25
+ Install the [Weepy Roblox Explorer](../installation/roblox-explorer.md) extension to browse the synced instance tree in VSCode, just like in Roblox Studio.
26
+
27
+ ![Weepy Roblox Explorer — browse synced instance tree in VSCode](../../assets/screenshots/roblox-explorer/roblox-explorer-screen.png)
28
+
29
+ - Service/instance tree with Roblox class icons
30
+ - Click a script to open it for editing
31
+ - Sync status badges show modified/conflict state
32
+
23
33
  ## Basic vs Pro
24
34
 
25
35
  | Item | Basic | Pro |
package/docs/es/README.md CHANGED
@@ -1,16 +1,44 @@
1
1
  # Roblox MCP
2
2
 
3
- [English](../../README.md) | [한국어](../ko/README.md) | [日本語](../ja/README.md) | **Español** | [Português](../pt-br/README.md) | [Bahasa Indonesia](../id/README.md)
3
+ > Servidor MCP y plugin para Roblox Studio controla scripts, terrain, assets e iluminacion con Claude Code, Cursor, Codex y Gemini.
4
4
 
5
- > Habla con la IA y se ejecuta directamente en Roblox Studio.
5
+ [English](../../README.md) | [한국어](../ko/README.md) | [日本語](../ja/README.md) | **Español** | [Português](../pt-br/README.md) | [Bahasa Indonesia](../id/README.md)
6
6
 
7
7
  [![Demo](https://img.youtube.com/vi/3jrUpBbZPaw/maxresdefault.jpg)](https://youtu.be/3jrUpBbZPaw)
8
8
 
9
+ ## Instalacion rapida (5 minutos)
10
+
11
+ **Paso 1** — Instala el plugin de Roblox Studio (puente entre Studio e IA):
12
+ [Guia de instalacion del plugin](../en/installation/roblox-plugin.md)
13
+
14
+ **Paso 2** — Registra el servidor MCP en tu app de IA:
15
+
16
+ ```bash
17
+ npx -y @weppy/roblox-mcp
18
+ ```
19
+
20
+ | App de IA | Guia |
21
+ |-----------|------|
22
+ | Claude Code | [Configuracion](../en/installation/ai-apps/claude-code.md) |
23
+ | Claude Desktop | [Configuracion](../en/installation/ai-apps/claude-app.md) |
24
+ | Codex CLI | [Configuracion](../en/installation/ai-apps/codex-cli.md) |
25
+ | Codex Desktop | [Configuracion](../en/installation/ai-apps/codex-app.md) |
26
+ | Gemini CLI | [Configuracion](../en/installation/ai-apps/gemini-cli.md) |
27
+
28
+ > Funciona con cualquier cliente MCP compatible. El comando del servidor es `npx -y @weppy/roblox-mcp`.
29
+
30
+ ## Compatibilidad
31
+
32
+ | Claude Code | Claude Desktop | Cursor | Codex CLI | Gemini CLI |
33
+ |:-----------:|:--------------:|:------:|:---------:|:----------:|
34
+ | ✅ | ✅ | ✅ | ✅ | ✅ |
35
+
36
+ **Requisitos:** Node.js 18+, Roblox Studio, Windows 10+ o macOS 12+
37
+
9
38
  ## Funciones principales
10
39
 
11
40
  ### 1) MCP Tool: ejecuta en Studio desde lenguaje natural
12
41
 
13
- El primer eje de Roblox MCP es la **ejecucion de MCP Tool**.
14
42
  La IA puede manejar directamente scripts, instancias, propiedades, terreno, iluminacion, assets, audio y animacion dentro de Studio.
15
43
 
16
44
  - "Agrega particulas + sonido + cooldown cuando el jugador salte."
@@ -21,7 +49,6 @@ No es solo generacion de codigo. Son **acciones ejecutables orientadas a producc
21
49
 
22
50
  ### 2) Sync: mantiene el contexto completo del proyecto
23
51
 
24
- El segundo eje es **Project Sync**.
25
52
  La IA trabaja sobre un espejo local sincronizado, asi que los cambios en multiples archivos se mantienen consistentes.
26
53
 
27
54
  ![Flujo de Sync — Studio y archivos locales sincronizados en tiempo real](../assets/screenshots/sync.png)
@@ -29,7 +56,15 @@ La IA trabaja sobre un espejo local sincronizado, asi que los cambios en multipl
29
56
  - Basic: sincronizacion unidireccional (Studio -> Local)
30
57
  - Pro: sincronizacion bidireccional + Direction/Apply Mode por tipo + historial + multiplace
31
58
 
32
- Asi mantienes claro cual es la fuente de verdad y no pierdes contexto de cambios.
59
+ ### 3) Roblox Explorer: explora la jerarquia de Studio en VSCode
60
+
61
+ Visualiza el arbol completo de instancias de tu lugar en Roblox Studio directamente dentro de VSCode. Navega los servicios, abre scripts y archivos de propiedades sincronizados, y rastrea el estado de sincronizacion — todo sin cambiar a Studio.
62
+
63
+ ![Roblox Explorer — arbol de instancias de Studio mostrado en la barra lateral de VSCode](../assets/screenshots/roblox-explorer/roblox-explorer-screen.png)
64
+
65
+ - Iconos de clase iguales a Studio para reconocimiento inmediato
66
+ - Clic para abrir scripts y archivos de propiedades sincronizados
67
+ - Soporte multiplace con indicadores de estado de sincronizacion
33
68
 
34
69
  ## Valor inmediato para el usuario
35
70
 
@@ -40,25 +75,19 @@ Asi mantienes claro cual es la fuente de verdad y no pierdes contexto de cambios
40
75
 
41
76
  ## Documentacion detallada
42
77
 
43
- - [Cobertura de herramientas (Tools Overview)](tools/overview.md)
44
- - [Guia detallada de Sync](sync/overview.md)
45
-
46
- ## Comenzar
47
-
48
- La instalacion se completa en dos pasos:
49
-
50
- 1. **Instalar el plugin de Roblox Studio** — Hace de puente entre Studio e IA
51
- 2. **Registrar el servidor MCP en tu app de IA** — Para que la app de IA lo reconozca
52
-
53
- Solo toma 5 minutos. 👉 [Ver guia de instalacion](installation/README.md)
78
+ - [Guia de instalacion](../en/installation/README.md)
79
+ - [Cobertura de herramientas](../en/tools/overview.md)
80
+ - [Guia detallada de Sync](../en/sync/overview.md)
81
+ - [Roblox Explorer (Extension VSCode)](../en/installation/roblox-explorer.md)
82
+ - [Compatibilidad](../compatibility.md)
83
+ - [Solucion de problemas](../troubleshooting.md)
54
84
 
55
85
  ## Upgrade Pro
56
86
 
57
87
  Sync bidireccional, capacidades de creacion avanzadas y eficiencia de tokens de IA — todo en una sola actualizacion.
58
88
 
59
- 👉 [Guia de actualizacion Pro](pro-upgrade.md)
89
+ [Guia de actualizacion Pro](../en/pro-upgrade.md)
60
90
 
61
- ## Enlaces
91
+ ---
62
92
 
63
- - [GitHub](https://github.com/hope1026/roblox-mcp)
64
- - [Reportar problemas](https://github.com/hope1026/roblox-mcp/issues)
93
+ [GitHub Issues](https://github.com/hope1026/roblox-mcp/issues) · [Discussions](https://github.com/hope1026/roblox-mcp/discussions) · [npm](https://www.npmjs.com/package/@weppy/roblox-mcp)
@@ -34,6 +34,14 @@ Configura el servidor MCP en tu app de IA para que pueda comunicarse con Roblox
34
34
  > npx -y @weppy/roblox-mcp
35
35
  > ```
36
36
 
37
+ ## Opcional: Instalar Roblox Explorer (Extensión VSCode)
38
+
39
+ Explora los árboles de instancias sincronizados dentro de VSCode con iconos de clases Roblox.
40
+
41
+ 👉 [Guía de instalación de Roblox Explorer](roblox-explorer.md)
42
+
43
+ ---
44
+
37
45
  ## Después de la Instalación
38
46
 
39
47
  Prueba con un comando simple:
@@ -20,6 +20,16 @@ Sin Sync, la IA solo ve fragmentos pegados en el chat. Con Sync activo, trabaja
20
20
 
21
21
  La ruta local por defecto es `roblox-project-sync/place_{placeId}/explorer`.
22
22
 
23
+ ### Explorar datos sincronizados en VSCode
24
+
25
+ Instala la extension [Weepy Roblox Explorer](../installation/roblox-explorer.md) para explorar el arbol de instancias sincronizado en VSCode, igual que en Roblox Studio.
26
+
27
+ ![Weepy Roblox Explorer — explorar el arbol de instancias sincronizado en VSCode](../../assets/screenshots/roblox-explorer/roblox-explorer-screen.png)
28
+
29
+ - Arbol de servicios/instancias con iconos de clases Roblox
30
+ - Haz clic en un script para abrirlo y editarlo
31
+ - Badges de estado de sync muestran el estado modificado/conflicto
32
+
23
33
  ## Basic vs Pro
24
34
 
25
35
  | Item | Basic | Pro |
package/docs/id/README.md CHANGED
@@ -1,16 +1,44 @@
1
1
  # Roblox MCP
2
2
 
3
- [English](../../README.md) | [한국어](../ko/README.md) | [日本語](../ja/README.md) | [Español](../es/README.md) | [Português](../pt-br/README.md) | **Bahasa Indonesia**
3
+ > Server MCP dan plugin untuk Roblox Studio kendalikan script, terrain, asset, dan lighting dengan Claude Code, Cursor, Codex, dan Gemini.
4
4
 
5
- > Bicara ke AI, langsung dijalankan di Roblox Studio.
5
+ [English](../../README.md) | [한국어](../ko/README.md) | [日本語](../ja/README.md) | [Español](../es/README.md) | [Português](../pt-br/README.md) | **Bahasa Indonesia**
6
6
 
7
7
  [![Demo](https://img.youtube.com/vi/3jrUpBbZPaw/maxresdefault.jpg)](https://youtu.be/3jrUpBbZPaw)
8
8
 
9
+ ## Instalasi Cepat (5 menit)
10
+
11
+ **Langkah 1** — Install plugin Roblox Studio (jembatan antara Studio dan AI):
12
+ [Panduan instalasi plugin](../en/installation/roblox-plugin.md)
13
+
14
+ **Langkah 2** — Daftarkan MCP server di aplikasi AI:
15
+
16
+ ```bash
17
+ npx -y @weppy/roblox-mcp
18
+ ```
19
+
20
+ | Aplikasi AI | Panduan |
21
+ |-------------|---------|
22
+ | Claude Code | [Setup](../en/installation/ai-apps/claude-code.md) |
23
+ | Claude Desktop | [Setup](../en/installation/ai-apps/claude-app.md) |
24
+ | Codex CLI | [Setup](../en/installation/ai-apps/codex-cli.md) |
25
+ | Codex Desktop | [Setup](../en/installation/ai-apps/codex-app.md) |
26
+ | Gemini CLI | [Setup](../en/installation/ai-apps/gemini-cli.md) |
27
+
28
+ > Bekerja dengan semua klien MCP yang kompatibel. Perintah server: `npx -y @weppy/roblox-mcp`
29
+
30
+ ## Kompatibilitas
31
+
32
+ | Claude Code | Claude Desktop | Cursor | Codex CLI | Gemini CLI |
33
+ |:-----------:|:--------------:|:------:|:---------:|:----------:|
34
+ | ✅ | ✅ | ✅ | ✅ | ✅ |
35
+
36
+ **Persyaratan:** Node.js 18+, Roblox Studio, Windows 10+ atau macOS 12+
37
+
9
38
  ## Fitur utama
10
39
 
11
40
  ### 1) MCP Tool: eksekusi langsung di Studio dari bahasa alami
12
41
 
13
- Pilar pertama Roblox MCP adalah **eksekusi MCP Tool**.
14
42
  AI bisa langsung menangani script, instance, properti, terrain, lighting, asset, audio, dan animasi di dalam Studio.
15
43
 
16
44
  - "Tambahkan partikel + suara + cooldown saat player melompat."
@@ -21,7 +49,6 @@ Ini bukan sekadar generate kode. Ini adalah **aksi yang benar-benar bisa dieksek
21
49
 
22
50
  ### 2) Sync: menjaga konteks penuh proyek untuk AI
23
51
 
24
- Pilar kedua adalah **Project Sync**.
25
52
  AI bekerja dari mirror lokal yang tersinkron, jadi perubahan lintas banyak file tetap konsisten.
26
53
 
27
54
  ![Alur Sync — Studio dan file lokal tersinkron secara real time](../assets/screenshots/sync.png)
@@ -29,7 +56,15 @@ AI bekerja dari mirror lokal yang tersinkron, jadi perubahan lintas banyak file
29
56
  - Basic: sinkronisasi satu arah (Studio -> Local)
30
57
  - Pro: sinkronisasi dua arah + Direction/Apply Mode per tipe + riwayat + multiplace
31
58
 
32
- Dengan begitu sumber kebenaran tetap jelas dan konteks perubahan tidak hilang.
59
+ ### 3) Roblox Explorer: jelajahi hierarki Studio di VSCode
60
+
61
+ Lihat seluruh pohon instance dari place Roblox Studio langsung di dalam VSCode. Navigasi service, buka script dan file properti yang tersinkron, dan pantau status sinkronisasi — semua tanpa beralih ke Studio.
62
+
63
+ ![Roblox Explorer — pohon instance Studio ditampilkan di sidebar VSCode](../assets/screenshots/roblox-explorer/roblox-explorer-screen.png)
64
+
65
+ - Ikon class yang sama dengan Studio untuk pengenalan instan
66
+ - Klik untuk membuka script dan file properti yang tersinkron
67
+ - Dukungan multiplace dengan indikator status sinkronisasi
33
68
 
34
69
  ## Nilai yang langsung terasa
35
70
 
@@ -40,25 +75,19 @@ Dengan begitu sumber kebenaran tetap jelas dan konteks perubahan tidak hilang.
40
75
 
41
76
  ## Dokumen detail
42
77
 
43
- - [Cakupan tool (Tools Overview)](tools/overview.md)
44
- - [Panduan detail Sync](sync/overview.md)
45
-
46
- ## Mulai
47
-
48
- Instalasi cuma dua langkah:
49
-
50
- 1. **Install plugin Roblox Studio** — Jembatan antara Studio dan AI
51
- 2. **Daftarkan MCP server di aplikasi AI** — Biar AI-mu mengenali Roblox MCP
52
-
53
- 5 menit kelar. 👉 [Lihat panduan instalasi](installation/README.md)
78
+ - [Panduan instalasi](../en/installation/README.md)
79
+ - [Cakupan tool](../en/tools/overview.md)
80
+ - [Panduan detail Sync](../en/sync/overview.md)
81
+ - [Roblox Explorer (Ekstensi VSCode)](../en/installation/roblox-explorer.md)
82
+ - [Kompatibilitas](../compatibility.md)
83
+ - [Panduan pemecahan masalah](../troubleshooting.md)
54
84
 
55
85
  ## Upgrade Pro
56
86
 
57
87
  Sync dua arah, kemampuan kreasi lanjutan, dan efisiensi token AI — semua dalam satu upgrade.
58
88
 
59
- 👉 [Panduan Upgrade Pro](pro-upgrade.md)
89
+ [Panduan Upgrade Pro](../en/pro-upgrade.md)
60
90
 
61
- ## Link
91
+ ---
62
92
 
63
- - [GitHub](https://github.com/hope1026/roblox-mcp)
64
- - [Laporkan Masalah](https://github.com/hope1026/roblox-mcp/issues)
93
+ [GitHub Issues](https://github.com/hope1026/roblox-mcp/issues) · [Discussions](https://github.com/hope1026/roblox-mcp/discussions) · [npm](https://www.npmjs.com/package/@weppy/roblox-mcp)
@@ -39,6 +39,14 @@ Daftarkan MCP server ke aplikasi AI yang kamu pakai. Bisa digunakan di semua apl
39
39
 
40
40
  ---
41
41
 
42
+ ## Opsional: Install Roblox Explorer (Ekstensi VSCode)
43
+
44
+ Jelajahi tree instance yang sudah disinkronkan di dalam VSCode dengan ikon kelas Roblox.
45
+
46
+ 👉 [Panduan Instalasi Roblox Explorer](roblox-explorer.md)
47
+
48
+ ---
49
+
42
50
  ## Setelah Instalasi Selesai
43
51
 
44
52
  1. Buka **Roblox Studio**, di tab Plugins klik **W-MCP** → **Connect**
@@ -20,6 +20,16 @@ Tanpa Sync, AI hanya melihat potongan kode yang ditempel di chat. Dengan Sync ak
20
20
 
21
21
  Path lokal default adalah `roblox-project-sync/place_{placeId}/explorer`.
22
22
 
23
+ ### Jelajahi data sync di VSCode
24
+
25
+ Instal ekstensi [Weepy Roblox Explorer](../installation/roblox-explorer.md) untuk menjelajahi tree instance yang sudah tersinkron di VSCode, seperti di Roblox Studio.
26
+
27
+ ![Weepy Roblox Explorer — jelajahi tree instance yang tersinkron di VSCode](../../assets/screenshots/roblox-explorer/roblox-explorer-screen.png)
28
+
29
+ - Tree service/instance dengan ikon kelas Roblox
30
+ - Klik script untuk membukanya dan mengedit
31
+ - Badge status sync menampilkan status modified/conflict
32
+
23
33
  ## Basic vs Pro
24
34
 
25
35
  | Item | Basic | Pro |
package/docs/ja/README.md CHANGED
@@ -1,16 +1,44 @@
1
1
  # Roblox MCP
2
2
 
3
- [English](../../README.md) | [한국어](../ko/README.md) | **日本語** | [Español](../es/README.md) | [Português](../pt-br/README.md) | [Bahasa Indonesia](../id/README.md)
3
+ > Roblox Studio用MCPサーバー&プラグイン Claude Code、Cursor、Codex、GeminiでスクリプトやTerrain、アセット、ライティングをAI制御。
4
4
 
5
- > AIに話しかけるだけで、Roblox Studioで実行されます。
5
+ [English](../../README.md) | [한국어](../ko/README.md) | **日本語** | [Español](../es/README.md) | [Português](../pt-br/README.md) | [Bahasa Indonesia](../id/README.md)
6
6
 
7
7
  [![デモ](https://img.youtube.com/vi/3jrUpBbZPaw/maxresdefault.jpg)](https://youtu.be/3jrUpBbZPaw)
8
8
 
9
+ ## クイックインストール(5分)
10
+
11
+ **Step 1** — Roblox Studioプラグインのインストール(StudioとAIを接続する橋渡し):
12
+ [プラグインインストールガイド](../en/installation/roblox-plugin.md)
13
+
14
+ **Step 2** — AIアプリにMCPサーバーを登録:
15
+
16
+ ```bash
17
+ npx -y @weppy/roblox-mcp
18
+ ```
19
+
20
+ | AIアプリ | ガイド |
21
+ |---------|--------|
22
+ | Claude Code | [セットアップ](../en/installation/ai-apps/claude-code.md) |
23
+ | Claude Desktop | [セットアップ](../en/installation/ai-apps/claude-app.md) |
24
+ | Codex CLI | [セットアップ](../en/installation/ai-apps/codex-cli.md) |
25
+ | Codex Desktop | [セットアップ](../en/installation/ai-apps/codex-app.md) |
26
+ | Gemini CLI | [セットアップ](../en/installation/ai-apps/gemini-cli.md) |
27
+
28
+ > MCP対応のAIアプリであれば利用できます。サーバーコマンド: `npx -y @weppy/roblox-mcp`
29
+
30
+ ## 互換性
31
+
32
+ | Claude Code | Claude Desktop | Cursor | Codex CLI | Gemini CLI |
33
+ |:-----------:|:--------------:|:------:|:---------:|:----------:|
34
+ | ✅ | ✅ | ✅ | ✅ | ✅ |
35
+
36
+ **要件:** Node.js 18+、Roblox Studio、Windows 10+ または macOS 12+
37
+
9
38
  ## 主要機能
10
39
 
11
40
  ### 1) MCP Tool: 自然言語の指示をStudioで直接実行
12
41
 
13
- Roblox MCPの第一の柱は**MCP Tool実行**です。
14
42
  AIがStudio内で、スクリプト、インスタンス、プロパティ、地形、ライティング、アセット、オーディオ、アニメーションを直接処理します。
15
43
 
16
44
  - 「プレイヤーのジャンプ時に、パーティクル + サウンド + クールタイムを追加して。」
@@ -21,44 +49,45 @@ AIがStudio内で、スクリプト、インスタンス、プロパティ、地
21
49
 
22
50
  ### 2) Sync: AIがプロジェクト全体の文脈を維持
23
51
 
24
- 第二の柱は**Project Sync**です。
25
52
  同期されたローカルミラーを基準にAIが作業するため、複数ファイルにまたがる変更も一貫して適用できます。
26
53
 
27
54
  ![Syncワークフロー — Studioとローカルファイルがリアルタイムで同期される様子](../assets/screenshots/sync.png)
28
55
 
29
- - Basic: 片方向同期 (Studio -> Local)
56
+ - Basic: 片方向同期(Studio -> Local
30
57
  - Pro: 双方向同期 + タイプ別Direction/Apply Mode + 変更履歴 + マルチPlace
31
58
 
32
- どちらを正とするかを明確に保ち、変更文脈の取りこぼしを防げます。
59
+ ### 3) Roblox Explorer: VSCodeでStudioの階層構造を閲覧
60
+
61
+ Roblox Studioのインスタンスツリー全体をVSCode内で直接確認できます。サービスを探索し、同期されたスクリプトやプロパティファイルを開き、同期状態を追跡 — Studioに切り替える必要はありません。
62
+
63
+ ![Roblox Explorer — VSCodeサイドバーに表示されるStudioインスタンスツリー](../assets/screenshots/roblox-explorer/roblox-explorer-screen.png)
64
+
65
+ - Studio同様のクラスアイコンで直感的に識別
66
+ - クリックで同期済みスクリプトとプロパティファイルを開く
67
+ - 同期状態表示付きのマルチPlaceサポート
33
68
 
34
69
  ## すぐに実感できる価値
35
70
 
36
71
  - 反復作業を圧縮: 多数の手作業を1つの指示に集約
37
72
  - 関連ファイルを同時に変更: 単一ファイル修正で終わらない
38
73
  - リスク低減: 同期状態と履歴を見ながら安全に変更
39
- - トークン効率向上 (Pro): バルク処理で往復回数を削減
74
+ - トークン効率向上(Pro): バルク処理で往復回数を削減
40
75
 
41
76
  ## 詳細ドキュメント
42
77
 
43
- - [Tool対応範囲 (Tools Overview)](tools/overview.md)
44
- - [Sync機能詳細ガイド](sync/overview.md)
45
-
46
- ## はじめに
47
-
48
- インストールは2つのステップで完了します:
49
-
50
- 1. **Roblox Studioプラグインのインストール** — StudioとAIを接続する橋渡し
51
- 2. **AIアプリにMCPサーバーを登録** — 使用するAIアプリでRoblox MCPを認識
52
-
53
- 5分で終わります。👉 [インストールガイド](installation/README.md)
78
+ - [インストールガイド](../en/installation/README.md)
79
+ - [Tool対応範囲](../en/tools/overview.md)
80
+ - [Sync機能詳細ガイド](../en/sync/overview.md)
81
+ - [Roblox Explorer (VSCode拡張)](../en/installation/roblox-explorer.md)
82
+ - [互換性](../compatibility.md)
83
+ - [トラブルシューティング](../troubleshooting.md)
54
84
 
55
85
  ## Proアップグレード
56
86
 
57
87
  双方向Sync、高度な制作機能、AIトークン効率 — 一度のアップグレードで全てを手に入れる。
58
88
 
59
- 👉 [Proアップグレードガイド](pro-upgrade.md)
89
+ [Proアップグレードガイド](../en/pro-upgrade.md)
60
90
 
61
- ## リンク
91
+ ---
62
92
 
63
- - [GitHub](https://github.com/hope1026/roblox-mcp)
64
- - [Issue報告](https://github.com/hope1026/roblox-mcp/issues)
93
+ [GitHubイシュー](https://github.com/hope1026/roblox-mcp/issues) · [Discussions](https://github.com/hope1026/roblox-mcp/discussions) · [npm](https://www.npmjs.com/package/@weppy/roblox-mcp)
@@ -39,6 +39,14 @@ GitHubからプラグインファイルをダウンロードして、Roblox Stud
39
39
 
40
40
  ---
41
41
 
42
+ ## オプション: Roblox Explorer (VSCode拡張) のインストール
43
+
44
+ 同期されたインスタンスツリーをRobloxクラスアイコン付きでVSCode内で閲覧できます。
45
+
46
+ 👉 [Roblox Explorerインストールガイド](roblox-explorer.md)
47
+
48
+ ---
49
+
42
50
  ## インストール後
43
51
 
44
52
  1. **Roblox Studio**を開き、Pluginsタブから **W-MCP** → **Connect** をクリック
@@ -20,6 +20,16 @@ Syncがない場合、AIはチャットに貼られた断片だけを見て判
20
20
 
21
21
  ローカルの既定パスは `roblox-project-sync/place_{placeId}/explorer` です。
22
22
 
23
+ ### VSCodeで同期データを閲覧する
24
+
25
+ [Weepy Roblox Explorer](../installation/roblox-explorer.md) 拡張機能をインストールすると、Roblox Studioと同じようにVSCode上で同期済みインスタンスツリーを閲覧できます。
26
+
27
+ ![Weepy Roblox Explorer — VSCodeで同期済みインスタンスツリーを閲覧](../../assets/screenshots/roblox-explorer/roblox-explorer-screen.png)
28
+
29
+ - Robloxクラスアイコン付きのサービス/インスタンスツリー
30
+ - スクリプトをクリックして編集用に開く
31
+ - 同期ステータスバッジで変更/コンフリクト状態を表示
32
+
23
33
  ## Basic vs Pro
24
34
 
25
35
  | 項目 | Basic | Pro |
package/docs/ko/README.md CHANGED
@@ -1,16 +1,44 @@
1
1
  # Roblox MCP
2
2
 
3
+ > Roblox Studio용 MCP 서버 및 플러그인 — Claude Code, Cursor, Codex, Gemini로 스크립트, 지형, 에셋, 조명을 AI로 제어합니다.
4
+
3
5
  [English](../../README.md) | **한국어** | [日本語](../ja/README.md) | [Español](../es/README.md) | [Português](../pt-br/README.md) | [Bahasa Indonesia](../id/README.md)
4
6
 
5
- > AI에게 말하면, Roblox Studio에서 바로 실행됩니다.
7
+ [![데모](https://img.youtube.com/vi/3jrUpBbZPaw/maxresdefault.jpg)](https://youtu.be/3jrUpBbZPaw)
8
+
9
+ ## 빠른 설치 (5분)
10
+
11
+ **1단계** — Roblox Studio 플러그인 설치 (Studio와 AI를 연결하는 다리):
12
+ [플러그인 설치 가이드](../en/installation/roblox-plugin.md)
13
+
14
+ **2단계** — AI 앱에 MCP 서버 등록:
15
+
16
+ ```bash
17
+ npx -y @weppy/roblox-mcp
18
+ ```
19
+
20
+ | AI 앱 | 가이드 |
21
+ |-------|--------|
22
+ | Claude Code | [설정](../en/installation/ai-apps/claude-code.md) |
23
+ | Claude Desktop | [설정](../en/installation/ai-apps/claude-app.md) |
24
+ | Codex CLI | [설정](../en/installation/ai-apps/codex-cli.md) |
25
+ | Codex Desktop | [설정](../en/installation/ai-apps/codex-app.md) |
26
+ | Gemini CLI | [설정](../en/installation/ai-apps/gemini-cli.md) |
27
+
28
+ > MCP를 지원하는 모든 AI 앱에서 사용 가능합니다. 서버 명령어: `npx -y @weppy/roblox-mcp`
29
+
30
+ ## 호환성
6
31
 
7
- [![Demo](https://img.youtube.com/vi/3jrUpBbZPaw/maxresdefault.jpg)](https://youtu.be/3jrUpBbZPaw)
32
+ | Claude Code | Claude Desktop | Cursor | Codex CLI | Gemini CLI |
33
+ |:-----------:|:--------------:|:------:|:---------:|:----------:|
34
+ | ✅ | ✅ | ✅ | ✅ | ✅ |
35
+
36
+ **요구 사항:** Node.js 18+, Roblox Studio, Windows 10+ 또는 macOS 12+
8
37
 
9
38
  ## 핵심 기능
10
39
 
11
40
  ### 1) MCP Tool: 말로 지시하면 Studio에서 바로 실행
12
41
 
13
- Roblox MCP의 첫 번째 축은 **MCP Tool 실행 능력**입니다.
14
42
  스크립트, 인스턴스, 속성, 지형, 조명, 에셋, 오디오, 애니메이션까지 AI가 Studio에서 직접 처리합니다.
15
43
 
16
44
  - "플레이어 점프 시 파티클 + 사운드 + 쿨타임까지 한 번에 넣어줘."
@@ -21,7 +49,6 @@ Roblox MCP의 첫 번째 축은 **MCP Tool 실행 능력**입니다.
21
49
 
22
50
  ### 2) Sync: AI가 프로젝트 전체 문맥을 읽고 유지
23
51
 
24
- 두 번째 축은 **Project Sync**입니다.
25
52
  AI가 로컬 동기화된 프로젝트를 기준으로 전체 구조를 이해해, 여러 파일에 걸친 변경을 일관되게 수행합니다.
26
53
 
27
54
  ![Sync 워크플로우 — Studio와 로컬 파일이 실시간으로 동기화되는 모습](../assets/screenshots/sync.png)
@@ -29,7 +56,15 @@ AI가 로컬 동기화된 프로젝트를 기준으로 전체 구조를 이해
29
56
  - Basic: Studio -> Local 단방향 동기화
30
57
  - Pro: 양방향 동기화 + 타입별 Direction/Apply Mode + 변경 기록 + 멀티 Place
31
58
 
32
- 즉, "지금 어떤 파일이 실제 기준인지", "무엇이 언제 바뀌었는지"를 놓치지 않고 협업할 수 있습니다.
59
+ ### 3) Roblox Explorer: VSCode에서 Studio 계층 구조 탐색
60
+
61
+ Roblox Studio의 전체 인스턴스 트리를 VSCode 안에서 바로 확인할 수 있습니다. 서비스를 탐색하고, 동기화된 스크립트와 속성 파일을 열고, 동기화 상태를 추적하세요 — Studio로 전환할 필요 없이.
62
+
63
+ ![Roblox Explorer — VSCode 사이드바에 표시되는 Studio 인스턴스 트리](../assets/screenshots/roblox-explorer/roblox-explorer-screen.png)
64
+
65
+ - Studio와 동일한 클래스 아이콘으로 직관적 구분
66
+ - 클릭으로 동기화된 스크립트와 속성 파일 열기
67
+ - 동기화 상태 표시를 포함한 멀티 Place 지원
33
68
 
34
69
  ## 유저가 바로 체감하는 장점
35
70
 
@@ -40,25 +75,19 @@ AI가 로컬 동기화된 프로젝트를 기준으로 전체 구조를 이해
40
75
 
41
76
  ## 세부 문서
42
77
 
43
- - [Tool 지원 범위 (Tools Overview)](tools/overview.md)
44
- - [Sync 기능 상세 가이드](sync/overview.md)
45
-
46
- ## 시작하기
47
-
48
- 설치는 단계로 완료됩니다:
49
-
50
- 1. **Roblox Studio 플러그인 설치** — Studio와 AI를 연결하는 다리 역할을 합니다
51
- 2. **AI 앱에 MCP 서버 등록** — 사용하는 AI 앱에서 Roblox MCP를 인식하도록 설정합니다
52
-
53
- 5분이면 끝나요. 👉 [설치 가이드 보기](installation/README.md)
78
+ - [설치 가이드](../en/installation/README.md)
79
+ - [Tool 지원 범위](../en/tools/overview.md)
80
+ - [Sync 기능 상세 가이드](../en/sync/overview.md)
81
+ - [Roblox Explorer (VSCode 확장)](installation/roblox-explorer.md)
82
+ - [호환성](../compatibility.md)
83
+ - [문제 해결 가이드](../troubleshooting.md)
54
84
 
55
85
  ## Pro로 업그레이드
56
86
 
57
87
  양방향 Sync, 고급 제작 기능, AI 토큰 효율 — 한 번의 업그레이드로 모두 누리세요.
58
88
 
59
- 👉 [Pro 업그레이드 가이드](pro-upgrade.md)
89
+ [Pro 업그레이드 가이드](../en/pro-upgrade.md)
60
90
 
61
- ## 링크
91
+ ---
62
92
 
63
- - [GitHub](https://github.com/hope1026/roblox-mcp)
64
- - [이슈 리포트](https://github.com/hope1026/roblox-mcp/issues)
93
+ [GitHub 이슈](https://github.com/hope1026/roblox-mcp/issues) · [Discussions](https://github.com/hope1026/roblox-mcp/discussions) · [npm](https://www.npmjs.com/package/@weppy/roblox-mcp)
@@ -39,6 +39,14 @@ GitHub에서 플러그인 파일을 다운로드한 뒤, Roblox Studio의 Plugin
39
39
 
40
40
  ---
41
41
 
42
+ ## 선택 사항: Roblox Explorer (VSCode 확장) 설치
43
+
44
+ 동기화된 인스턴스 트리를 Roblox 클래스 아이콘과 함께 VSCode에서 탐색할 수 있습니다.
45
+
46
+ 👉 [Roblox Explorer 설치 가이드](roblox-explorer.md)
47
+
48
+ ---
49
+
42
50
  ## 설치 완료 후
43
51
 
44
52
  1. **Roblox Studio**를 열고, Plugins 탭에서 **W-MCP** → **Connect** 클릭