@weppy/roblox-mcp 2.5.0 → 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 (212) hide show
  1. package/.claude-plugin/marketplace.json +2 -2
  2. package/.github/workflows/install-test.yml +55 -4
  3. package/CHANGELOG.md +25 -0
  4. package/README.md +29 -45
  5. package/SUPPORT.md +4 -6
  6. package/docs/assets/screenshots/roblox-explorer/roblox-explorer-property-window.png +0 -0
  7. package/install.ps1 +22 -9
  8. package/install.sh +19 -4
  9. package/llms-full.txt +8 -688
  10. package/llms.txt +3 -13
  11. package/package.json +1 -1
  12. package/plugins/weppy-roblox-mcp/.claude-plugin/plugin.json +1 -1
  13. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/{ChangelogDetailPage-DRfFUIvC.js → ChangelogDetailPage-C-ROvHGr.js} +1 -1
  14. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/{ChangelogPage-Dgl8dBt6.js → ChangelogPage-CPm4ft8m.js} +1 -1
  15. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/{ConfirmModal-DfdyAPrJ.js → ConfirmModal-BSTYLn14.js} +1 -1
  16. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/{ConnectionPage-LSvSX1_u.js → ConnectionPage-BeJEgfmf.js} +1 -1
  17. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/{InfoLabel-DrK7vhO-.js → InfoLabel-BRbbxjjt.js} +1 -1
  18. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/{OverviewPage-CXsGuoPu.js → OverviewPage-BHd6yL_8.js} +1 -1
  19. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/{PlaytestPage-CgkzRAqQ.js → PlaytestPage-BiNJCh4I.js} +1 -1
  20. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/{PropertyDiff-Dy3MffNh.js → PropertyDiff-BKVe7m6g.js} +1 -1
  21. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/SettingsPage-Cg33y021.js +1 -0
  22. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/{StatusBadge-hJyzgRAl.js → StatusBadge-A72TDL-q.js} +1 -1
  23. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/{SyncPage-eX2Rh-Ct.js → SyncPage-R4Qs9Xt3.js} +1 -1
  24. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/TierComparison-CQewH4h_.js +1 -0
  25. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/{TierPromoProgress-CLAr1gQq.js → TierPromoProgress-DolZjAqX.js} +1 -1
  26. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/{ToolsPage-CqzfCxxH.js → ToolsPage-DRX93nSV.js} +1 -1
  27. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/WhatsNewPage-uLdiNHd0.js +1 -0
  28. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/{index-BfvSPSNj.js → index-oz4Gtzz9.js} +55 -21
  29. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/{useLiveUptime-BeRNzFBh.js → useLiveUptime-CRLLCM8t.js} +1 -1
  30. package/plugins/weppy-roblox-mcp/dashboard/dist/index.html +1 -1
  31. package/plugins/weppy-roblox-mcp/dashboard/dist/weppy-icon.png +0 -0
  32. package/plugins/weppy-roblox-mcp/dist/index.js +76 -76
  33. package/plugins/weppy-roblox-mcp/roblox-plugin/WeppyRobloxMCP.rbxm +0 -0
  34. package/docs/assets/screenshots/roblox-explorer/install-from-vsix.png +0 -0
  35. package/docs/compatibility.md +0 -44
  36. package/docs/en/dashboard/changelog.md +0 -114
  37. package/docs/en/dashboard/connection.md +0 -77
  38. package/docs/en/dashboard/overview.md +0 -95
  39. package/docs/en/dashboard/playtest.md +0 -61
  40. package/docs/en/dashboard/settings.md +0 -60
  41. package/docs/en/dashboard/sync.md +0 -68
  42. package/docs/en/dashboard/tools.md +0 -69
  43. package/docs/en/installation/README.md +0 -95
  44. package/docs/en/installation/ai-apps/antigravity.md +0 -89
  45. package/docs/en/installation/ai-apps/claude-app.md +0 -78
  46. package/docs/en/installation/ai-apps/claude-code.md +0 -104
  47. package/docs/en/installation/ai-apps/codex-app.md +0 -56
  48. package/docs/en/installation/ai-apps/codex-cli.md +0 -67
  49. package/docs/en/installation/ai-apps/cursor.md +0 -77
  50. package/docs/en/installation/ai-apps/gemini-cli.md +0 -120
  51. package/docs/en/installation/roblox-explorer.md +0 -68
  52. package/docs/en/installation/roblox-plugin.md +0 -96
  53. package/docs/en/pro-upgrade.md +0 -96
  54. package/docs/en/sync/luau-lsp.md +0 -41
  55. package/docs/en/sync/overview.md +0 -153
  56. package/docs/en/tools/assets-and-effects.md +0 -104
  57. package/docs/en/tools/instances-and-properties.md +0 -104
  58. package/docs/en/tools/overview.md +0 -277
  59. package/docs/en/tools/playtest.md +0 -140
  60. package/docs/en/tools/scripting.md +0 -66
  61. package/docs/en/tools/system-and-debugging.md +0 -93
  62. package/docs/en/tools/world-and-environment.md +0 -102
  63. package/docs/es/README.md +0 -208
  64. package/docs/es/dashboard/changelog.md +0 -114
  65. package/docs/es/dashboard/connection.md +0 -77
  66. package/docs/es/dashboard/overview.md +0 -95
  67. package/docs/es/dashboard/playtest.md +0 -61
  68. package/docs/es/dashboard/settings.md +0 -60
  69. package/docs/es/dashboard/sync.md +0 -68
  70. package/docs/es/dashboard/tools.md +0 -69
  71. package/docs/es/installation/README.md +0 -87
  72. package/docs/es/installation/ai-apps/antigravity.md +0 -89
  73. package/docs/es/installation/ai-apps/claude-app.md +0 -78
  74. package/docs/es/installation/ai-apps/claude-code.md +0 -104
  75. package/docs/es/installation/ai-apps/codex-app.md +0 -56
  76. package/docs/es/installation/ai-apps/codex-cli.md +0 -67
  77. package/docs/es/installation/ai-apps/cursor.md +0 -77
  78. package/docs/es/installation/ai-apps/gemini-cli.md +0 -120
  79. package/docs/es/installation/roblox-explorer.md +0 -58
  80. package/docs/es/installation/roblox-plugin.md +0 -85
  81. package/docs/es/pro-upgrade.md +0 -96
  82. package/docs/es/sync/luau-lsp.md +0 -41
  83. package/docs/es/sync/overview.md +0 -153
  84. package/docs/es/tools/assets-and-effects.md +0 -104
  85. package/docs/es/tools/instances-and-properties.md +0 -104
  86. package/docs/es/tools/overview.md +0 -277
  87. package/docs/es/tools/playtest.md +0 -140
  88. package/docs/es/tools/scripting.md +0 -66
  89. package/docs/es/tools/system-and-debugging.md +0 -93
  90. package/docs/es/tools/world-and-environment.md +0 -102
  91. package/docs/id/README.md +0 -208
  92. package/docs/id/dashboard/changelog.md +0 -114
  93. package/docs/id/dashboard/connection.md +0 -77
  94. package/docs/id/dashboard/overview.md +0 -95
  95. package/docs/id/dashboard/playtest.md +0 -61
  96. package/docs/id/dashboard/settings.md +0 -60
  97. package/docs/id/dashboard/sync.md +0 -68
  98. package/docs/id/dashboard/tools.md +0 -69
  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 -206
  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/installation/README.md +0 -93
  134. package/docs/ja/installation/ai-apps/antigravity.md +0 -89
  135. package/docs/ja/installation/ai-apps/claude-app.md +0 -78
  136. package/docs/ja/installation/ai-apps/claude-code.md +0 -104
  137. package/docs/ja/installation/ai-apps/codex-app.md +0 -56
  138. package/docs/ja/installation/ai-apps/codex-cli.md +0 -67
  139. package/docs/ja/installation/ai-apps/cursor.md +0 -77
  140. package/docs/ja/installation/ai-apps/gemini-cli.md +0 -120
  141. package/docs/ja/installation/roblox-explorer.md +0 -58
  142. package/docs/ja/installation/roblox-plugin.md +0 -85
  143. package/docs/ja/pro-upgrade.md +0 -96
  144. package/docs/ja/sync/luau-lsp.md +0 -41
  145. package/docs/ja/sync/overview.md +0 -153
  146. package/docs/ja/tools/assets-and-effects.md +0 -104
  147. package/docs/ja/tools/instances-and-properties.md +0 -104
  148. package/docs/ja/tools/overview.md +0 -277
  149. package/docs/ja/tools/playtest.md +0 -140
  150. package/docs/ja/tools/scripting.md +0 -66
  151. package/docs/ja/tools/system-and-debugging.md +0 -93
  152. package/docs/ja/tools/world-and-environment.md +0 -102
  153. package/docs/ko/README.md +0 -206
  154. package/docs/ko/dashboard/changelog.md +0 -114
  155. package/docs/ko/dashboard/connection.md +0 -77
  156. package/docs/ko/dashboard/overview.md +0 -95
  157. package/docs/ko/dashboard/playtest.md +0 -61
  158. package/docs/ko/dashboard/settings.md +0 -60
  159. package/docs/ko/dashboard/sync.md +0 -68
  160. package/docs/ko/dashboard/tools.md +0 -69
  161. package/docs/ko/installation/README.md +0 -95
  162. package/docs/ko/installation/ai-apps/antigravity.md +0 -88
  163. package/docs/ko/installation/ai-apps/claude-app.md +0 -78
  164. package/docs/ko/installation/ai-apps/claude-code.md +0 -104
  165. package/docs/ko/installation/ai-apps/codex-app.md +0 -56
  166. package/docs/ko/installation/ai-apps/codex-cli.md +0 -67
  167. package/docs/ko/installation/ai-apps/cursor.md +0 -77
  168. package/docs/ko/installation/ai-apps/gemini-cli.md +0 -120
  169. package/docs/ko/installation/roblox-explorer.md +0 -68
  170. package/docs/ko/installation/roblox-plugin.md +0 -96
  171. package/docs/ko/pro-upgrade.md +0 -96
  172. package/docs/ko/sync/luau-lsp.md +0 -41
  173. package/docs/ko/sync/overview.md +0 -153
  174. package/docs/ko/tools/assets-and-effects.md +0 -104
  175. package/docs/ko/tools/instances-and-properties.md +0 -104
  176. package/docs/ko/tools/overview.md +0 -277
  177. package/docs/ko/tools/playtest.md +0 -134
  178. package/docs/ko/tools/scripting.md +0 -66
  179. package/docs/ko/tools/system-and-debugging.md +0 -93
  180. package/docs/ko/tools/world-and-environment.md +0 -102
  181. package/docs/pt-br/README.md +0 -208
  182. package/docs/pt-br/dashboard/changelog.md +0 -114
  183. package/docs/pt-br/dashboard/connection.md +0 -77
  184. package/docs/pt-br/dashboard/overview.md +0 -95
  185. package/docs/pt-br/dashboard/playtest.md +0 -61
  186. package/docs/pt-br/dashboard/settings.md +0 -60
  187. package/docs/pt-br/dashboard/sync.md +0 -68
  188. package/docs/pt-br/dashboard/tools.md +0 -69
  189. package/docs/pt-br/installation/README.md +0 -93
  190. package/docs/pt-br/installation/ai-apps/antigravity.md +0 -89
  191. package/docs/pt-br/installation/ai-apps/claude-app.md +0 -78
  192. package/docs/pt-br/installation/ai-apps/claude-code.md +0 -104
  193. package/docs/pt-br/installation/ai-apps/codex-app.md +0 -56
  194. package/docs/pt-br/installation/ai-apps/codex-cli.md +0 -67
  195. package/docs/pt-br/installation/ai-apps/cursor.md +0 -77
  196. package/docs/pt-br/installation/ai-apps/gemini-cli.md +0 -120
  197. package/docs/pt-br/installation/roblox-explorer.md +0 -58
  198. package/docs/pt-br/installation/roblox-plugin.md +0 -85
  199. package/docs/pt-br/pro-upgrade.md +0 -96
  200. package/docs/pt-br/sync/luau-lsp.md +0 -41
  201. package/docs/pt-br/sync/overview.md +0 -153
  202. package/docs/pt-br/tools/assets-and-effects.md +0 -104
  203. package/docs/pt-br/tools/instances-and-properties.md +0 -104
  204. package/docs/pt-br/tools/overview.md +0 -277
  205. package/docs/pt-br/tools/playtest.md +0 -140
  206. package/docs/pt-br/tools/scripting.md +0 -66
  207. package/docs/pt-br/tools/system-and-debugging.md +0 -93
  208. package/docs/pt-br/tools/world-and-environment.md +0 -102
  209. package/docs/troubleshooting.md +0 -47
  210. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/SettingsPage-D2ZBQ2KF.js +0 -1
  211. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/TierComparison-BwKqP_4s.js +0 -1
  212. package/plugins/weppy-roblox-mcp/dashboard/dist/assets/WhatsNewPage-23o8LmsR.js +0 -1
