@weppy/roblox-mcp 2.5.1 → 2.6.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 (215) hide show
  1. package/.claude-plugin/marketplace.json +2 -2
  2. package/.github/workflows/install-test.yml +55 -4
  3. package/CHANGELOG.md +17 -0
  4. package/README.md +29 -46
  5. package/SUPPORT.md +4 -6
  6. package/install.ps1 +7 -5
  7. package/install.sh +4 -2
  8. package/llms-full.txt +8 -688
  9. package/llms.txt +3 -13
  10. package/package.json +1 -1
  11. package/plugins/weppy-roblox-mcp/.claude-plugin/plugin.json +1 -1
  12. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/{ChangelogDetailPage-DRfFUIvC.js → ChangelogDetailPage-C-ROvHGr.js} +1 -1
  13. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/{ChangelogPage-Dgl8dBt6.js → ChangelogPage-CPm4ft8m.js} +1 -1
  14. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/{ConfirmModal-DfdyAPrJ.js → ConfirmModal-BSTYLn14.js} +1 -1
  15. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/{ConnectionPage-LSvSX1_u.js → ConnectionPage-BeJEgfmf.js} +1 -1
  16. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/{InfoLabel-DrK7vhO-.js → InfoLabel-BRbbxjjt.js} +1 -1
  17. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/{OverviewPage-CXsGuoPu.js → OverviewPage-BHd6yL_8.js} +1 -1
  18. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/{PlaytestPage-CgkzRAqQ.js → PlaytestPage-BiNJCh4I.js} +1 -1
  19. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/{PropertyDiff-Dy3MffNh.js → PropertyDiff-BKVe7m6g.js} +1 -1
  20. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/SettingsPage-Cg33y021.js +1 -0
  21. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/{StatusBadge-hJyzgRAl.js → StatusBadge-A72TDL-q.js} +1 -1
  22. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/{SyncPage-eX2Rh-Ct.js → SyncPage-R4Qs9Xt3.js} +1 -1
  23. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/TierComparison-CQewH4h_.js +1 -0
  24. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/{TierPromoProgress-CLAr1gQq.js → TierPromoProgress-DolZjAqX.js} +1 -1
  25. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/{ToolsPage-CqzfCxxH.js → ToolsPage-DRX93nSV.js} +1 -1
  26. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/WhatsNewPage-uLdiNHd0.js +1 -0
  27. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/{index-BfvSPSNj.js → index-oz4Gtzz9.js} +55 -21
  28. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/{useLiveUptime-BeRNzFBh.js → useLiveUptime-CRLLCM8t.js} +1 -1
  29. package/plugins/weppy-roblox-mcp/dashboard/dist/index.html +1 -1
  30. package/plugins/weppy-roblox-mcp/dist/index.js +76 -76
  31. package/plugins/weppy-roblox-mcp/roblox-plugin/WeppyRobloxMCP.rbxm +0 -0
  32. package/docs/compatibility.md +0 -44
  33. package/docs/en/dashboard/changelog.md +0 -114
  34. package/docs/en/dashboard/connection.md +0 -77
  35. package/docs/en/dashboard/overview.md +0 -95
  36. package/docs/en/dashboard/playtest.md +0 -61
  37. package/docs/en/dashboard/settings.md +0 -60
  38. package/docs/en/dashboard/sync.md +0 -68
  39. package/docs/en/dashboard/tools.md +0 -69
  40. package/docs/en/explorer/overview.md +0 -104
  41. package/docs/en/installation/README.md +0 -95
  42. package/docs/en/installation/ai-apps/antigravity.md +0 -89
  43. package/docs/en/installation/ai-apps/claude-app.md +0 -78
  44. package/docs/en/installation/ai-apps/claude-code.md +0 -104
  45. package/docs/en/installation/ai-apps/codex-app.md +0 -56
  46. package/docs/en/installation/ai-apps/codex-cli.md +0 -67
  47. package/docs/en/installation/ai-apps/cursor.md +0 -77
  48. package/docs/en/installation/ai-apps/gemini-cli.md +0 -120
  49. package/docs/en/installation/roblox-explorer.md +0 -68
  50. package/docs/en/installation/roblox-plugin.md +0 -96
  51. package/docs/en/pro-upgrade.md +0 -96
  52. package/docs/en/sync/luau-lsp.md +0 -41
  53. package/docs/en/sync/overview.md +0 -153
  54. package/docs/en/tools/assets-and-effects.md +0 -104
  55. package/docs/en/tools/instances-and-properties.md +0 -104
  56. package/docs/en/tools/overview.md +0 -277
  57. package/docs/en/tools/playtest.md +0 -140
  58. package/docs/en/tools/scripting.md +0 -66
  59. package/docs/en/tools/system-and-debugging.md +0 -93
  60. package/docs/en/tools/world-and-environment.md +0 -102
  61. package/docs/es/README.md +0 -209
  62. package/docs/es/dashboard/changelog.md +0 -114
  63. package/docs/es/dashboard/connection.md +0 -77
  64. package/docs/es/dashboard/overview.md +0 -95
  65. package/docs/es/dashboard/playtest.md +0 -61
  66. package/docs/es/dashboard/settings.md +0 -60
  67. package/docs/es/dashboard/sync.md +0 -68
  68. package/docs/es/dashboard/tools.md +0 -69
  69. package/docs/es/explorer/overview.md +0 -104
  70. package/docs/es/installation/README.md +0 -87
  71. package/docs/es/installation/ai-apps/antigravity.md +0 -89
  72. package/docs/es/installation/ai-apps/claude-app.md +0 -78
  73. package/docs/es/installation/ai-apps/claude-code.md +0 -104
  74. package/docs/es/installation/ai-apps/codex-app.md +0 -56
  75. package/docs/es/installation/ai-apps/codex-cli.md +0 -67
  76. package/docs/es/installation/ai-apps/cursor.md +0 -77
  77. package/docs/es/installation/ai-apps/gemini-cli.md +0 -120
  78. package/docs/es/installation/roblox-explorer.md +0 -58
  79. package/docs/es/installation/roblox-plugin.md +0 -85
  80. package/docs/es/pro-upgrade.md +0 -96
  81. package/docs/es/sync/luau-lsp.md +0 -41
  82. package/docs/es/sync/overview.md +0 -153
  83. package/docs/es/tools/assets-and-effects.md +0 -104
  84. package/docs/es/tools/instances-and-properties.md +0 -104
  85. package/docs/es/tools/overview.md +0 -277
  86. package/docs/es/tools/playtest.md +0 -140
  87. package/docs/es/tools/scripting.md +0 -66
  88. package/docs/es/tools/system-and-debugging.md +0 -93
  89. package/docs/es/tools/world-and-environment.md +0 -102
  90. package/docs/id/README.md +0 -209
  91. package/docs/id/dashboard/changelog.md +0 -114
  92. package/docs/id/dashboard/connection.md +0 -77
  93. package/docs/id/dashboard/overview.md +0 -95
  94. package/docs/id/dashboard/playtest.md +0 -61
  95. package/docs/id/dashboard/settings.md +0 -60
  96. package/docs/id/dashboard/sync.md +0 -68
  97. package/docs/id/dashboard/tools.md +0 -69
  98. package/docs/id/explorer/overview.md +0 -104
  99. package/docs/id/installation/README.md +0 -93
  100. package/docs/id/installation/ai-apps/antigravity.md +0 -89
  101. package/docs/id/installation/ai-apps/claude-app.md +0 -78
  102. package/docs/id/installation/ai-apps/claude-code.md +0 -104
  103. package/docs/id/installation/ai-apps/codex-app.md +0 -56
  104. package/docs/id/installation/ai-apps/codex-cli.md +0 -67
  105. package/docs/id/installation/ai-apps/cursor.md +0 -77
  106. package/docs/id/installation/ai-apps/gemini-cli.md +0 -120
  107. package/docs/id/installation/roblox-explorer.md +0 -58
  108. package/docs/id/installation/roblox-plugin.md +0 -85
  109. package/docs/id/pro-upgrade.md +0 -96
  110. package/docs/id/sync/luau-lsp.md +0 -41
  111. package/docs/id/sync/overview.md +0 -153
  112. package/docs/id/tools/assets-and-effects.md +0 -104
  113. package/docs/id/tools/instances-and-properties.md +0 -104
  114. package/docs/id/tools/overview.md +0 -277
  115. package/docs/id/tools/playtest.md +0 -140
  116. package/docs/id/tools/scripting.md +0 -66
  117. package/docs/id/tools/system-and-debugging.md +0 -93
  118. package/docs/id/tools/world-and-environment.md +0 -102
  119. package/docs/installer/assets/index-Bz0amd7x.js +0 -63
  120. package/docs/installer/assets/index-ei4lRUa6.css +0 -1
  121. package/docs/installer/index.html +0 -14
  122. package/docs/installer/manifest.webmanifest +0 -15
  123. package/docs/installer/sw.js +0 -7
  124. package/docs/installer/weppy-icon.png +0 -0
  125. package/docs/ja/README.md +0 -207
  126. package/docs/ja/dashboard/changelog.md +0 -114
  127. package/docs/ja/dashboard/connection.md +0 -77
  128. package/docs/ja/dashboard/overview.md +0 -95
  129. package/docs/ja/dashboard/playtest.md +0 -61
  130. package/docs/ja/dashboard/settings.md +0 -60
  131. package/docs/ja/dashboard/sync.md +0 -68
  132. package/docs/ja/dashboard/tools.md +0 -69
  133. package/docs/ja/explorer/overview.md +0 -104
  134. package/docs/ja/installation/README.md +0 -93
  135. package/docs/ja/installation/ai-apps/antigravity.md +0 -89
  136. package/docs/ja/installation/ai-apps/claude-app.md +0 -78
  137. package/docs/ja/installation/ai-apps/claude-code.md +0 -104
  138. package/docs/ja/installation/ai-apps/codex-app.md +0 -56
  139. package/docs/ja/installation/ai-apps/codex-cli.md +0 -67
  140. package/docs/ja/installation/ai-apps/cursor.md +0 -77
  141. package/docs/ja/installation/ai-apps/gemini-cli.md +0 -120
  142. package/docs/ja/installation/roblox-explorer.md +0 -58
  143. package/docs/ja/installation/roblox-plugin.md +0 -85
  144. package/docs/ja/pro-upgrade.md +0 -96
  145. package/docs/ja/sync/luau-lsp.md +0 -41
  146. package/docs/ja/sync/overview.md +0 -153
  147. package/docs/ja/tools/assets-and-effects.md +0 -104
  148. package/docs/ja/tools/instances-and-properties.md +0 -104
  149. package/docs/ja/tools/overview.md +0 -277
  150. package/docs/ja/tools/playtest.md +0 -140
  151. package/docs/ja/tools/scripting.md +0 -66
  152. package/docs/ja/tools/system-and-debugging.md +0 -93
  153. package/docs/ja/tools/world-and-environment.md +0 -102
  154. package/docs/ko/README.md +0 -207
  155. package/docs/ko/dashboard/changelog.md +0 -114
  156. package/docs/ko/dashboard/connection.md +0 -77
  157. package/docs/ko/dashboard/overview.md +0 -95
  158. package/docs/ko/dashboard/playtest.md +0 -61
  159. package/docs/ko/dashboard/settings.md +0 -60
  160. package/docs/ko/dashboard/sync.md +0 -68
  161. package/docs/ko/dashboard/tools.md +0 -69
  162. package/docs/ko/explorer/overview.md +0 -104
  163. package/docs/ko/installation/README.md +0 -95
  164. package/docs/ko/installation/ai-apps/antigravity.md +0 -88
  165. package/docs/ko/installation/ai-apps/claude-app.md +0 -78
  166. package/docs/ko/installation/ai-apps/claude-code.md +0 -104
  167. package/docs/ko/installation/ai-apps/codex-app.md +0 -56
  168. package/docs/ko/installation/ai-apps/codex-cli.md +0 -67
  169. package/docs/ko/installation/ai-apps/cursor.md +0 -77
  170. package/docs/ko/installation/ai-apps/gemini-cli.md +0 -120
  171. package/docs/ko/installation/roblox-explorer.md +0 -68
  172. package/docs/ko/installation/roblox-plugin.md +0 -96
  173. package/docs/ko/pro-upgrade.md +0 -96
  174. package/docs/ko/sync/luau-lsp.md +0 -41
  175. package/docs/ko/sync/overview.md +0 -153
  176. package/docs/ko/tools/assets-and-effects.md +0 -104
  177. package/docs/ko/tools/instances-and-properties.md +0 -104
  178. package/docs/ko/tools/overview.md +0 -277
  179. package/docs/ko/tools/playtest.md +0 -134
  180. package/docs/ko/tools/scripting.md +0 -66
  181. package/docs/ko/tools/system-and-debugging.md +0 -93
  182. package/docs/ko/tools/world-and-environment.md +0 -102
  183. package/docs/pt-br/README.md +0 -209
  184. package/docs/pt-br/dashboard/changelog.md +0 -114
  185. package/docs/pt-br/dashboard/connection.md +0 -77
  186. package/docs/pt-br/dashboard/overview.md +0 -95
  187. package/docs/pt-br/dashboard/playtest.md +0 -61
  188. package/docs/pt-br/dashboard/settings.md +0 -60
  189. package/docs/pt-br/dashboard/sync.md +0 -68
  190. package/docs/pt-br/dashboard/tools.md +0 -69
  191. package/docs/pt-br/explorer/overview.md +0 -104
  192. package/docs/pt-br/installation/README.md +0 -93
  193. package/docs/pt-br/installation/ai-apps/antigravity.md +0 -89
  194. package/docs/pt-br/installation/ai-apps/claude-app.md +0 -78
  195. package/docs/pt-br/installation/ai-apps/claude-code.md +0 -104
  196. package/docs/pt-br/installation/ai-apps/codex-app.md +0 -56
  197. package/docs/pt-br/installation/ai-apps/codex-cli.md +0 -67
  198. package/docs/pt-br/installation/ai-apps/cursor.md +0 -77
  199. package/docs/pt-br/installation/ai-apps/gemini-cli.md +0 -120
  200. package/docs/pt-br/installation/roblox-explorer.md +0 -58
  201. package/docs/pt-br/installation/roblox-plugin.md +0 -85
  202. package/docs/pt-br/pro-upgrade.md +0 -96
  203. package/docs/pt-br/sync/luau-lsp.md +0 -41
  204. package/docs/pt-br/sync/overview.md +0 -153
  205. package/docs/pt-br/tools/assets-and-effects.md +0 -104
  206. package/docs/pt-br/tools/instances-and-properties.md +0 -104
  207. package/docs/pt-br/tools/overview.md +0 -277
  208. package/docs/pt-br/tools/playtest.md +0 -140
  209. package/docs/pt-br/tools/scripting.md +0 -66
  210. package/docs/pt-br/tools/system-and-debugging.md +0 -93
  211. package/docs/pt-br/tools/world-and-environment.md +0 -102
  212. package/docs/troubleshooting.md +0 -47
  213. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/SettingsPage-D2ZBQ2KF.js +0 -1
  214. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/TierComparison-BwKqP_4s.js +0 -1
  215. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/WhatsNewPage-23o8LmsR.js +0 -1
