@weppy/roblox-mcp 2.0.9 → 2.1.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 (123) hide show
  1. package/.claude-plugin/marketplace.json +2 -2
  2. package/CHANGELOG.md +39 -0
  3. package/README.md +11 -9
  4. package/docs/assets/screenshots/dashboard/dashboard_playtest.png +0 -0
  5. package/docs/assets/screenshots/plugin/sync/sync-overview.png +0 -0
  6. package/docs/en/dashboard/connection.md +1 -1
  7. package/docs/en/dashboard/overview.md +7 -7
  8. package/docs/en/dashboard/playtest.md +1 -1
  9. package/docs/en/dashboard/settings.md +1 -1
  10. package/docs/en/dashboard/sync.md +1 -1
  11. package/docs/en/dashboard/tools.md +1 -1
  12. package/docs/en/installation/README.md +1 -1
  13. package/docs/en/installation/roblox-explorer.md +2 -2
  14. package/docs/en/installation/roblox-plugin.md +4 -4
  15. package/docs/en/pro-upgrade.md +2 -2
  16. package/docs/en/sync/overview.md +3 -3
  17. package/docs/en/tools/playtest.md +2 -2
  18. package/docs/es/README.md +64 -12
  19. package/docs/es/dashboard/connection.md +1 -1
  20. package/docs/es/dashboard/overview.md +7 -7
  21. package/docs/es/dashboard/playtest.md +1 -1
  22. package/docs/es/dashboard/settings.md +1 -1
  23. package/docs/es/dashboard/sync.md +1 -1
  24. package/docs/es/dashboard/tools.md +1 -1
  25. package/docs/es/installation/README.md +1 -1
  26. package/docs/es/installation/roblox-explorer.md +2 -2
  27. package/docs/es/installation/roblox-plugin.md +4 -4
  28. package/docs/es/pro-upgrade.md +2 -2
  29. package/docs/es/sync/overview.md +3 -3
  30. package/docs/es/tools/playtest.md +2 -2
  31. package/docs/id/README.md +64 -12
  32. package/docs/id/dashboard/connection.md +1 -1
  33. package/docs/id/dashboard/overview.md +7 -7
  34. package/docs/id/dashboard/playtest.md +1 -1
  35. package/docs/id/dashboard/settings.md +1 -1
  36. package/docs/id/dashboard/sync.md +1 -1
  37. package/docs/id/dashboard/tools.md +1 -1
  38. package/docs/id/installation/README.md +1 -1
  39. package/docs/id/installation/roblox-explorer.md +2 -2
  40. package/docs/id/installation/roblox-plugin.md +4 -4
  41. package/docs/id/pro-upgrade.md +2 -2
  42. package/docs/id/sync/overview.md +3 -3
  43. package/docs/id/tools/playtest.md +2 -2
  44. package/docs/ja/README.md +64 -12
  45. package/docs/ja/dashboard/connection.md +1 -1
  46. package/docs/ja/dashboard/overview.md +7 -7
  47. package/docs/ja/dashboard/playtest.md +1 -1
  48. package/docs/ja/dashboard/settings.md +1 -1
  49. package/docs/ja/dashboard/sync.md +1 -1
  50. package/docs/ja/dashboard/tools.md +1 -1
  51. package/docs/ja/installation/README.md +1 -1
  52. package/docs/ja/installation/roblox-explorer.md +2 -2
  53. package/docs/ja/installation/roblox-plugin.md +4 -4
  54. package/docs/ja/pro-upgrade.md +2 -2
  55. package/docs/ja/sync/overview.md +3 -3
  56. package/docs/ja/tools/playtest.md +2 -2
  57. package/docs/ko/README.md +65 -13
  58. package/docs/ko/dashboard/connection.md +1 -1
  59. package/docs/ko/dashboard/overview.md +7 -7
  60. package/docs/ko/dashboard/playtest.md +1 -1
  61. package/docs/ko/dashboard/settings.md +1 -1
  62. package/docs/ko/dashboard/sync.md +1 -1
  63. package/docs/ko/dashboard/tools.md +1 -1
  64. package/docs/ko/installation/README.md +1 -1
  65. package/docs/ko/installation/roblox-explorer.md +2 -2
  66. package/docs/ko/installation/roblox-plugin.md +4 -4
  67. package/docs/ko/pro-upgrade.md +2 -2
  68. package/docs/ko/sync/overview.md +3 -3
  69. package/docs/ko/tools/playtest.md +2 -2
  70. package/docs/pt-br/README.md +64 -12
  71. package/docs/pt-br/dashboard/connection.md +1 -1
  72. package/docs/pt-br/dashboard/overview.md +7 -7
  73. package/docs/pt-br/dashboard/playtest.md +1 -1
  74. package/docs/pt-br/dashboard/settings.md +1 -1
  75. package/docs/pt-br/dashboard/sync.md +1 -1
  76. package/docs/pt-br/dashboard/tools.md +1 -1
  77. package/docs/pt-br/installation/README.md +1 -1
  78. package/docs/pt-br/installation/roblox-explorer.md +2 -2
  79. package/docs/pt-br/installation/roblox-plugin.md +4 -4
  80. package/docs/pt-br/pro-upgrade.md +2 -2
  81. package/docs/pt-br/sync/overview.md +3 -3
  82. package/docs/pt-br/tools/playtest.md +2 -2
  83. package/llms-full.txt +7 -7
  84. package/package.json +1 -1
  85. package/plugins/weppy-roblox-mcp/.claude-plugin/plugin.json +1 -1
  86. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/{ChangelogDetailPage-DRPIGDB0.js → ChangelogDetailPage-lzDR6yjY.js} +1 -1
  87. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/{ChangelogPage-DVPYTw2L.js → ChangelogPage-BscI67Aj.js} +1 -1
  88. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/ConfirmModal-BIJpNntn.js +1 -0
  89. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/ConnectionPage-CdLqNY4r.js +1 -0
  90. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/{InfoLabel-DzXzzs6Q.js → InfoLabel-CBAqTqRy.js} +1 -1
  91. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/OverviewPage-BOm0Ai9y.js +1 -0
  92. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/{PlaytestPage-BjBAsHLz.js → PlaytestPage-DaDbQ6Qa.js} +1 -1
  93. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/{PropertyDiff-BZMdMzMr.js → PropertyDiff-D34Apw3G.js} +1 -1
  94. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/SettingsPage-yWzPPZIB.js +1 -0
  95. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/{StatusBadge-DtcYlxe-.js → StatusBadge-B-pYMpUG.js} +1 -1
  96. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/SyncPage-E4XZhZn0.js +4 -0
  97. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/{TierPromoProgress-r5fgmYI5.js → TierPromoProgress-CqxKoPOJ.js} +1 -1
  98. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/{ToolsPage-Cfau3bX3.js → ToolsPage-yaahWgTq.js} +1 -1
  99. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/index-DYnjsp-e.css +1 -0
  100. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/index-E1cuNPsJ.js +129 -0
  101. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/{tier-promo-config-CQFDWwo4.js → tier-promo-config-BuGSENUv.js} +1 -1
  102. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/{useLiveUptime-5lD1XKnw.js → useLiveUptime-qJDofPOo.js} +1 -1
  103. package/plugins/weppy-roblox-mcp/dashboard/dist/index.html +2 -2
  104. package/plugins/weppy-roblox-mcp/dist/index.js +61 -61
  105. package/plugins/weppy-roblox-mcp/roblox-plugin/WeppyRobloxMCP.rbxm +0 -0
  106. package/docs/assets/screenshots/connection_popup.png +0 -0
  107. package/docs/assets/screenshots/sync.png +0 -0
  108. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/ConfirmModal-Db4rfrTo.js +0 -1
  109. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/ConfirmModal-tvPLhSO9.css +0 -1
  110. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/ConnectionPage-Cv2i3LSr.js +0 -1
  111. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/OverviewPage-FoC28UL8.js +0 -1
  112. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/SettingsPage-BKp2VKMW.js +0 -1
  113. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/SyncPage-DcELF5_j.js +0 -4
  114. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/index-BOVxaPTw.css +0 -1
  115. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/index-DWRH2iF4.js +0 -129
  116. /package/docs/assets/screenshots/{connection_guide.png → plugin/connection/connection-guide.png} +0 -0
  117. /package/docs/assets/screenshots/{plugin_main.png → plugin/installation/main-screen.png} +0 -0
  118. /package/docs/assets/screenshots/{plugins_menu.png → plugin/installation/plugins-menu.png} +0 -0
  119. /package/docs/assets/screenshots/{settings.png → plugin/installation/settings-screen.png} +0 -0
  120. /package/docs/assets/screenshots/{weppy_plugin_toolbar.png → plugin/installation/toolbar-button.png} +0 -0
  121. /package/docs/assets/screenshots/{license/license-dashboard.png → plugin/license/dashboard-license-screen.png} +0 -0
  122. /package/docs/assets/screenshots/{license/license-plugin.png → plugin/license/plugin-license-screen.png} +0 -0
  123. /package/docs/assets/screenshots/{sync_conflict.png → plugin/sync/sync-conflict.png} +0 -0