@@ -1,77 +0,0 @@
1
- # Cursor セットアップ
2
-
3
- [Cursor](https://cursor.com/) で Roblox MCP を使う方法です。
4
-
5
- ## 前提条件
6
-
7
- - **Cursor** がインストール済み
8
- - **Node.js** (v18.0.0 以上)
9
- - **Roblox Studio プラグイン** がインストール済み
10
-
11
- ## MCP サーバー登録
12
-
13
- ### 方法 1: プロジェクト設定
14
-
15
- プロジェクトの `.cursor/mcp.json` に次を追加します。
16
-
17
- ```json
18
- {
19
- "mcpServers": {
20
- "weppy-roblox-mcp": {
21
- "command": "npx",
22
- "args": ["-y", "@weppy/roblox-mcp"]
23
- }
24
- }
25
- }
26
- ```
27
-
28
- ### 方法 2: グローバル設定
29
-
30
- グローバル Cursor MCP 設定ファイルにも同じ内容を追加できます。
31
-
32
- **設定ファイルの場所:**
33
-
34
- | 範囲 | パス |
35
- |------|------|
36
- | プロジェクト | `<project>/.cursor/mcp.json` |
37
- | グローバル (macOS/Linux) | `~/.cursor/mcp.json` |
38
- | グローバル (Windows) | `%USERPROFILE%\\.cursor\\mcp.json` |
39
-
40
- > 既存ファイルがある場合は、`mcpServers` オブジェクトへ `weppy-roblox-mcp` を追加してください。
41
-
42
- ### 反映
43
-
44
- 設定を保存したら Cursor ウィンドウを再読み込みするか、アプリを再起動してください。
45
-
46
- ## 接続テスト
47
-
48
- 1. **Roblox Studio** を開く → Plugins タブ → **WEPPY** → **Connect**
49
- 2. **Cursor** で次を入力:
50
- ```
51
- Tell me what's currently selected in Roblox Studio
52
- ```
53
-
54
- ## トラブルシューティング
55
-
56
- ### MCP サーバーが表示されない
57
-
58
- - 設定ファイルのパスが正しいか確認する
59
- - JSON 構文が有効か確認する
60
- - 設定変更後に Cursor を再読み込みしたか確認する
61
-
62
- ### サーバーが起動しない
63
-
64
- 直接 MCP サーバーを起動してエラーを確認します。
65
-
66
- ```bash
67
- npx -y @weppy/roblox-mcp
68
- ```
69
-
70
- ### 接続に失敗する
71
-
72
- - Roblox Studio プラグインが **Connected** 状態か確認する
73
- - ポート 3002 がファイアウォールでブロックされていないか確認する
74
-
75
- ## 参考資料
76
-
77
- - [Cursor MCP ドキュメント](https://docs.cursor.com/context/model-context-protocol)
@@ -1,120 +0,0 @@
1
- # Gemini CLI セットアップ
2
-
3
- [Google Gemini CLI](https://github.com/google-gemini/gemini-cli)でRoblox MCPを使用する方法です。
4
-
5
- ## 前提条件
6
-
7
- 1. **Node.js** (v18.0.0以上)
8
- ```bash
9
- node --version
10
- ```
11
-
12
- 2. **Gemini CLI** インストール済み
13
- ```bash
14
- npm install -g @google/gemini-cli
15
- ```
16
-
17
- 3. **Roblox Studioプラグイン** インストール完了
18
-
19
- ## MCPサーバーの登録
20
-
21
- ### 方法1: CLIコマンド(推奨)
22
-
23
- ターミナルで1行で登録できます:
24
-
25
- ```bash
26
- gemini mcp add weppy-roblox-mcp npx --trust -- -y @weppy/roblox-mcp
27
- ```
28
-
29
- > `--trust`フラグは、ツール呼び出し時の確認プロンプトをスキップします。
30
-
31
- グローバル設定として登録するには、`-s user`を追加してください:
32
-
33
- ```bash
34
- gemini mcp add weppy-roblox-mcp npx -s user --trust -- -y @weppy/roblox-mcp
35
- ```
36
-
37
- ### 方法2: 設定ファイルの編集
38
-
39
- `.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
- **設定ファイルの場所:**
53
- | スコープ | パス |
54
- |----------|------|
55
- | プロジェクト | `<プロジェクト>/.gemini/settings.json` |
56
- | グローバル | `~/.gemini/settings.json` |
57
-
58
- ### 方法3: 環境変数の使用
59
-
60
- 特定の環境変数が必要な場合:
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
- **設定ファイル:**
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
- ## 接続テスト
83
-
84
- 1. **Roblox Studio**を起動 → Pluginsタブ → **WEPPY** → **Connect**
85
- 2. **Gemini CLI**を実行して次のように入力:
86
- ```
87
- Roblox Studioで現在選択されているものを教えて
88
- ```
89
-
90
- ## MCPサーバーの状態確認
91
-
92
- Gemini CLI内で`/mcp`コマンドを使用して、接続されたサーバーの状態を確認できます:
93
-
94
- ```
95
- /mcp
96
- ```
97
-
98
- ## トラブルシューティング
99
-
100
- ### サーバーが起動しない場合
101
-
102
- MCPサーバーを直接実行してエラーを確認してください:
103
- ```bash
104
- npx -y @weppy/roblox-mcp
105
- ```
106
-
107
- ### 接続失敗
108
-
109
- - Roblox Studioプラグインが**Connected**状態であることを確認
110
- - ポート3002がファイアウォールでブロックされていないか確認
111
- - `/mcp`コマンドでサーバーの状態を確認
112
-
113
- ### ツールの競合
114
-
115
- 複数のMCPサーバーに同じ名前のツールがある場合、`serverAlias__toolName`形式でプレフィックスが付けられます。
116
-
117
- ## 参考資料
118
-
119
- - [Gemini CLI MCP公式ドキュメント](https://geminicli.com/docs/tools/mcp-server/)
120
- - [Gemini CLI設定ガイド](https://geminicli.com/docs/get-started/configuration/)
@@ -1,58 +0,0 @@
1
- # WEPPY Roblox Explorer (VSCode拡張)
2
-
3
- Roblox StudioのExplorerと同じインスタンスツリーをVSCodeで表示できる拡張機能です。同期済みインスタンスの探索、スクリプトの直接開封、Sync状態の確認をエディタ内で行えます。
4
- この拡張はWEPPY用のcompanion拡張であり、単体のRoblox連携ツールではありません。
5
-
6
- ![WEPPY Roblox Explorer](../../assets/screenshots/roblox-explorer/roblox-explorer-screen.png)
7
-
8
- ## 要件
9
-
10
- - VSCode 1.85+
11
- - [Roblox MCP](../../../README.md) をインストールし、Syncを有効化 (BasicまたはPro)
12
- - プロジェクトルート配下に Sync により `weppy-project-sync/place_*/.sync-meta.json` が生成済みであること
13
-
14
- ## インストール方法
15
-
16
- VSCode Extensionsサイドバー(`Ctrl+Shift+X` / `Cmd+Shift+X`)で **WEPPY Roblox Explorer** を検索し、**Install** をクリックします。
17
-
18
- または次のマーケットプレイスから直接インストールできます。
19
-
20
- - [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=weppy.weppy-roblox-explorer)
21
- - [Open VSX](https://open-vsx.org/extension/weppy/weppy-roblox-explorer)
22
-
23
- 基本のツリー閲覧はディスク上のsyncファイルだけで動作します。ローカルMCPサーバーに接続できる場合は、live sync状態、direction表示、Explorerテレメトリ転送も利用できます。
24
-
25
- ## 機能
26
-
27
- - **インスタンスツリー**: Roblox Studioと同一のサービス/インスタンス階層
28
- - **Robloxクラスアイコン**: 200以上のクラスアイコン(ダーク/ライトテーマ対応)
29
- - **マルチPlace**: 同期済みPlaceごとにツリールートを分離
30
- - **クリックでファイルを開く**: `.server.luau`、`.client.luau`、`.module.luau`、`.props.json`などを直接開く
31
- - **インスタンス検索**: 全サービスにわたるQuickPick検索
32
- - **Sync状態バッジ**: `modified`、`studio`、`conflict`の状態を一目で確認
33
- - **自動更新**: Syncファイルの変更時にツリーを自動更新(500msデバウンス)
34
- - **インスタンスパスコピー**: 右クリックで`game.Workspace.Part`形式のパスをコピー
35
-
36
- ## 設定
37
-
38
- | 設定 | デフォルト | 説明 |
39
- |------|-----------|------|
40
- | `robloxExplorer.syncRoot` | `""` | `weppy-project-sync` ルートの絶対パス。空の場合は自動検出します。WEPPY は `{projectRoot}/weppy-project-sync` を使います。 |
41
- | `robloxExplorer.hidePropsFiles` | `false` | デフォルトのVSCodeエクスプローラーでSyncファイル(`.props.json`、`_tree.json`、`.value.json`)を非表示にする。 |
42
- | `robloxExplorer.autoRefresh` | `true` | Syncファイルの変更時にツリーを自動更新する。 |
43
- | `robloxExplorer.showSyncStatus` | `true` | ツリー項目にSync状態のデコレーションを表示する。 |
44
-
45
- ## コマンド
46
-
47
- | コマンド | 説明 |
48
- |---------|------|
49
- | `WEPPY Explorer: Refresh` | インスタンスツリーを手動で更新 |
50
- | `WEPPY Explorer: Search Instances` | 全サービスでインスタンスを検索 |
51
- | `WEPPY Explorer: Open Backing File` | 選択したインスタンスのファイルを開く |
52
- | `WEPPY Explorer: Copy Instance Path` | 完全なインスタンスパスをコピー(例: `game.Workspace.Part`) |
53
- | `WEPPY Explorer: Reveal in Explorer` | デフォルトのVSCodeエクスプローラーでファイルを表示 |
54
-
55
- ## 関連ドキュメント
56
-
57
- - [Sync詳細ガイド](../sync/overview.md)
58
- - [インストールガイド](README.md)
@@ -1,85 +0,0 @@
1
- # Robloxプラグインのインストール
2
-
3
- Roblox StudioでAIエージェントと連携するためのプラグインインストール方法です。
4
-
5
- ## 1. プラグインをダウンロード
6
-
7
- 1. [GitHub Releases](https://github.com/hope1026/weppy-roblox-mcp/releases/latest) を開く
8
- 2. `weppy-roblox-mcp-v{version}.zip` をダウンロード
9
- 3. ZIPを解凍 - `roblox-plugin/WeppyRobloxMCP.rbxm` とセットアップガイドを確認
10
-
11
- メモ:
12
- - Basicは同じプラグインパッケージを使い、Basicポリシー(Studio -> Local 片方向Sync)で動作
13
- - Proサブスクライセンス有効化後、双方向Syncとより広い高度機能を利用可能
14
-
15
- ## 2. プラグインをインストール
16
-
17
- 1. **Roblox Studio** を起動
18
- 2. 上部メニューの **Plugins** タブをクリック
19
- 3. **Plugins Folder** ボタンをクリック
20
-
21
- ![Plugins Folderを開く](../../assets/screenshots/plugin/installation/plugins-menu.png)
22
-
23
- 4. 解凍フォルダ内の `WeppyRobloxMCP.rbxm` を Plugins フォルダへ**コピー**
24
- 5. **Roblox Studioを再起動**
25
-
26
- ## 3. インストール確認
27
-
28
- 再起動後、Pluginsタブに **WEPPY** ボタンが表示されます。
29
-
30
- ![WEPPYボタン](../../assets/screenshots/plugin/installation/toolbar-button.png)
31
-
32
- ## 4. AIエージェントに接続
33
-
34
- ### 事前準備
35
-
36
- MCPサーバーがインストールされている必要があります。利用中のAIアプリのガイドを先に完了してください:
37
-
38
- | AIアプリ | インストールガイド |
39
- |-------|-------------|
40
- | Claude Code | [設定方法](ai-apps/claude-code.md) |
41
- | Claude Desktop | [設定方法](ai-apps/claude-app.md) |
42
- | Cursor | [設定方法](ai-apps/cursor.md) |
43
- | Codex CLI | [設定方法](ai-apps/codex-cli.md) |
44
- | Codex Desktop | [設定方法](ai-apps/codex-app.md) |
45
- | Gemini CLI | [設定方法](ai-apps/gemini-cli.md) |
46
- | Antigravity | [設定方法](ai-apps/antigravity.md) |
47
-
48
- ### 接続
49
-
50
- 1. **Roblox Studio**で任意のプロジェクトを開く
51
- 2. **Plugins** タブ -> **WEPPY**
52
- 3. プラグインウィンドウで **Connect** をクリック
53
- 4. **"Connected"** が表示されたら完了
54
-
55
- ![プラグインメイン画面](../../assets/screenshots/plugin/installation/main-screen.png)
56
-
57
- ## 5. 設定(任意)
58
-
59
- 右上の設定ボタンからオプションを変更できます。
60
-
61
- ![設定画面](../../assets/screenshots/plugin/installation/settings-screen.png)
62
-
63
- - **自動接続**: Studio起動時に自動接続
64
- - **自動再接続**: 切断時に自動再接続
65
- - **自動カメラフォーカス**: 生成オブジェクトへ自動フォーカス
66
- - **言語**: UI言語を変更
67
-
68
- ## トラブルシューティング
69
-
70
- ### プラグインが表示されない
71
-
72
- - Roblox Studioを完全終了して再起動
73
- - Plugins Folderへのコピーを確認
74
- - `.rbxm` が破損していないか確認
75
-
76
- ### 接続できない
77
-
78
- - AIアプリでMCPサーバーが起動しているか確認
79
- - **Connect** を再クリック
80
- - ポート3002の競合を確認
81
-
82
- ### 接続が切れやすい
83
-
84
- - 設定で **自動再接続** を有効化
85
- - AIアプリを再起動
@@ -1,96 +0,0 @@
1
- # Proアップグレードガイド
2
-
3
- ## なぜProか?
4
-
5
- ### 実際の開発ワークフローのための双方向Sync
6
-
7
- Pro Syncは単方向エクスポートを超えます。ローカルでスクリプトを編集してStudioに反映。Studioで変更してローカルに取り込む。Proが両側を常に同期します。
8
-
9
- - **双方向Sync** — StudioとローカルファイルのSyncが双方向で変更を反映します。
10
- - **タイプ別Direction** — Scripts、Values、Containers、Data、Servicesをそれぞれ独立して設定。
11
- - **タイプ別Apply Mode** — タイプごとにAutoまたはManualを選択し、速度と制御のバランスを調整。
12
- - **Full Sync / Resync** — 大規模変更や再接続後に即座にクリーンなプロジェクト状態を再構築。
13
- - **変更履歴** — 適用前に何が、いつ、どの方向に変更されたかを追跡。
14
- - **マルチ Place Sync** — 最大3つのRoblox Placeを同時にSync。各Placeは独立したストレージと変更履歴を持ちます。
15
-
16
- ### 高効率ワークフローでAIトークンを節約
17
-
18
- 一括/高度なアクションで繰り返し呼び出しを削減 — 1プロンプトでより多くの作業を。
19
-
20
- ### AIがプレイテストを直接制御
21
-
22
- StudioのプレイテストをAIが実行・検証します。F5(Play)/F8(Run)の開始/停止はもちろん、テストスクリプトを注入してログを収集し、レポートまで自動生成します。
23
-
24
- - 「Runモードでプレイテストを開始して、NPCが目標地点に到達するか確認して。」
25
- - 「SpawnLocationが地面の上にあるかテストスクリプトを書いて自動実行して。」
26
- - 「さっき変更したスクリプトがエラーなく動くかプレイテストで検証して。」
27
-
28
- ### Pro専用の追加機能
29
-
30
- Proはコアワークフローを超え、さらに多くの機能を利用できます。
31
-
32
- - **一括操作** — 1回のリクエストで複数インスタンスを作成・変更・削除
33
- - **地形生成** — ブロック、ボール、シリンダー、ウェッジの充填とマテリアル置換
34
- - **アセット検索/挿入** — Robloxマーケットからアセットを検索し直接挿入
35
- - **空間分析** — レイキャスト、地面検出、平地探索、衝突判定
36
- - **環境制御** — ライティング、大気、スカイ、時間帯の設定
37
- - **オーディオ/アニメーション** — サウンド再生とアニメーションのロード/再生
38
-
39
- ## 購入後のアクティベーション
40
-
41
- ### ステップ1: GumroadでProサブスクライセンスを購入
42
-
43
- 1. [Gumroad - Weppy Roblox Plugin](https://gumroad.com/l/faccjs?utm_source=github&utm_medium=repo&utm_campaign=pro_upgrade_md) にアクセス
44
- 2. Proサブスクライセンスを購入
45
- 3. 購入後に受け取るライセンスキーをコピー
46
-
47
- ライセンスのアクティベーションは、プラグインまたはダッシュボードのどちらか一方で一度行えば十分です。両方の画面は同じMCPローカルライセンス状態を共有するため、片方で有効化するともう片方にも同じ状態が反映されます。
48
-
49
- ### プラグインで有効化
50
-
51
- 1. Roblox Studioで **WEPPY** を開き、MCPサーバーに接続します。
52
- 2. プラグインの **Settings > License** セクションを開きます。
53
- 3. `License key` 入力欄に購入したキーを貼り付けます。
54
- 4. **Activate** を押してライセンスを有効化します。
55
- 5. 状態がすぐに更新されない場合は **Refresh** を押して再確認します。
56
- 6. 有効化が完了すると、状態がBasicからProに変わり、Pro機能を使えるようになります。
57
-
58
- ![プラグインのライセンス有効化画面](../assets/screenshots/plugin/license/plugin-license-screen.png)
59
-
60
- ### ダッシュボードで有効化
61
-
62
- 1. MCPサーバーを起動し、ダッシュボードの **Settings > License** セクションを開きます。
63
- 2. Provider が `gumroad` になっていることを確認します。
64
- 3. `License Key` 入力欄に購入したキーを貼り付けます。
65
- 4. **Activate License** を押してライセンスを有効化します。
66
- 5. 必要に応じて **Refresh License** で最新状態を再取得します。
67
-
68
- ![ダッシュボードのライセンス有効化画面](../assets/screenshots/plugin/license/dashboard-license-screen.png)
69
-
70
- ### 有効化後の確認
71
-
72
- - ライセンス状態が `active` または `grace` と表示されていれば、Pro機能を利用できます。
73
- - プラグインとダッシュボードは同じライセンス状態を共有するため、片方で有効化した結果はもう片方にも反映されます。
74
- - 最新状態を再確認したいときは **Refresh** または **Refresh License** を使ってください。
75
-
76
- ## 機能比較
77
-
78
- | 機能 | Basic | Pro |
79
- |-----|:-----:|:---:|
80
- | スクリプト作成/編集 | ✅ | ✅ |
81
- | インスタンス作成/削除/移動 | ✅ | ✅ + 一括操作 |
82
- | プロパティ読み取り/変更 | ✅ | ✅ + 一括変更 |
83
- | 選択、タグ、検索 | ✅ | ✅ |
84
- | カメラ制御 | ✅ | ✅ |
85
- | ログ監視 | ✅ | ✅ |
86
- | Luauコード実行 | ✅ | ✅ |
87
- | プロジェクト同期 | Studio → Local 片方向 | 双方向 + タイプ別方向/モード設定 |
88
- | マルチ Place Sync | — | 最大3 Place同時Sync |
89
- | 変更履歴 | — | 適用前の変更内容追跡 |
90
- | プレイテスト制御 | — | 再生 / 停止 / 一時停止 / 再開 + 自動テスト |
91
- | 地形生成/編集 | — | ブロック、ボール、シリンダー、ウェッジ、マテリアル置換 |
92
- | アセット検索/挿入 | — | Robloxマーケットから検索して直接挿入 |
93
- | 空間分析 | — | レイキャスト、地面検出、衝突判定 |
94
- | 環境制御 | — | ライティング、大気、スカイ、時間帯 |
95
- | オーディオ / アニメーション | — | サウンド再生、アニメーションロード/再生 |
96
- | AIトークン効率 | 個別アクション | 一括アクションで呼び出し回数削減 |
@@ -1,41 +0,0 @@
1
- # WEPPY Sync で `luau-lsp` を使う
2
-
3
- WEPPY Sync は `luau-lsp` が必要とする sourcemap ファイルを自動生成できるため、別の Rojo プロジェクトを用意しなくても Roblox 対応のエディタ機能を利用できます。
4
-
5
- ## WEPPY が書き出すファイル
6
-
7
- Full Sync が完了すると、WEPPY は次のファイルを書き出します。
8
-
9
- - Place sourcemap: `weppy-project-sync/place_<id>/sourcemap.json`
10
- - ルート代表ファイル: `weppy-project-sync/sourcemap.json`
11
-
12
- ほとんどのユーザーには `weppy-project-sync/sourcemap.json` の利用を推奨します。
13
-
14
- ## 何が改善されるか
15
-
16
- `luau-lsp` が WEPPY sourcemap を読むと、次の点が改善されます。
17
-
18
- - `game.*` の補完
19
- - 同期済みスクリプト間のナビゲーション
20
- - 同期済みスクリプト同士の `require` 解決
21
-
22
- ## 推奨セットアップ
23
-
24
- 1. WEPPY が `weppy-project-sync/sourcemap.json` を生成できるように、まず Full Sync を 1 回実行します。
25
- 2. エディタの `luau-lsp` sourcemap 設定で `weppy-project-sync/sourcemap.json` を指定します。
26
- 3. 利用中のクライアントで自動 Rojo 生成を無効にできる場合は、`luau-lsp.sourcemap.autogenerate` を `false` に設定します。
27
-
28
- VSCode 設定例:
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 メモ
39
-
40
- `weppy-project-sync/sourcemap.json` は、プロジェクトの現在の代表 place に追従します。
41
- 特定の place に固定したい場合は、その place の `weppy-project-sync/place_<id>/sourcemap.json` を `luau-lsp` から直接指定してください。
@@ -1,153 +0,0 @@
1
- # Roblox MCP Sync 詳細ガイド
2
-
3
- SyncはRoblox Studioの状態とローカルファイルを接続し、AIがプロジェクト全体の文脈を安定して読み取り・変更できるようにする機能です。
4
-
5
- ## なぜSyncが重要か
6
-
7
- Syncがない場合、AIはチャットに貼られた断片だけを見て判断します。Syncを有効にすると、プロジェクト全体を基準に作業できます。
8
-
9
- - 複数スクリプトにまたがるリファクタリングを一貫して適用
10
- - 変更履歴を使って高リスクな変更を素早く確認
11
- - Studioとローカルのどちらを正とするかを明確化
12
-
13
- ## 基本の動作
14
-
15
- ![Syncワークフロー — Studioツリーがローカルファイルにミラーされる様子](../../assets/screenshots/plugin/sync/sync-overview.png)
16
-
17
- 1. Full Sync: Studioツリー/インスタンスをローカルに初期ミラー
18
- 2. Incremental Sync: 以後の変更分のみを継続反映
19
- 3. History/Status追跡: いつ・どの方向で何が変わったかを確認
20
-
21
- Sync データは `{projectRoot}/weppy-project-sync/place_{placeId}/explorer` 配下に生成されます。
22
- 加えて、WEPPY は place ごとの sourcemap を `{projectRoot}/weppy-project-sync/place_{placeId}/sourcemap.json` に書き出し、推奨されるルート代表ファイルを `{projectRoot}/weppy-project-sync/sourcemap.json` に維持します。
23
- `luau-lsp` などのエディタ連携ではルートパスの利用を推奨します。設定手順は [WEPPY Sync で `luau-lsp` を使う](./luau-lsp.md) を参照してください。
24
-
25
- ### VSCodeで同期データを閲覧する
26
-
27
- [WEPPY Roblox Explorer](../installation/roblox-explorer.md) 拡張機能をインストールすると、Roblox Studioと同じようにVSCode上で同期済みインスタンスツリーを閲覧できます。
28
- Explorerはここで生成されたsyncファイルを読み取り、ローカルMCPサーバーが動作中なら追加でlive sync状態とdirection情報も表示できます。
29
-
30
- ![WEPPY Roblox Explorer — VSCodeで同期済みインスタンスツリーを閲覧](../../assets/screenshots/roblox-explorer/roblox-explorer-screen.png)
31
-
32
- - Robloxクラスアイコン付きのサービス/インスタンスツリー
33
- - スクリプトをクリックして編集用に開く
34
- - 同期ステータスバッジで変更/コンフリクト状態を表示
35
-
36
- ## Basic vs Pro
37
-
38
- | 項目 | Basic | Pro |
39
- |------|------|-----|
40
- | 同期方向 | Studio -> Local | 双方向 |
41
- | タイプ別Direction | 非対応 | 対応 (Scripts / Values / Containers / Data / Services) |
42
- | タイプ別Apply Mode | 非対応 | 対応 (Auto / Manual) |
43
- | 状態/履歴API | 非対応 | 対応 (`status_current_place`, `history`, `progress`) |
44
- | `manage_sync` ツール | 非対応 | 対応 |
45
- | マルチPlace Sync | 非対応 | 対応 (最大3 Place) |
46
-
47
- ## 同期対象と既定の除外ルール
48
-
49
- 既定の同期対象サービス:
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
- 既定の除外項目:
65
-
66
- - クラス: `Terrain`, `Camera`
67
- - セキュリティ上アクセス禁止のパス: `CoreGui`, `CorePackages`, `RobloxScript`, `RobloxScriptSecurity`
68
-
69
- ## Direction と Apply Mode
70
-
71
- ### Direction(タイプ別同期方向)
72
-
73
- - `forward`: Studio -> Local
74
- - `reverse`: Local -> Studio
75
- - `bidirectional`: 双方向
76
-
77
- タイプは `scripts`, `values`, `containers`, `data`, `services` に分かれて管理されます。
78
-
79
- ### Apply Mode(reverse変更の適用方法)
80
-
81
- - `manual`: Studio反映前にユーザー確認
82
- - `auto`: 検出された変更を自動適用
83
-
84
- ProではタイプごとにDirection/Apply Modeを細かく制御できます。
85
-
86
- ## `manage_sync` アクションガイド (Pro)
87
-
88
- | アクション | 説明 | 主な引数 |
89
- |------|------|-----------|
90
- | `status_current_place` | 現在接続中のPlaceの同期状態を確認 | `-` |
91
- | `history` | 変更履歴を取得 | `placeId`, `query.limit`, `query.offset` |
92
- | `directions` | タイプ別Directionを取得 | `placeId` |
93
- | `read_file` | 同期ファイルを読み取り | `placeId`, `instancePath` |
94
- | `write_file` | 同期ファイルに書き込み | `placeId`, `instancePath`, `content` |
95
- | `progress` | リアルタイム進行状況/処理量を取得 | `placeId` |
96
-
97
- ## 推奨ワークフロー
98
-
99
- ### 1) 安全に開始
100
-
101
- - まずFull Syncを完了して基準点を作る
102
- - 初期は `manual` 適用でリスクを下げる
103
-
104
- ### 2) AIと変更作業
105
-
106
- - 「Sync状態を確認して、直近履歴からリスクの高い変更だけ要約して」
107
- - 「`ServerScriptService` のスクリプトを先にリファクタリングして、履歴も残して」
108
-
109
- ### 3) コンフリクトの解決
110
-
111
- 双方向同期中にStudioとローカルの両方で変更が検出されると、コンフリクト解決ダイアログが表示されます。
112
-
113
- ![Local Changes Detected — コンフリクト解決オプション (Studio Priority / Local Priority / Per-File)](../../assets/screenshots/plugin/sync/sync-conflict.png)
114
-
115
- - **Studio Priority**: Studio側の状態を基準に上書き
116
- - **Local Priority**: ローカルファイルをStudioに反映
117
- - **Per-File**: ファイルごとにどちら側を優先するか個別に選択
118
-
119
- ### 4) 問題時の復旧
120
-
121
- - `history` で最近の変更を追跡
122
- - `read_file` で対象ファイルを確認
123
- - `write_file` で内容を復元してStudio状態を再確認
124
-
125
- ## ファイルフォーマット (v2 nested directory)
126
-
127
- 各Robloxインスタンスは独自のディレクトリとして保存され、ディレクトリ内にメタファイルが配置されます:
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
- 命名規則:
142
- - プロパティ: `{Name}/{Name}.props.json`
143
- - スクリプト: `{Name}/{Name}.server.luau` / `.client.luau` / `.module.luau`
144
- - 値: `{Name}/{Name}.value.json`
145
-
146
- 同名インスタンスはディレクトリ名に `~N` サフィックスを付けて区別します(例: `Part~2/Part.props.json`)。
147
- 名前に `~` が含まれる場合は `~~` にエスケープされます(例: `Part~2` → `Part~~2/`)。Odd-Count Tilde ルール: 末尾の `~+N` でチルダの数が奇数の場合のみ collision suffix として解釈されます。
148
-
149
- ## 関連ドキュメント
150
-
151
- - [WEPPY Sync で `luau-lsp` を使う](./luau-lsp.md)
152
- - [Tool対応範囲 (Tools Overview)](../tools/overview.md)
153
- - [Proアップグレードガイド](https://weppyai.com/ja/plans)