@@ -1,120 +0,0 @@
1
- # Gemini CLI Setup
2
-
3
- How to use Roblox MCP with [Google Gemini CLI](https://github.com/google-gemini/gemini-cli).
4
-
5
- ## Prerequisites
6
-
7
- 1. **Node.js** (v18.0.0 or higher)
8
- ```bash
9
- node --version
10
- ```
11
-
12
- 2. **Gemini CLI** installed
13
- ```bash
14
- npm install -g @google/gemini-cli
15
- ```
16
-
17
- 3. **Roblox Studio Plugin** installed
18
-
19
- ## Register MCP Server
20
-
21
- ### Method 1: CLI Command (Recommended)
22
-
23
- Register with a single command in your terminal:
24
-
25
- ```bash
26
- gemini mcp add weppy-roblox-mcp npx --trust -- -y @weppy/roblox-mcp
27
- ```
28
-
29
- > The `--trust` flag skips confirmation prompts for each tool call.
30
-
31
- To register globally, add `-s user`:
32
-
33
- ```bash
34
- gemini mcp add weppy-roblox-mcp npx -s user --trust -- -y @weppy/roblox-mcp
35
- ```
36
-
37
- ### Method 2: Edit Configuration File
38
-
39
- Add the following content to `.gemini/settings.json`:
40
-
41
- ```json
42
- {
43
- "mcpServers": {
44
- "weppy-roblox-mcp": {
45
- "command": "npx",
46
- "args": ["-y", "@weppy/roblox-mcp"]
47
- }
48
- }
49
- }
50
- ```
51
-
52
- **Configuration file locations:**
53
- | Scope | Path |
54
- |-------|------|
55
- | Project | `<project>/.gemini/settings.json` |
56
- | Global | `~/.gemini/settings.json` |
57
-
58
- ### Method 3: Using Environment Variables
59
-
60
- If specific environment variables are needed:
61
-
62
- **CLI:**
63
- ```bash
64
- gemini mcp add weppy-roblox-mcp npx --trust -e HTTP_PORT=3002 -- -y @weppy/roblox-mcp
65
- ```
66
-
67
- **Configuration file:**
68
- ```json
69
- {
70
- "mcpServers": {
71
- "weppy-roblox-mcp": {
72
- "command": "npx",
73
- "args": ["-y", "@weppy/roblox-mcp"],
74
- "env": {
75
- "HTTP_PORT": "3002"
76
- }
77
- }
78
- }
79
- }
80
- ```
81
-
82
- ## Connection Test
83
-
84
- 1. Open **Roblox Studio** → Plugins tab → **WEPPY** → **Connect**
85
- 2. Run **Gemini CLI** and enter:
86
- ```
87
- Tell me what's currently selected in Roblox Studio
88
- ```
89
-
90
- ## Check MCP Server Status
91
-
92
- You can check connected server status with the `/mcp` command in Gemini CLI:
93
-
94
- ```
95
- /mcp
96
- ```
97
-
98
- ## Troubleshooting
99
-
100
- ### Server won't start
101
-
102
- Run the MCP server directly to check for errors:
103
- ```bash
104
- npx -y @weppy/roblox-mcp
105
- ```
106
-
107
- ### Connection failed
108
-
109
- - Verify the Roblox Studio plugin is in **Connected** state
110
- - Check if port 3002 is blocked by a firewall
111
- - Check server status with `/mcp` command
112
-
113
- ### Tool conflicts
114
-
115
- If multiple MCP servers have tools with the same name, they will be prefixed with `serverAlias__toolName` format.
116
-
117
- ## Reference
118
-
119
- - [Gemini CLI MCP Official Documentation](https://geminicli.com/docs/tools/mcp-server/)
120
- - [Gemini CLI Configuration Guide](https://geminicli.com/docs/get-started/configuration/)
@@ -1,68 +0,0 @@
1
- # WEPPY Roblox Explorer (VSCode · Antigravity Extension)
2
-
3
- > **Optional** — Explorer is not required. All core features work with just MCP and the plugin. Install it when you want to browse the project structure in your editor.
4
-
5
- Roblox Studio Explorer-like tree view for your editor. Browse synced instance trees, open scripts directly, and track sync status — all inside your editor.
6
- This is a companion extension for WEPPY, not a standalone Roblox integration.
7
-
8
- ![WEPPY Roblox Explorer](../../assets/screenshots/roblox-explorer/roblox-explorer-screen.png)
9
-
10
- ## Requirements
11
-
12
- - VSCode 1.85+ or Antigravity
13
- - [Roblox MCP](../../../README.md) installed with Sync enabled (Basic or Pro)
14
- - Sync has already generated `weppy-project-sync/place_*/.sync-meta.json` under your project root
15
-
16
- ## Installation
17
-
18
- ### VSCode
19
-
20
- Search for **WEPPY Roblox Explorer** in the VSCode Extensions sidebar (`Ctrl+Shift+X` / `Cmd+Shift+X`) and click **Install**.
21
-
22
- Or install directly from:
23
-
24
- - [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=weppy.weppy-roblox-explorer)
25
- - [Open VSX](https://open-vsx.org/extension/weppy/weppy-roblox-explorer)
26
-
27
- ### Antigravity
28
-
29
- Antigravity is VSCode-based, so the same extension works. Search for **WEPPY Roblox Explorer** in the Antigravity Extensions tab and click **Install**.
30
-
31
- ---
32
-
33
- Core tree browsing works from synced files on disk. Live sync state, direction indicators, and Explorer telemetry forwarding are available when the local MCP server is reachable.
34
-
35
- ## Features
36
-
37
- - **Instance tree**: Service/instance hierarchy matching Roblox Studio
38
- - **Roblox class icons**: Dark/light theme support with 200+ class icons
39
- - **Multi-place**: Separate tree roots per synced place
40
- - **Click-to-open**: Open backing files (`.server.luau`, `.client.luau`, `.module.luau`, `.props.json`)
41
- - **Instance search**: QuickPick search across all services
42
- - **Sync status badges**: See `modified`, `studio`, `conflict` states at a glance
43
- - **Auto-refresh**: Tree updates automatically when sync files change (500ms debounce)
44
- - **Copy instance path**: Right-click to copy `game.Workspace.Part` style paths
45
-
46
- ## Settings
47
-
48
- | Setting | Default | Description |
49
- |---------|---------|-------------|
50
- | `robloxExplorer.syncRoot` | `""` | Absolute path to the `weppy-project-sync` root. If empty, it is auto-discovered. WEPPY uses `{projectRoot}/weppy-project-sync`. |
51
- | `robloxExplorer.hidePropsFiles` | `false` | Hide sync artifact files (`.props.json`, `_tree.json`, `.value.json`) in the default VSCode explorer. |
52
- | `robloxExplorer.autoRefresh` | `true` | Auto-refresh tree when sync files change. |
53
- | `robloxExplorer.showSyncStatus` | `true` | Show sync status decorations on tree items. |
54
-
55
- ## Commands
56
-
57
- | Command | Description |
58
- |---------|-------------|
59
- | `WEPPY Explorer: Refresh` | Manually refresh the instance tree |
60
- | `WEPPY Explorer: Search Instances` | Search instances across all services |
61
- | `WEPPY Explorer: Open Backing File` | Open the file backing a selected instance |
62
- | `WEPPY Explorer: Copy Instance Path` | Copy the full instance path (e.g. `game.Workspace.Part`) |
63
- | `WEPPY Explorer: Reveal in Explorer` | Show the backing file in the default VSCode explorer |
64
-
65
- ## Related
66
-
67
- - [Sync Deep Dive](../sync/overview.md)
68
- - [Installation Guide](README.md)
@@ -1,96 +0,0 @@
1
- # Roblox Plugin Installation
2
-
3
- How to install the plugin to connect AI agents with Roblox Studio.
4
-
5
- ## Automatic Installation (Recommended)
6
-
7
- If the MCP server setup is complete, the plugin is **installed automatically**. No manual download or file copy is needed.
8
-
9
- ### How it works
10
-
11
- 1. When the MCP server runs for the first time, it places the plugin file (`WeppyRobloxMCP.rbxm`) into the Roblox Studio Plugins folder automatically.
12
- 2. When you start Roblox Studio, the **WEPPY** button appears in the Plugins tab.
13
-
14
- ### Connecting
15
-
16
- 1. Open any project in **Roblox Studio**
17
- 2. Go to **Plugins** tab → **WEPPY**
18
-
19
- ![WEPPY Button](../../assets/screenshots/plugin/installation/toolbar-button.png)
20
-
21
- 3. Click the **Connect** button in the plugin window
22
- 4. Once **"Connected"** status is displayed, you're ready
23
-
24
- ![Plugin Main Screen](../../assets/screenshots/plugin/installation/main-screen.png)
25
-
26
- > If automatic installation did not work, follow the manual installation below.
27
-
28
- ---
29
-
30
- ## Manual Installation
31
-
32
- Use this if automatic installation didn't work or you need to install a specific version.
33
-
34
- ### 1. Download Plugin
35
-
36
- 1. Open [GitHub Releases](https://github.com/hope1026/weppy-roblox-mcp/releases/latest)
37
- 2. Download `weppy-roblox-mcp-v{version}.zip`
38
- 3. Extract the ZIP file — you will find `roblox-plugin/WeppyRobloxMCP.rbxm`
39
-
40
- ### 2. Install Plugin
41
-
42
- 1. Open **Roblox Studio**
43
- 2. Click the **Plugins** tab in the top menu
44
- 3. Click the **Plugins Folder** button
45
-
46
- ![Open Plugins Folder](../../assets/screenshots/plugin/installation/plugins-menu.png)
47
-
48
- 4. **Copy** the `WeppyRobloxMCP.rbxm` file from the extracted folder into the opened Plugins folder
49
- 5. **Restart Roblox Studio**
50
-
51
- ### 3. Verify Installation
52
-
53
- After restarting, the **WEPPY** button will appear in the Plugins tab.
54
-
55
- ![WEPPY Button](../../assets/screenshots/plugin/installation/toolbar-button.png)
56
-
57
- ### 4. Connect
58
-
59
- Follow the same "Connecting" steps above — click Connect in the plugin.
60
-
61
- ---
62
-
63
- ## Settings (Optional)
64
-
65
- Click the settings button in the top right of the plugin to change options.
66
-
67
- ![Settings Screen](../../assets/screenshots/plugin/installation/settings-screen.png)
68
-
69
- - **Auto Connect**: Automatically connect to MCP server when Studio starts
70
- - **Auto Reconnect**: Automatically attempt to reconnect when connection is lost
71
- - **Auto Camera Focus**: Automatically move camera to created objects
72
- - **Language**: Change the plugin UI language
73
-
74
- ## Tier Information
75
-
76
- - Basic users install the same plugin package and use Basic policy (Studio → Local one-way sync).
77
- - Pro subscribers unlock bidirectional sync and broader advanced tools after license activation.
78
-
79
- ## Troubleshooting
80
-
81
- ### Plugin not visible
82
-
83
- - Completely close and restart Roblox Studio
84
- - Check if the file was properly copied to the Plugins Folder
85
- - Verify the `.rbxm` file is not corrupted
86
-
87
- ### Cannot connect
88
-
89
- - Verify the MCP server is running in your AI app
90
- - Click the **Connect** button again in the plugin
91
- - Check if port 3002 is being used by another program
92
-
93
- ### Connection frequently drops
94
-
95
- - Enable the **Auto Reconnect** option in settings
96
- - Try restarting your AI app
@@ -1,96 +0,0 @@
1
- # Pro Upgrade Guide
2
-
3
- ## Why Pro?
4
-
5
- ### Bidirectional Sync built for real development workflows
6
-
7
- Pro Sync goes beyond one-way export. Edit scripts locally and push them to Studio. Make changes in Studio and pull them back to disk. Pro keeps both sides in sync.
8
-
9
- - **Bidirectional Sync** — Changes flow in both directions between Studio and local files.
10
- - **Per-type Direction** — Set direction independently for Scripts, Values, Containers, Data, and Services.
11
- - **Per-type Apply Mode** — Choose Auto or Manual per type to balance speed and control.
12
- - **Full Sync / Resync** — Rebuild clean project state on demand after large changes or reconnects.
13
- - **Change History** — Track what changed, when, and in which direction before applying.
14
- - **Multi-place Sync** — Sync up to 3 Roblox Places simultaneously, each with isolated storage and its own change history.
15
-
16
- ### Save AI tokens with high-leverage workflows
17
-
18
- Bulk and advanced actions reduce repetitive round trips — do more per prompt.
19
-
20
- ### Let AI run and verify playtests directly
21
-
22
- 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.
23
-
24
- - "Start a Run-mode playtest and check whether the NPC reaches the target."
25
- - "Write a test that verifies the SpawnLocation is above the ground and run it."
26
- - "Validate that the script I just changed runs without errors in playtest."
27
-
28
- ### More Pro-only features
29
-
30
- Pro unlocks additional features beyond the core workflow.
31
-
32
- - **Bulk operations** — Create, modify, or delete multiple instances in a single request
33
- - **Terrain generation** — Fill with block, ball, cylinder, wedge, and replace materials
34
- - **Asset search/insert** — Search the Roblox marketplace and insert assets directly
35
- - **Spatial analysis** — Raycast, find ground, flat area search, collision checks
36
- - **Environment control** — Lighting, atmosphere, sky, and time-of-day settings
37
- - **Audio/Animation** — Sound playback and animation load/play
38
-
39
- ## Buy and Activate
40
-
41
- ### Step 1: Buy a Pro subscription license on Gumroad
42
-
43
- 1. Go to [Gumroad - Weppy Roblox Plugin](https://gumroad.com/l/faccjs?utm_source=github&utm_medium=repo&utm_campaign=pro_upgrade_md)
44
- 2. Complete your Pro subscription license purchase
45
- 3. Copy the license key you receive after purchase
46
-
47
- You only need to activate the license once, either in the plugin or in the dashboard. Both surfaces share the same MCP local license state, so once you activate in one place, the same status appears in the other.
48
-
49
- ### Activate in the plugin
50
-
51
- 1. Open **WEPPY** in Roblox Studio and connect to the MCP server.
52
- 2. Open **Settings > License** in the plugin.
53
- 3. Paste your purchased key into the `License key` field.
54
- 4. Click **Activate** to activate the license.
55
- 5. If the status does not update immediately, click **Refresh**.
56
- 6. When activation succeeds, the status changes from Basic to Pro and Pro features become available.
57
-
58
- ![WEPPY Plugin license activation screen](../assets/screenshots/plugin/license/plugin-license-screen.png)
59
-
60
- ### Activate in the dashboard
61
-
62
- 1. Start the MCP server, then open **Settings > License** in the dashboard.
63
- 2. Confirm that the provider is set to `gumroad`.
64
- 3. Paste your purchased key into the `License Key` field.
65
- 4. Click **Activate License** to activate the license.
66
- 5. If needed, use **Refresh License** to fetch the latest status.
67
-
68
- ![WEPPY Dashboard license activation screen](../assets/screenshots/plugin/license/dashboard-license-screen.png)
69
-
70
- ### After activation
71
-
72
- - If the license status is shown as `active` or `grace`, Pro features are available.
73
- - The plugin and dashboard share the same license state, so activating in one place is reflected in the other.
74
- - Use **Refresh** or **Refresh License** whenever you want to check the latest status again.
75
-
76
- ## Feature Comparison
77
-
78
- | Feature | Basic | Pro |
79
- |---------|:-----:|:---:|
80
- | Script create/edit | ✅ | ✅ |
81
- | Instance create/delete/move | ✅ | ✅ + bulk operations |
82
- | Property read/write | ✅ | ✅ + bulk changes |
83
- | Selection, tags, search | ✅ | ✅ |
84
- | Camera control | ✅ | ✅ |
85
- | Log monitoring | ✅ | ✅ |
86
- | Luau code execution | ✅ | ✅ |
87
- | Project sync | Studio → Local one-way | Bidirectional + per-type direction/mode |
88
- | Multi-place sync | — | Up to 3 Places simultaneously |
89
- | Change history | — | Track changes before applying |
90
- | Playtest control | — | Play / stop / pause / resume + automated tests |
91
- | Terrain generation/editing | — | Block, ball, cylinder, wedge, material replace |
92
- | Asset search/insert | — | Search Roblox marketplace and insert directly |
93
- | Spatial analysis | — | Raycast, find ground, collision checks |
94
- | Environment control | — | Lighting, atmosphere, sky, time of day |
95
- | Audio / Animation | — | Sound playback, animation load/play |
96
- | AI token efficiency | Per-action calls | Fewer calls with bulk actions |
@@ -1,41 +0,0 @@
1
- # Use `luau-lsp` with WEPPY Sync
2
-
3
- WEPPY Sync can generate the sourcemap files that `luau-lsp` needs, so you can enable Roblox-aware editor features without setting up a separate Rojo project.
4
-
5
- ## What WEPPY writes
6
-
7
- After Full Sync finishes, WEPPY writes:
8
-
9
- - Place sourcemap: `weppy-project-sync/place_<id>/sourcemap.json`
10
- - Root representative file: `weppy-project-sync/sourcemap.json`
11
-
12
- For most users, the recommended path is `weppy-project-sync/sourcemap.json`.
13
-
14
- ## Why this helps
15
-
16
- Pointing `luau-lsp` at the WEPPY sourcemap improves:
17
-
18
- - `game.*` autocomplete
19
- - Navigation across synced scripts
20
- - `require` resolution between synced scripts
21
-
22
- ## Recommended setup
23
-
24
- 1. Run Full Sync once so WEPPY creates `weppy-project-sync/sourcemap.json`.
25
- 2. Point your editor's `luau-lsp` sourcemap setting to `weppy-project-sync/sourcemap.json`.
26
- 3. If your client can disable automatic Rojo generation, set `luau-lsp.sourcemap.autogenerate` to `false`.
27
-
28
- Example VSCode settings:
29
-
30
- ```json
31
- {
32
- "luau-lsp.sourcemap.enabled": true,
33
- "luau-lsp.sourcemap.autogenerate": false,
34
- "luau-lsp.sourcemap.sourcemapFile": "weppy-project-sync/sourcemap.json"
35
- }
36
- ```
37
-
38
- ## Multi-place note
39
-
40
- `weppy-project-sync/sourcemap.json` follows the current representative place for the project.
41
- If you need a fixed place instead, point `luau-lsp` directly to that place's `weppy-project-sync/place_<id>/sourcemap.json`.
@@ -1,153 +0,0 @@
1
- # Roblox MCP Sync Deep Dive
2
-
3
- Sync connects Roblox Studio state and local files so AI can read and modify the full project context reliably.
4
-
5
- ## Why Sync matters
6
-
7
- Without Sync, AI only sees snippets pasted into chat. With Sync enabled, AI works from the whole project.
8
-
9
- - Apply refactors consistently across multiple scripts
10
- - Review risky changes quickly using history
11
- - Keep source-of-truth clear between Studio and local files
12
-
13
- ## How it works
14
-
15
- ![Sync workflow — Studio tree mirrored to local files](../../assets/screenshots/plugin/sync/sync-overview.png)
16
-
17
- 1. Full Sync: initial mirror from Studio tree/instances to local files
18
- 2. Incremental Sync: continuous update of new changes
19
- 3. History/Status tracking: inspect what changed, when, and in which direction
20
-
21
- Sync data is stored under `{projectRoot}/weppy-project-sync/place_{placeId}/explorer`.
22
- WEPPY also writes a place sourcemap to `{projectRoot}/weppy-project-sync/place_{placeId}/sourcemap.json` and keeps the recommended root representative file at `{projectRoot}/weppy-project-sync/sourcemap.json`.
23
- Use the root path for editor integrations such as `luau-lsp`. Setup steps are covered in [Use `luau-lsp` with WEPPY Sync](./luau-lsp.md).
24
-
25
- ### Browse sync data in VSCode
26
-
27
- Install the [WEPPY Roblox Explorer](../explorer/overview.md) extension to browse the synced instance tree in VSCode, just like in Roblox Studio.
28
- Explorer reads the sync files generated here, and it can show additional live sync state or direction details when the local MCP server is running.
29
-
30
- ![WEPPY Roblox Explorer — browse synced instance tree in VSCode](../../assets/screenshots/roblox-explorer/roblox-explorer-screen.png)
31
-
32
- - Service/instance tree with Roblox class icons
33
- - Click a script to open it for editing
34
- - Sync status badges show modified/conflict state
35
-
36
- ## Basic vs Pro
37
-
38
- | Item | Basic | Pro |
39
- |------|------|-----|
40
- | Sync direction | Studio -> Local | Bidirectional |
41
- | Per-type Direction | Not supported | Supported (Scripts / Values / Containers / Data / Services) |
42
- | Per-type Apply Mode | Not supported | Supported (Auto / Manual) |
43
- | Status/history APIs | Not supported | Supported (`status_current_place`, `history`, `progress`) |
44
- | `manage_sync` tool | Not supported | Supported |
45
- | Multi-place sync | Not supported | Supported (up to 3 places) |
46
-
47
- ## Sync targets and default exclusions
48
-
49
- Default syncable services:
50
-
51
- - `Workspace`
52
- - `Lighting`
53
- - `ReplicatedStorage`
54
- - `ServerStorage`
55
- - `ServerScriptService`
56
- - `StarterGui`
57
- - `StarterPlayer`
58
- - `StarterPack`
59
- - `ReplicatedFirst`
60
- - `SoundService`
61
- - `Chat`
62
- - `LocalizationService`
63
-
64
- Default exclusions:
65
-
66
- - Classes: `Terrain`, `Camera`
67
- - Security-restricted paths: `CoreGui`, `CorePackages`, `RobloxScript`, `RobloxScriptSecurity`
68
-
69
- ## Direction and Apply Mode
70
-
71
- ### Direction (per-type sync direction)
72
-
73
- - `forward`: Studio -> Local
74
- - `reverse`: Local -> Studio
75
- - `bidirectional`: both directions
76
-
77
- Types are managed separately: `scripts`, `values`, `containers`, `data`, `services`.
78
-
79
- ### Apply Mode (how reverse changes are applied)
80
-
81
- - `manual`: user confirms before applying to Studio
82
- - `auto`: detected changes are auto-applied
83
-
84
- In Pro, Direction and Apply Mode can be controlled per type.
85
-
86
- ## `manage_sync` action guide (Pro)
87
-
88
- | Action | Description | Key params |
89
- |------|------|-----------|
90
- | `status_current_place` | Check current sync state for the currently connected place | `-` |
91
- | `history` | Query change history | `placeId`, `query.limit`, `query.offset` |
92
- | `directions` | Get per-type direction settings | `placeId` |
93
- | `read_file` | Read a synced file | `placeId`, `instancePath` |
94
- | `write_file` | Write a synced file | `placeId`, `instancePath`, `content` |
95
- | `progress` | Get realtime sync progress/throughput | `placeId` |
96
-
97
- ## Recommended workflow
98
-
99
- ### 1) Start safely
100
-
101
- - Complete Full Sync first to establish a stable baseline
102
- - Start with `manual` apply mode to reduce risk
103
-
104
- ### 2) Work with AI
105
-
106
- - "Check sync status, then summarize only risky changes from recent history"
107
- - "Refactor scripts in `ServerScriptService` first and include history output"
108
-
109
- ### 3) Resolve conflicts
110
-
111
- When changes are detected on both Studio and local sides during bidirectional sync, a conflict resolution dialog appears.
112
-
113
- ![Local Changes Detected — conflict resolution options (Studio Priority / Local Priority / Per-File)](../../assets/screenshots/plugin/sync/sync-conflict.png)
114
-
115
- - **Studio Priority**: overwrite with Studio state as the source of truth
116
- - **Local Priority**: apply local files to Studio
117
- - **Per-File**: choose which side takes priority for each file individually
118
-
119
- ### 4) Recover when needed
120
-
121
- - Track recent entries with `history`
122
- - Inspect target file with `read_file`
123
- - Restore content with `write_file`, then verify Studio state
124
-
125
- ## File format (v2 nested directory)
126
-
127
- Each Roblox instance is stored as its own directory containing meta files:
128
-
129
- ```
130
- explorer/
131
- ├── Workspace/
132
- │ ├── _tree.json
133
- │ ├── Part/
134
- │ │ └── Part.props.json
135
- │ ├── MyScript/
136
- │ │ └── MyScript.server.luau
137
- │ └── Coins/
138
- │ └── Coins.value.json
139
- ```
140
-
141
- Naming conventions:
142
- - Props: `{Name}/{Name}.props.json`
143
- - Scripts: `{Name}/{Name}.server.luau` / `.client.luau` / `.module.luau`
144
- - Values: `{Name}/{Name}.value.json`
145
-
146
- Duplicate instance names use `~N` suffix on the directory (e.g. `Part~2/Part.props.json`).
147
- Names containing `~` are escaped to `~~` (e.g. `Part~2` becomes `Part~~2/`). The Odd-Count Tilde Rule applies: a trailing `~+N` is a collision suffix only when the tilde count is odd.
148
-
149
- ## Related docs
150
-
151
- - [Use `luau-lsp` with WEPPY Sync](./luau-lsp.md)
152
- - [Tools Overview](../tools/overview.md)
153
- - [Pro Upgrade Guide](https://weppyai.com/en/plans)
@@ -1,104 +0,0 @@
1
- # Assets & Effects
2
-
3
- > Insert assets and control tweening, audio, particles, animation, and collision groups.
4
-
5
- ## Included Tools
6
-
7
- | Tool | Tier | Description |
8
- |------|:----:|-------------|
9
- | `manage_assets` | Pro | Search Creator Store, insert models and packages, inspect asset info |
10
- | `manage_tween` | Pro | Create, play, pause, and cancel tweens |
11
- | `manage_animation` | Pro | Load, play, stop, and inspect animation tracks |
12
- | `manage_audio` | Pro | Play, stop, pause, and resume sounds; set the audio listener |
13
- | `manage_effects` | Pro | Emit particles, clear effects, and toggle effect state |
14
- | `manage_physics` | Pro | Register collision groups and configure collisions |
15
-
16
- ## Key Workflows
17
-
18
- ### Build a scene with assets
19
-
20
- ```
21
- "Search Creator Store for a tree model and place three of them in Workspace."
22
- ```
23
-
24
- Use `manage_assets.search_insert` to search and insert in a single step.
25
-
26
- ### Create interactive set pieces
27
-
28
- ```
29
- "Make the door open with a 3-second tween when clicked."
30
- ```
31
-
32
- Use `manage_tween.create` to define the motion, then `manage_tween.play` to trigger it. Pair it with `manage_audio.play` for a matching sound effect.
33
-
34
- ### Combine particles and audio
35
-
36
- ```
37
- "Play an explosion sound and emit burst particles when the boss appears."
38
- ```
39
-
40
- Use `manage_effects.emit` for the particles and `manage_audio.play` for the sound in the same workflow.
41
-
42
- ## Action Reference
43
-
44
- ### Manage Assets (Pro)
45
-
46
- | Action | Description | Tier |
47
- |--------|-------------|------|
48
- | `insert` | Insert a model by asset ID | Pro |
49
- | `info` | Get asset metadata | Pro |
50
- | `search` | Search Creator Store | Pro |
51
- | `search_insert` | Search and insert the first match | Pro |
52
- | `insert_free` | Insert a free model | Pro |
53
- | `insert_package` | Insert a package | Pro |
54
- | `export` | Export the current selection | Pro |
55
-
56
- ### Manage Tween (Pro)
57
-
58
- | Action | Description | Tier |
59
- |--------|-------------|------|
60
- | `create` | Create a tween with target properties | Pro |
61
- | `play` | Play a created tween | Pro |
62
- | `pause` | Pause a running tween | Pro |
63
- | `cancel` | Cancel a tween | Pro |
64
-
65
- ### Manage Animation (Pro)
66
-
67
- | Action | Description | Tier |
68
- |--------|-------------|------|
69
- | `load` | Load animation on a Humanoid or AnimationController | Pro |
70
- | `play` | Play a loaded animation track | Pro |
71
- | `stop` | Stop a playing animation | Pro |
72
- | `get_tracks` | List all loaded animation tracks | Pro |
73
-
74
- ### Manage Audio (Pro)
75
-
76
- | Action | Description | Tier |
77
- |--------|-------------|------|
78
- | `play` | Play a sound and create `Sound` if needed | Pro |
79
- | `stop` | Stop a playing sound | Pro |
80
- | `pause` | Pause a playing sound | Pro |
81
- | `resume` | Resume a paused sound | Pro |
82
- | `set_listener` | Set the audio listener type or target | Pro |
83
-
84
- ### Manage Effects (Pro)
85
-
86
- | Action | Description | Tier |
87
- |--------|-------------|------|
88
- | `emit` | Emit particles from a `ParticleEmitter` | Pro |
89
- | `clear` | Clear all particles | Pro |
90
- | `toggle` | Enable or disable an effect | Pro |
91
-
92
- ### Manage Physics (Pro)
93
-
94
- | Action | Description | Tier |
95
- |--------|-------------|------|
96
- | `register_group` | Register a collision group | Pro |
97
- | `set_collidable` | Set whether two groups can collide | Pro |
98
- | `get_groups` | List all registered collision groups | Pro |
99
-
100
- ## Related Docs
101
-
102
- - [Instances & Properties](instances-and-properties.md) - create and place objects
103
- - [World & Environment](world-and-environment.md) - lighting, terrain, and camera
104
- - [Tools Reference](overview.md)