@@ -6,14 +6,14 @@
6
6
  },
7
7
  "metadata": {
8
8
  "description": "Weppy Roblox MCP — MCP server that lets AI coding agents control a live Roblox Studio session with 21 tools, 140+ actions, bidirectional sync, automated playtest, and multi-place support",
9
- "version": "2.0.9"
9
+ "version": "2.1.0"
10
10
  },
11
11
  "plugins": [
12
12
  {
13
13
  "name": "weppy-roblox-mcp",
14
14
  "source": "./plugins/weppy-roblox-mcp",
15
15
  "description": "Weppy Roblox MCP — MCP server that lets AI coding agents control a live Roblox Studio session with 21 tools, 140+ actions, bidirectional sync, automated playtest, and multi-place support",
16
- "version": "2.0.9",
16
+ "version": "2.1.0",
17
17
  "author": {
18
18
  "name": "hope1026"
19
19
  },
package/CHANGELOG.md CHANGED
@@ -21,6 +21,45 @@ All notable changes to this project will be documented in this file.
21
21
 
22
22
 
23
23
 
24
+
25
+
26
+ ## [2.1.0] - 2026-03-29
27
+
28
+ ### ⚠️ BREAKING CHANGES
29
+
30
+ - **Sync directory renamed**: `roblox-project-sync/` → `wrox-project-sync/`. All existing sync data will be stored under the new directory. The old `roblox-project-sync/` directory is no longer used.
31
+ - **App data directory renamed**: `~/.weppy-roblox-mcp` → `~/.wrox-data`. The old `~/.weppy-roblox-mcp` directory is no longer recognized.
32
+ - **Project sync resets from Studio**: After upgrading, project sync data is re-initialized from Studio as the source of truth. Any local-only changes not yet synced back to Studio will be lost — ensure your Studio state is up to date before upgrading.
33
+ - **License downgrade requires plugin action**: If your license changes from Pro to Basic, you **must** click "Refresh" in the plugin UI or deactivate and reactivate the plugin for the tier change to take effect. Without this step, the plugin may continue to report the previous tier.
34
+
35
+ ### Features
36
+
37
+ - **Dashboard project root switching**: Added the ability to change the project root directory directly from the Dashboard overview page, with restart and path migration support.
38
+ - **Dashboard Place UI improvements**: Redesigned the Place summary display for better visual clarity and usability.
39
+ - Dashboard place summary API and persistence for active project state
40
+ - Sync root switch flow with configurable overrides and path migration
41
+
42
+ ### Bug Fixes
43
+
44
+ - Harden sync-root switching with error handling and fallback resolution
45
+ - Preserve and surface dashboard sync-root restart errors
46
+ - Normalize observability sync roots and honor override root in runtime paths
47
+ - Cover remaining wrox runtime paths
48
+
49
+ ### Documentation
50
+
51
+ - Expand documentation with project rationale, use cases, FAQ, and license details across all locales
52
+ - Update sync data path documentation to reflect project-root-based storage
53
+
54
+
55
+ ## [2.0.10] - 2026-03-28
56
+
57
+ ### Improved
58
+
59
+ - Improved sync logic with play mode detection, suppression, and post-play reconciliation.
60
+ - Enhanced plugin UI for sync collision resolution.
61
+
62
+
24
63
  ## [2.0.9] - 2026-03-27
25
64
 
26
65
  ### Improved
package/README.md CHANGED
@@ -8,13 +8,13 @@
8
8
 
9
9
  [![Demo — AI building a Roblox game in real time](https://img.youtube.com/vi/3jrUpBbZPaw/maxresdefault.jpg)](https://youtu.be/3jrUpBbZPaw)
10
10
 
11
- ## Why WROX?
11
+ ## Why WROX (Weppy Roblox MCP)?
12
12
 
13
13
  AI coding agents like Claude, Codex, and Gemini are powerful — but they cannot see or modify anything inside Roblox Studio. The DataModel, scripts, terrain, and lighting are all invisible to external tools. Without a bridge, AI can only generate code snippets that you must paste manually.
14
14
 
15
- **WROX** provides a real-time bridge between AI agents and the Roblox Studio DataModel. It exposes the full Roblox API surface as executable MCP tools, so AI can **directly create, read, modify, and delete** instances, scripts, properties, terrain, and more inside a live Studio session.
15
+ **WROX** is a bridge between AI agents and Roblox Studio. AI directly creates and modifies instances, scripts, properties, terrain, and more inside Studio, and the changes are reflected immediately in Studio and the dashboard so you can **see exactly what changed**.
16
16
 
17
- This is not just code generation. It is **executable, production-oriented actions** running directly in Studio.
17
+ No copy-pasting code. AI does the work, you review the results.
18
18
 
19
19
  ## Quick Install
20
20
 
@@ -88,11 +88,11 @@ AI can directly handle scripts, instances, properties, terrain, lighting, assets
88
88
 
89
89
  AI works from a synchronized local mirror, so multi-file updates stay consistent.
90
90
 
91
- ![Sync workflow — Studio and local files synchronized in real time](docs/assets/screenshots/sync.png)
92
-
93
91
  - Basic: one-way sync (Studio -> Local)
94
92
  - Pro: bidirectional sync + per-type Direction/Apply Mode + history + multi-place
95
93
 
94
+ ![Sync workflow — Studio and local files synchronized in real time](docs/assets/screenshots/plugin/sync/sync-overview.png)
95
+
96
96
  ### 3) Playtest: Let AI run and verify tests automatically
97
97
 
98
98
  AI can control Roblox Studio playtests directly. It can start and stop Play (F5) or Run (F8), inject test scripts, collect logs, and generate local reports automatically.
@@ -101,28 +101,30 @@ AI can control Roblox Studio playtests directly. It can start and stop Play (F5)
101
101
  - "Write a test that verifies the SpawnLocation is above the ground and run it."
102
102
  - "Validate that the script I just changed runs without errors in playtest."
103
103
 
104
+ ![WROX Playtest Dashboard — Test history and detailed report](docs/assets/screenshots/dashboard/dashboard_playtest.png)
105
+
104
106
  ### 4) WROX Dashboard: Monitor AI work in real time
105
107
 
106
108
  The MCP server provides a web dashboard where you can check connection status, tool execution history, sync state, and game change logs in real time.
107
109
 
108
- ![WROX WROX Dashboard Overview — Server status, recent changes, and session summary](docs/assets/screenshots/dashboard/dashboard_overview.png)
109
-
110
110
  - Server/Plugin/Agent connection status at a glance
111
111
  - Compare every change the AI made via Before & After in Changelog
112
112
  - Analyze workflow with tool execution history and statistics
113
113
 
114
+ ![WROX WROX Dashboard Overview — Server status, recent changes, and session summary](docs/assets/screenshots/dashboard/dashboard_overview.png)
115
+
114
116
  ### 5) WROX Roblox Explorer: Browse Studio hierarchy in VSCode
115
117
 
116
118
  View the full instance tree of your Roblox Studio place directly inside VSCode. Navigate services, open synced scripts and property files, and track sync status — all without switching to Studio.
117
119
  WROX Roblox Explorer is a companion VSCode extension for sync data generated by WROX. Tree browsing works from synced files, and live sync state or direction indicators are enhanced when the local MCP server is running.
118
120
  Install from [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=weppy.weppy-roblox-explorer) or [Open VSX](https://open-vsx.org/extension/weppy/weppy-roblox-explorer).
119
121
 
120
- ![WROX Roblox Explorer — Studio instance tree displayed in VSCode sidebar](docs/assets/screenshots/roblox-explorer/roblox-explorer-screen.png)
121
-
122
122
  - Class icons matching Studio for instant recognition
123
123
  - Click to open synced scripts and property files
124
124
  - Multi-place support with sync status indicators
125
125
 
126
+ ![WROX Roblox Explorer — Studio instance tree displayed in VSCode sidebar](docs/assets/screenshots/roblox-explorer/roblox-explorer-screen.png)
127
+
126
128
  ## Use Cases
127
129
 
128
130
  - **Rapid prototyping**: Describe a game mechanic in natural language and watch AI build it in Studio
@@ -6,7 +6,7 @@
6
6
 
7
7
  ## Overview
8
8
 
9
- The Connection page lets you monitor all connection states of the MCP system in one place. It is accessible whenever the server is connected (L1 or above).
9
+ The Connection page lets you monitor all connection states of the MCP system in one place. It is accessible whenever the dashboard is in the **Server connected** or **Studio connected** state.
10
10
 
11
11
  ## Server Status
12
12
 
@@ -34,17 +34,17 @@ http://localhost:3002
34
34
 
35
35
  > Set `DASHBOARD_AUTO_OPEN=false` to disable automatic opening (see the [Settings](settings.md) page).
36
36
 
37
- ## Connection Levels
37
+ ## Connection States
38
38
 
39
39
  The features available in the dashboard depend on the connection state:
40
40
 
41
- | Level | Condition | Available Pages |
42
- |:-----:|-----------|-----------------|
43
- | **L0** | Server not connected | Only the reconnection waiting screen is displayed |
44
- | **L1** | Server connected, plugin not connected | Connection, Tools, Settings |
45
- | **L2** | Both server and plugin connected | All pages |
41
+ | State | Condition | Available Pages |
42
+ |-------|-----------|-----------------|
43
+ | **Server disconnected** | Server not connected | Only the reconnection waiting screen is displayed |
44
+ | **Server connected** | Server connected, plugin not connected | Connection, Tools, Settings |
45
+ | **Studio connected** | Both server and plugin connected | All pages |
46
46
 
47
- When the plugin is not connected (L1), the Overview, Changelog, Sync, and Playtest pages are inaccessible.
47
+ When the dashboard is in the **Server connected** state, the Overview, Changelog, Sync, and Playtest pages are inaccessible.
48
48
 
49
49
  ## Overview
50
50
 
@@ -6,7 +6,7 @@
6
6
 
7
7
  ## Overview
8
8
 
9
- The Playtest page shows the status and test results of playtests run by the AI. It is accessible only when the plugin is connected (L2).
9
+ The Playtest page shows the status and test results of playtests run by the AI. It is accessible only when the dashboard is in the **Studio connected** state.
10
10
 
11
11
  ## Playtest Status
12
12
 
@@ -4,7 +4,7 @@
4
4
 
5
5
  ## Overview
6
6
 
7
- The Settings page lets you view license information and server settings, and modify some of them. It is accessible whenever the server is connected (L1 or above).
7
+ The Settings page lets you view license information and server settings, and modify some of them. It is accessible whenever the dashboard is in the **Server connected** or **Studio connected** state.
8
8
 
9
9
  ## License (Read-Only)
10
10
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  ## Overview
10
10
 
11
- The Sync page provides a visual overview of the current state and settings for Studio <-> local file synchronization. It is accessible only when the plugin is connected (L2).
11
+ The Sync page provides a visual overview of the current state and settings for Studio <-> local file synchronization. It is accessible only when the dashboard is in the **Studio connected** state.
12
12
 
13
13
  ## Sync Status
14
14
 
@@ -6,7 +6,7 @@
6
6
 
7
7
  ## Overview
8
8
 
9
- The Tools page provides the execution history and statistics of MCP tools run by the AI. It consists of two sub-tabs: **History** and **Statistics**. It is accessible whenever the server is connected (L1 or above).
9
+ The Tools page provides the execution history and statistics of MCP tools run by the AI. It consists of two sub-tabs: **History** and **Statistics**. It is accessible whenever the dashboard is in the **Server connected** or **Studio connected** state.
10
10
 
11
11
  ## History Tab
12
12
 
@@ -74,7 +74,7 @@ Register the MCP server with your AI app. You can use it with any AI app that su
74
74
  ## Optional: Install WROX Roblox Explorer (VSCode Extension)
75
75
 
76
76
  Browse synced instance trees inside VSCode with Roblox class icons.
77
- This optional extension requires the Roblox MCP setup above, because it reads `roblox-project-sync` data generated by Sync.
77
+ This optional extension requires the Roblox MCP setup above, because it reads sync data from `wrox-project-sync` under your project root.
78
78
 
79
79
  👉 [WROX Roblox Explorer Installation Guide](roblox-explorer.md)
80
80
 
@@ -9,7 +9,7 @@ This is a companion extension for WROX, not a standalone Roblox integration.
9
9
 
10
10
  - VSCode 1.85+
11
11
  - [Roblox MCP](../../../README.md) installed with Sync enabled (Basic or Pro)
12
- - `roblox-project-sync/place_*/.sync-meta.json` already generated by Sync
12
+ - Sync has already generated `wrox-project-sync/place_*/.sync-meta.json` under your project root
13
13
 
14
14
  ## Installation
15
15
 
@@ -37,7 +37,7 @@ Core tree browsing works from synced files on disk. Live sync state, direction i
37
37
 
38
38
  | Setting | Default | Description |
39
39
  |---------|---------|-------------|
40
- | `robloxExplorer.syncRoot` | `""` | Absolute path to `roblox-project-sync` root. Auto-discovered if empty. |
40
+ | `robloxExplorer.syncRoot` | `""` | Absolute path to the `wrox-project-sync` root. If empty, it is auto-discovered. WROX uses `{projectRoot}/wrox-project-sync`. |
41
41
  | `robloxExplorer.hidePropsFiles` | `false` | Hide sync artifact files (`.props.json`, `_tree.json`, `.value.json`) in the default VSCode explorer. |
42
42
  | `robloxExplorer.autoRefresh` | `true` | Auto-refresh tree when sync files change. |
43
43
  | `robloxExplorer.showSyncStatus` | `true` | Show sync status decorations on tree items. |
@@ -18,7 +18,7 @@ Note:
18
18
  2. Click the **Plugins** tab in the top menu
19
19
  3. Click the **Plugins Folder** button
20
20
 
21
- ![Open Plugins Folder](../../assets/screenshots/plugins_menu.png)
21
+ ![Open Plugins Folder](../../assets/screenshots/plugin/installation/plugins-menu.png)
22
22
 
23
23
  4. **Copy** the `WeppyRobloxMCP.rbxm` file from the extracted folder into the opened Plugins folder
24
24
  5. **Restart Roblox Studio**
@@ -27,7 +27,7 @@ Note:
27
27
 
28
28
  After restarting, the **WROX** button will appear in the Plugins tab.
29
29
 
30
- ![WROX Button](../../assets/screenshots/weppy_plugin_toolbar.png)
30
+ ![WROX Button](../../assets/screenshots/plugin/installation/toolbar-button.png)
31
31
 
32
32
  ## 4. Connect to AI Agent
33
33
 
@@ -52,13 +52,13 @@ The MCP server must be installed. Complete the guide for your AI app first:
52
52
  3. Click the **Connect** button in the plugin window
53
53
  4. Once **"Connected"** status is displayed, you're ready
54
54
 
55
- ![Plugin Main Screen](../../assets/screenshots/plugin_main.png)
55
+ ![Plugin Main Screen](../../assets/screenshots/plugin/installation/main-screen.png)
56
56
 
57
57
  ## 5. Settings (Optional)
58
58
 
59
59
  Click the settings button in the top right of the plugin to change options.
60
60
 
61
- ![Settings Screen](../../assets/screenshots/settings.png)
61
+ ![Settings Screen](../../assets/screenshots/plugin/installation/settings-screen.png)
62
62
 
63
63
  - **Auto Connect**: Automatically connect to MCP server when Studio starts
64
64
  - **Auto Reconnect**: Automatically attempt to reconnect when connection is lost
@@ -48,7 +48,7 @@ You only need to activate the license once, either in the plugin or in the dashb
48
48
  5. If the status does not update immediately, click **Refresh**.
49
49
  6. When activation succeeds, the status changes from Basic to Pro and Pro features become available.
50
50
 
51
- ![WROX Plugin license activation screen](../assets/screenshots/license/license-plugin.png)
51
+ ![WROX Plugin license activation screen](../assets/screenshots/plugin/license/plugin-license-screen.png)
52
52
 
53
53
  ### Activate in the dashboard
54
54
 
@@ -58,7 +58,7 @@ You only need to activate the license once, either in the plugin or in the dashb
58
58
  4. Click **Activate License** to activate the license.
59
59
  5. If needed, use **Refresh License** to fetch the latest status.
60
60
 
61
- ![WROX Dashboard license activation screen](../assets/screenshots/license/license-dashboard.png)
61
+ ![WROX Dashboard license activation screen](../assets/screenshots/plugin/license/dashboard-license-screen.png)
62
62
 
63
63
  ### After activation
64
64
 
@@ -12,13 +12,13 @@ Without Sync, AI only sees snippets pasted into chat. With Sync enabled, AI work
12
12
 
13
13
  ## How it works
14
14
 
15
- ![Sync workflow — Studio tree mirrored to local files](../../assets/screenshots/sync.png)
15
+ ![Sync workflow — Studio tree mirrored to local files](../../assets/screenshots/plugin/sync/sync-overview.png)
16
16
 
17
17
  1. Full Sync: initial mirror from Studio tree/instances to local files
18
18
  2. Incremental Sync: continuous update of new changes
19
19
  3. History/Status tracking: inspect what changed, when, and in which direction
20
20
 
21
- Default local path is `roblox-project-sync/place_{placeId}/explorer`.
21
+ Sync data is stored under `{projectRoot}/wrox-project-sync/place_{placeId}/explorer`.
22
22
 
23
23
  ### Browse sync data in VSCode
24
24
 
@@ -109,7 +109,7 @@ In Pro, Direction and Apply Mode can be controlled per type.
109
109
 
110
110
  When changes are detected on both Studio and local sides during bidirectional sync, a conflict resolution dialog appears.
111
111
 
112
- ![Local Changes Detected — conflict resolution options (Studio Priority / Local Priority / Per-File)](../../assets/screenshots/sync_conflict.png)
112
+ ![Local Changes Detected — conflict resolution options (Studio Priority / Local Priority / Per-File)](../../assets/screenshots/plugin/sync/sync-conflict.png)
113
113
 
114
114
  - **Studio Priority**: overwrite with Studio state as the source of truth
115
115
  - **Local Priority**: apply local files to Studio
@@ -86,10 +86,10 @@ Edit --play--> Running --stop--> Edit
86
86
 
87
87
  ### 5. Write reports
88
88
 
89
- Reports and logs are written to local files:
89
+ Reports and logs are written under `{projectRoot}/wrox-project-sync/place_XXXXX/tests/YYYYMMDD-HHmmss/`.
90
90
 
91
91
  ```text
92
- roblox-project-sync/place_XXXXX/tests/YYYYMMDD-HHmmss/
92
+ {projectRoot}/wrox-project-sync/place_XXXXX/tests/YYYYMMDD-HHmmss/
93
93
  ├── test-report.md
94
94
  └── test-log.txt
95
95
  ```
package/docs/es/README.md CHANGED
@@ -2,12 +2,20 @@
2
2
 
3
3
  > **WROX** es un servidor MCP que permite a los agentes de codificacion IA controlar una sesion en vivo de Roblox Studio — crea y edita scripts, instancias, terrain, iluminacion, assets, audio y animaciones con lenguaje natural.
4
4
 
5
- **21 herramientas consolidadas · 140+ acciones · Sync bidireccional · Playtest automatizado · Soporte multi-place**
5
+ **Herramientas consolidadas basadas en acciones · Sync bidireccional · Playtest automatizado · Soporte multi-place**
6
6
 
7
7
  [English](../../README.md) | [한국어](../ko/README.md) | [日本語](../ja/README.md) | **Español** | [Português](../pt-br/README.md) | [Bahasa Indonesia](../id/README.md)
8
8
 
9
9
  [![Demo — IA creando un juego Roblox en tiempo real](https://img.youtube.com/vi/3jrUpBbZPaw/maxresdefault.jpg)](https://youtu.be/3jrUpBbZPaw)
10
10
 
11
+ ## ¿Por qué WROX (Weppy Roblox MCP)?
12
+
13
+ Los agentes de codificación IA como Claude, Codex y Gemini son potentes — pero no pueden ver ni modificar nada dentro de Roblox Studio. El DataModel, los scripts, el terrain y la iluminación son invisibles para las herramientas externas. Sin un puente, la IA solo puede generar fragmentos de código que debes pegar manualmente.
14
+
15
+ **WROX** es un puente entre los agentes de IA y Roblox Studio. La IA crea y modifica directamente instancias, scripts, propiedades, terrain y más dentro de Studio, y los cambios se reflejan de inmediato en Studio y en el dashboard para que puedas **ver exactamente qué cambió**.
16
+
17
+ No necesitas copiar ni pegar código. La IA trabaja y tú verificas los resultados.
18
+
11
19
  ## Instalacion rapida
12
20
 
13
21
  **Instalacion en un solo comando** — Instala el servidor MCP, el plugin de Roblox Studio y registra tus apps de IA en un solo paso:
@@ -52,14 +60,15 @@ npx -y @weppy/roblox-mcp
52
60
  | Codex CLI | [Configuracion](installation/ai-apps/codex-cli.md) |
53
61
  | Codex Desktop | [Configuracion](installation/ai-apps/codex-app.md) |
54
62
  | Gemini CLI | [Configuracion](installation/ai-apps/gemini-cli.md) |
63
+ | Antigravity | [Configuracion](installation/ai-apps/antigravity.md) |
55
64
 
56
65
  > Funciona con cualquier cliente MCP compatible. El comando del servidor es `npx -y @weppy/roblox-mcp`.
57
66
 
58
67
  ## Compatibilidad
59
68
 
60
- | Claude Code | Claude Desktop | Cursor | Codex CLI | Gemini CLI |
61
- |:-----------:|:--------------:|:------:|:---------:|:----------:|
62
- | ✅ | ✅ | ✅ | ✅ | ✅ |
69
+ | Claude Code | Claude Desktop | Cursor | Codex CLI | Gemini CLI | Antigravity |
70
+ |:-----------:|:--------------:|:------:|:---------:|:----------:|:-----------:|
71
+ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
63
72
 
64
73
  **Requisitos:** Node.js 18+, Roblox Studio, Windows 10+ o macOS 12+
65
74
 
@@ -73,17 +82,15 @@ La IA puede manejar directamente scripts, instancias, propiedades, terreno, ilum
73
82
  - "Crea una arena de boss en el centro del mapa y coloca spawns sin colision."
74
83
  - "Cambia la interfaz de este modulo y actualiza todos los scripts dependientes."
75
84
 
76
- No es solo generacion de codigo. Son **acciones ejecutables orientadas a produccion**.
77
-
78
85
  ### 2) Sync: mantiene el contexto completo del proyecto
79
86
 
80
87
  La IA trabaja sobre un espejo local sincronizado, asi que los cambios en multiples archivos se mantienen consistentes.
81
88
 
82
- ![Flujo de Sync — Studio y archivos locales sincronizados en tiempo real](../assets/screenshots/sync.png)
83
-
84
89
  - Basic: sincronizacion unidireccional (Studio -> Local)
85
90
  - Pro: sincronizacion bidireccional + Direction/Apply Mode por tipo + historial + multiplace
86
91
 
92
+ ![Flujo de Sync — Studio y archivos locales sincronizados en tiempo real](../assets/screenshots/plugin/sync/sync-overview.png)
93
+
87
94
  ### 3) Playtest: la IA ejecuta y verifica pruebas automaticamente
88
95
 
89
96
  La IA puede controlar directamente el playtest de Studio. Puede iniciar y detener Play (F5) o Run (F8), inyectar scripts de prueba, recopilar logs y generar reportes locales automaticamente.
@@ -92,28 +99,30 @@ La IA puede controlar directamente el playtest de Studio. Puede iniciar y detene
92
99
  - "Escribe y ejecuta una prueba para confirmar que el SpawnLocation esta sobre el suelo."
93
100
  - "Valida con playtest que el script que acabo de cambiar funciona sin errores."
94
101
 
102
+ ![WROX Playtest Dashboard — historial de pruebas y reporte detallado](../assets/screenshots/dashboard/dashboard_playtest.png)
103
+
95
104
  ### 4) WROX Dashboard: monitorea el trabajo de la IA en tiempo real
96
105
 
97
106
  El Dashboard web proporcionado por el servidor MCP permite consultar en tiempo real el estado de conexion, el historial de ejecucion de herramientas, el estado de sincronizacion y el historial de cambios del juego.
98
107
 
99
- ![WROX WROX Dashboard Overview — estado del servidor, cambios recientes y resumen de sesion](../assets/screenshots/dashboard/dashboard_overview.png)
100
-
101
108
  - Estado de conexion del servidor/plugin/agente de un vistazo
102
109
  - Compara todos los cambios realizados por la IA con Before & After en el Changelog
103
110
  - Analiza el flujo de trabajo con el historial de ejecucion de herramientas y estadisticas
104
111
 
112
+ ![WROX WROX Dashboard Overview — estado del servidor, cambios recientes y resumen de sesion](../assets/screenshots/dashboard/dashboard_overview.png)
113
+
105
114
  ### 5) WROX Roblox Explorer: explora la jerarquia de Studio en VSCode
106
115
 
107
116
  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.
108
117
  WROX Roblox Explorer es una extension complementaria de VSCode para los datos de sync generados por WROX. El arbol base funciona con los archivos sincronizados en disco, y los indicadores en vivo de estado sync o direction se enriquecen cuando el servidor MCP local esta en ejecucion.
109
118
  Instálalo desde [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=weppy.weppy-roblox-explorer) o [Open VSX](https://open-vsx.org/extension/weppy/weppy-roblox-explorer).
110
119
 
111
- ![WROX Roblox Explorer — arbol de instancias de Studio mostrado en la barra lateral de VSCode](../assets/screenshots/roblox-explorer/roblox-explorer-screen.png)
112
-
113
120
  - Iconos de clase iguales a Studio para reconocimiento inmediato
114
121
  - Clic para abrir scripts y archivos de propiedades sincronizados
115
122
  - Soporte multiplace con indicadores de estado de sincronizacion
116
123
 
124
+ ![WROX Roblox Explorer — arbol de instancias de Studio mostrado en la barra lateral de VSCode](../assets/screenshots/roblox-explorer/roblox-explorer-screen.png)
125
+
117
126
  ## Valor inmediato para el usuario
118
127
 
119
128
  - Comprime trabajo repetitivo: convierte muchas ediciones manuales en una sola instruccion
@@ -121,6 +130,14 @@ Instálalo desde [VS Code Marketplace](https://marketplace.visualstudio.com/item
121
130
  - Menor riesgo: decide cambios con estado de sync e historial
122
131
  - Mejor eficiencia de tokens (Pro): menos idas y vueltas con acciones masivas
123
132
 
133
+ ## Casos de uso
134
+
135
+ - **Prototipado rápido**: Describe una mecánica de juego en lenguaje natural y observa cómo la IA la construye en Studio
136
+ - **Refactorización masiva**: Renombra una interfaz de módulo y actualiza todos los scripts dependientes en una sola solicitud
137
+ - **Terrain y entorno**: Genera terrain procedural, configura iluminación/atmósfera, coloca assets — todo desde un solo prompt
138
+ - **Consistencia multi-archivo**: La IA lee el proyecto completo vía Sync y aplica cambios en scripts relacionados de forma conjunta
139
+ - **Integración de assets**: Busca en el Creator Store, inserta modelos y configura propiedades sin salir de tu editor
140
+
124
141
  ## Documentacion detallada
125
142
 
126
143
  - [Guia de instalacion](installation/README.md)
@@ -140,12 +157,47 @@ Instálalo desde [VS Code Marketplace](https://marketplace.visualstudio.com/item
140
157
  - [Playtest y pruebas automatizadas](tools/playtest.md) - control de playtest y validacion automatica
141
158
  - [Sistema y depuracion](tools/system-and-debugging.md) - conexion, logs y ejecucion por lotes
142
159
 
160
+ ## FAQ
161
+
162
+ ### ¿Cómo conecto Claude Code a Roblox Studio?
163
+ Instala el plugin de Roblox Studio y luego registra el servidor MCP (`npx -y @weppy/roblox-mcp`) en Claude Code. Claude podrá leer y escribir scripts directamente dentro de Studio. Consulta [Configuración de Claude Code](installation/ai-apps/claude-code.md).
164
+
165
+ ### ¿Cómo uso Codex CLI con Roblox Studio?
166
+ Instala el plugin y agrega la configuración del servidor MCP a Codex CLI. Consulta [Configuración de Codex CLI](installation/ai-apps/codex-cli.md).
167
+
168
+ ### ¿Roblox MCP funciona con Cursor?
169
+ Sí. Consulta [Configuración de Cursor](installation/ai-apps/cursor.md). Cualquier cliente de IA compatible con MCP funciona.
170
+
171
+ ### ¿Puede la IA crear juegos de Roblox con esto?
172
+ Sí. La IA puede crear instancias, escribir scripts, generar terrain, configurar iluminación, insertar assets, configurar física y más — todo dentro de una sesión de Studio en vivo. Va más allá de la generación de código hacia acciones ejecutables.
173
+
174
+ ### ¿Cuál es la diferencia entre Basic y Pro?
175
+ Basic (gratuito) incluye ejecución de herramientas MCP y sincronización unidireccional (Studio -> Local). Pro agrega sincronización bidireccional, operaciones masivas, generación de terrain, análisis espacial, control de audio/animación y soporte multi-place. Consulta la [Guía de actualización Pro](pro-upgrade.md).
176
+
177
+ ### ¿Cómo se diferencia Weppy de otros servidores MCP para Roblox?
178
+ Weppy usa despacho basado en acciones en lugar de herramientas separadas para cada función. Esto reduce significativamente el consumo de tokens de IA. También proporciona sincronización bidireccional de proyecto y soporte multi-place, que la mayoría de las alternativas no tienen.
179
+
180
+ ### ¿Es seguro? ¿Puede la IA romper mi juego?
181
+ El servidor se ejecuta solo en localhost (127.0.0.1:3002). Las rutas prohibidas (CoreGui, CorePackages) están bloqueadas. La limitación de velocidad (450 req/min) y los tiempos de espera de 30 segundos previenen operaciones fuera de control. Todos los cambios son rastreables a través del historial de sincronización.
182
+
143
183
  ## Upgrade Pro
144
184
 
145
185
  Sync bidireccional, capacidades de creacion avanzadas y eficiencia de tokens de IA — todo en una sola actualizacion.
146
186
 
147
187
  [Guia de actualizacion Pro](pro-upgrade.md)
148
188
 
189
+ ## Licencia
190
+
191
+ Este repositorio está licenciado bajo `AGPL-3.0`.
192
+
193
+ Las licencias comerciales están disponibles por separado. Consulta [COMMERCIAL-LICENSE.md](../../COMMERCIAL-LICENSE.md).
194
+
195
+ El uso del nombre y los logotipos de Weppy se rige por [TRADEMARKS.md](../../TRADEMARKS.md).
196
+
149
197
  ---
150
198
 
199
+ [![npm version](https://img.shields.io/npm/v/@weppy/roblox-mcp)](https://www.npmjs.com/package/@weppy/roblox-mcp) [![Node.js](https://img.shields.io/badge/node-%3E%3D18-brightgreen)](https://nodejs.org/) [![Smithery](https://smithery.ai/badge/@hope1026/weppy-roblox-mcp)](https://smithery.ai/server/@hope1026/weppy-roblox-mcp)
200
+
201
+ [![Roblox MCP on Glama](https://glama.ai/mcp/servers/hope1026/roblox-mcp/badges/card.svg)](https://glama.ai/mcp/servers/hope1026/roblox-mcp)
202
+
151
203
  [GitHub Issues](https://github.com/hope1026/weppy-roblox-mcp/issues) · [Discussions](https://github.com/hope1026/weppy-roblox-mcp/discussions) · [npm](https://www.npmjs.com/package/@weppy/roblox-mcp)
@@ -6,7 +6,7 @@
6
6
 
7
7
  ## Descripcion general
8
8
 
9
- La pagina Connection permite monitorear todos los estados de conexion del sistema MCP en un solo lugar. Es accesible siempre que el servidor este conectado (L1 o superior).
9
+ La pagina Connection permite monitorear todos los estados de conexion del sistema MCP en un solo lugar. Es accesible siempre que el dashboard este en estado **Servidor conectado** o **Studio conectado**.
10
10
 
11
11
  ## Server Status
12
12
 
@@ -34,17 +34,17 @@ http://localhost:3002
34
34
 
35
35
  > Configura `DASHBOARD_AUTO_OPEN=false` para desactivar la apertura automatica (consulta la pagina de [Settings](settings.md)).
36
36
 
37
- ## Niveles de conexion
37
+ ## Estados de conexion
38
38
 
39
39
  El Dashboard ofrece diferentes funciones segun el estado de conexion:
40
40
 
41
- | Nivel | Condicion | Paginas disponibles |
42
- |:-----:|-----------|---------------------|
43
- | **L0** | Servidor no conectado | Solo se muestra la pantalla de espera de reconexion |
44
- | **L1** | Servidor conectado, plugin no conectado | Connection, Tools, Settings |
45
- | **L2** | Servidor + plugin ambos conectados | Todas las paginas |
41
+ | Estado | Condicion | Paginas disponibles |
42
+ |--------|-----------|---------------------|
43
+ | **Servidor desconectado** | Servidor no conectado | Solo se muestra la pantalla de espera de reconexion |
44
+ | **Servidor conectado** | Servidor conectado, plugin no conectado | Connection, Tools, Settings |
45
+ | **Studio conectado** | Servidor + plugin ambos conectados | Todas las paginas |
46
46
 
47
- Cuando el plugin no esta conectado (L1), no se puede acceder a las paginas Overview, Changelog, Sync y Playtest.
47
+ Cuando el dashboard esta en estado **Servidor conectado**, no se puede acceder a las paginas Overview, Changelog, Sync y Playtest.
48
48
 
49
49
  ## Overview
50
50
 
@@ -6,7 +6,7 @@
6
6
 
7
7
  ## Descripcion general
8
8
 
9
- La pagina Playtest muestra el estado de los playtests ejecutados por la IA y los resultados de las pruebas. Solo es accesible cuando el plugin esta conectado (L2).
9
+ La pagina Playtest muestra el estado de los playtests ejecutados por la IA y los resultados de las pruebas. Solo es accesible cuando el dashboard esta en estado **Studio conectado**.
10
10
 
11
11
  ## Playtest Status
12
12
 
@@ -4,7 +4,7 @@
4
4
 
5
5
  ## Descripcion general
6
6
 
7
- En la pagina Settings puedes consultar la informacion de licencia y la configuracion del servidor, y modificar algunos parametros. Es accesible siempre que el servidor este conectado (L1 o superior).
7
+ En la pagina Settings puedes consultar la informacion de licencia y la configuracion del servidor, y modificar algunos parametros. Es accesible siempre que el dashboard este en estado **Servidor conectado** o **Studio conectado**.
8
8
 
9
9
  ## License (solo lectura)
10
10
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  ## Descripcion general
10
10
 
11
- La pagina Sync muestra visualmente el estado actual y la configuracion de la sincronizacion Studio <-> archivos locales. Solo es accesible cuando el plugin esta conectado (L2).
11
+ La pagina Sync muestra visualmente el estado actual y la configuracion de la sincronizacion Studio <-> archivos locales. Solo es accesible cuando el dashboard esta en estado **Studio conectado**.
12
12
 
13
13
  ## Sync Status
14
14
 
@@ -6,7 +6,7 @@
6
6
 
7
7
  ## Descripcion general
8
8
 
9
- La pagina Tools proporciona el historial de ejecucion y las estadisticas de las herramientas MCP ejecutadas por la IA. Se compone de dos sub-pestanas: **History** y **Statistics**. Es accesible siempre que el servidor este conectado (L1 o superior).
9
+ La pagina Tools proporciona el historial de ejecucion y las estadisticas de las herramientas MCP ejecutadas por la IA. Se compone de dos sub-pestanas: **History** y **Statistics**. Es accesible siempre que el dashboard este en estado **Servidor conectado** o **Studio conectado**.
10
10
 
11
11
  ## Pestana History
12
12
 
@@ -67,7 +67,7 @@ Configura el servidor MCP en tu app de IA para que pueda comunicarse con Roblox
67
67
  ## Opcional: Instalar WROX Roblox Explorer (Extensión VSCode)
68
68
 
69
69
  Explora los árboles de instancias sincronizados dentro de VSCode con iconos de clases Roblox.
70
- Esta extensión opcional requiere completar antes la instalación de Roblox MCP, porque Explorer lee los datos `roblox-project-sync` generados por Sync.
70
+ Esta extension opcional requiere completar antes la instalacion de Roblox MCP, porque Explorer lee los datos de Sync desde `wrox-project-sync` dentro de la raiz del proyecto.
71
71
 
72
72
  👉 [Guía de instalación de WROX Roblox Explorer](roblox-explorer.md)
73
73
 
@@ -9,7 +9,7 @@ Esta es una extensión complementaria para WROX, no una integración de Roblox i
9
9
 
10
10
  - VSCode 1.85+
11
11
  - [Roblox MCP](../../../README.md) instalado con Sync habilitado (Basic o Pro)
12
- - `roblox-project-sync/place_*/.sync-meta.json` ya generado por Sync
12
+ - Sync ya genero `wrox-project-sync/place_*/.sync-meta.json` dentro de la raiz del proyecto
13
13
 
14
14
  ## Instalación
15
15
 
@@ -37,7 +37,7 @@ La navegación básica del árbol funciona con los archivos sincronizados en dis
37
37
 
38
38
  | Configuración | Valor por defecto | Descripción |
39
39
  |---------------|-------------------|-------------|
40
- | `robloxExplorer.syncRoot` | `""` | Ruta absoluta a la raíz de `roblox-project-sync`. Se detecta automáticamente si está vacío. |
40
+ | `robloxExplorer.syncRoot` | `""` | Ruta absoluta a la raiz de `wrox-project-sync`. Si esta vacia, se detecta automaticamente. WROX usa `{projectRoot}/wrox-project-sync`. |
41
41
  | `robloxExplorer.hidePropsFiles` | `false` | Oculta los archivos de Sync (`.props.json`, `_tree.json`, `.value.json`) en el explorador predeterminado de VSCode. |
42
42
  | `robloxExplorer.autoRefresh` | `true` | Actualiza automáticamente el árbol cuando cambian los archivos Sync. |
43
43
  | `robloxExplorer.showSyncStatus` | `true` | Muestra decoraciones de estado Sync en los elementos del árbol. |