@weppy/roblox-mcp 1.0.2 → 1.0.3

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.
@@ -1,99 +1,259 @@
1
- # Fitur Roblox MCP
1
+ # Alat Roblox MCP
2
2
 
3
- Hubungkan AI dengan Roblox Studio dan otomatiskan berbagai pekerjaan. Berikut adalah hal-hal yang bisa kamu lakukan berdasarkan kategori.
3
+ Untuk parameter detail, periksa definisi alat MCP secara langsung.
4
4
 
5
- Kebijakan Sync:
6
- - Basic: Studio -> Local (satu arah)
7
- - Pro: Sync dua arah + cakupan fitur lanjutan lebih luas (efisiensi token AI lebih baik lewat operasi massal)
8
-
9
- ---
10
-
11
- ## Basic (Gratis)
12
-
13
- ### Manajemen Objek
14
-
15
- Buat, duplikat, hapus, dan pindahkan objek game seperti part, model, dan folder. Pekerjaan seperti "Buatkan part merah" atau "Duplikat model ini dan taruh di sebelahnya" bisa dilakukan.
16
-
17
- ### Properti
18
-
19
- Baca dan ubah semua properti objek seperti ukuran, warna, posisi, dan material. Kamu bisa mengubah beberapa properti sekaligus atau menyesuaikan secara relatif berdasarkan nilai saat ini.
20
-
21
- ### Script
22
-
23
- Buat script baru, baca kode yang ada, dan modifikasi. Kamu bisa mengedit baris tertentu, mencari teks di dalam script, atau mengidentifikasi dependensi untuk melihat modul mana yang direferensikan.
24
-
25
- ### Seleksi
26
-
27
- Cek objek yang sedang dipilih, ubah seleksi, dan bersihkan seleksi. Penting untuk memahami dan mengontrol apa yang sedang kamu kerjakan di Studio.
28
-
29
- ### Pencarian
30
-
31
- Temukan objek di game berdasarkan nama atau kelas (tipe).
32
-
33
- ### Tag
34
-
35
- Tambah atau hapus tag dari objek dan temukan semua objek dengan tag tertentu sekaligus. Berguna untuk mengelola grup objek sejenis.
36
-
37
- ### Kamera
38
-
39
- Pindahkan kamera ke objek atau posisi tertentu. Praktis untuk melihat area yang sedang kamu kerjakan dengan cepat.
40
-
41
- ### Log
42
-
43
- Cek output log dan error yang terjadi saat game berjalan. Membantu menemukan dan memperbaiki bug.
44
-
45
- ### Koneksi
46
-
47
- Cek status koneksi dan penggunaan antara server MCP dan Roblox Studio.
48
-
49
- ---
50
-
51
- ## Pro
52
-
53
- Kalau butuh fitur yang lebih kuat, kamu bisa upgrade ke Pro.
5
+ Dokumen terkait:
6
+ - [Panduan detail Sync](../sync/overview.md)
54
7
 
55
- ### Seleksi Lanjutan
56
-
57
- Dapatkan konteks seleksi detail dengan properti dan source code, jelajahi hierarki seleksi, tambah/hapus item dari seleksi, dan lihat informasi Place serta service game. Berguna untuk workflow lanjutan dan otomasi.
58
-
59
- ### Script Lanjutan
60
-
61
- Ganti konten di beberapa script sekaligus atau jalankan kode Luau secara instan. Berguna untuk modifikasi kode berulang atau pengujian cepat.
62
-
63
- ### Pencarian Lanjutan
64
-
65
- Jelajahi seluruh file tree atau cari objek berdasarkan properti atau tag. Dapatkan gambaran lengkap struktur proyek dan lihat semua descendant atau ancestor dari objek tertentu.
66
-
67
- ### Operasi Massal
68
-
69
- Buat, hapus, modifikasi, atau duplikat ratusan objek sekaligus. Tangani pekerjaan skala besar dengan cepat seperti menanam pohon di map, mengubah warna semua part, atau menempatkan objek sesuai pola.
70
-
71
- ### Aset
72
-
73
- Cari model gratis di Roblox Creator Store dan masukkan langsung. Tambahkan aset lewat percakapan seperti "Carikan model kastil abad pertengahan" atau "Masukkan model senjata".
74
-
75
- ### Lingkungan
76
-
77
- Atur pencahayaan, langit, kabut, properti terrain, dan waktu dengan bahasa alami. Permintaan seperti "Ubah ke suasana senja" atau "Set waktu ke tengah malam" bisa dilakukan.
78
-
79
- ### Manajemen State
80
-
81
- Simpan state Workspace saat ini sebagai snapshot dan cek perubahan terbaru serta status viewport. Membantu memahami state saat ini selama pekerjaan kompleks.
82
-
83
- ### Analisis Spasial
84
-
85
- Tentukan ukuran dan posisi objek secara akurat, temukan ruang kosong, dan cek tabrakan. Kamu juga bisa menyelaraskan objek ke grid.
86
-
87
- ### Raycast
88
-
89
- Tembakkan sinar tak terlihat untuk menemukan titik tabrakan dengan terrain atau objek. Penting untuk desain level game: menemukan posisi tanah, mengecek apakah objek bisa ditempatkan, mencari lokasi spawn, dan menganalisis area yang bisa dilalui.
90
-
91
- ### Terrain
92
-
93
- Isi, pahat, dan haluskan terrain dengan berbagai bentuk seperti blok, bola, silinder, dan baji. Ubah material dan warna, atau buat terrain alam secara prosedural dengan gunung dan sungai.
94
-
95
- ### Visualisasi
96
-
97
- Tampilkan area, marker, dan garis di layar untuk mengonfirmasi ruang kerja secara visual. Berguna untuk debugging dan review desain level.
98
-
99
- 👉 [Panduan Upgrade Pro](../pro-upgrade.md)
8
+ Kebijakan Sync:
9
+ - Basic: Studio -> Local sinkronisasi satu arah
10
+ - Pro: Sinkronisasi dua arah + cakupan aksi lanjutan lebih luas (efisiensi token AI lebih baik dengan alur kerja massal)
11
+
12
+ ## Query Instances (Campuran)
13
+
14
+ | Aksi | Deskripsi | Tier |
15
+ |------|-----------|------|
16
+ | `get` | Mendapatkan properti instance berdasarkan path | Basic |
17
+ | `children` | Mendapatkan anak langsung atau semua keturunan | Basic |
18
+ | `find_child` | Mencari anak pertama berdasarkan nama dan filter kelas opsional | Basic |
19
+ | `find_descendant` | Mencari keturunan pertama berdasarkan nama | Basic |
20
+ | `wait_for_child` | Menunggu anak muncul (dengan timeout) | Basic |
21
+ | `class_info` | Mendapatkan informasi kelas dan properti yang valid | Basic |
22
+ | `search_name` | Mencari instance berdasarkan pola nama (mendukung wildcard) | Basic |
23
+ | `search_class` | Mencari instance berdasarkan nama kelas | Basic |
24
+ | `file_tree` | Mendapatkan struktur pohon file dari root | Pro |
25
+ | `project_structure` | Mendapatkan struktur proyek lengkap | Pro |
26
+ | `descendants` | Mendapatkan semua keturunan dari sebuah instance | Pro |
27
+ | `ancestors` | Mendapatkan semua leluhur dari sebuah instance | Pro |
28
+ | `search_property` | Mencari instance berdasarkan nilai properti | Pro |
29
+ | `search_tag` | Mencari instance berdasarkan tag | Pro |
30
+
31
+ ## Mutate Instances (Campuran)
32
+
33
+ | Aksi | Deskripsi | Tier |
34
+ |------|-----------|------|
35
+ | `create` | Membuat instance baru | Basic |
36
+ | `create_with_props` | Membuat instance dengan properti awal | Basic |
37
+ | `delete` | Menghapus instance | Basic |
38
+ | `clone` | Mengkloning instance | Basic |
39
+ | `move` | Memindahkan instance ke parent baru | Basic |
40
+ | `rename` | Mengganti nama instance | Basic |
41
+ | `pivot` | Mengatur posisi pivot atau CFrame | Basic |
42
+ | `create_tree` | Membuat pohon instance hierarkis | Pro |
43
+ | `mass_create` | Membuat beberapa instance sekaligus | Pro |
44
+ | `mass_delete` | Menghapus beberapa instance | Pro |
45
+ | `mass_duplicate` | Menduplikasi beberapa instance | Pro |
46
+ | `smart_duplicate` | Menduplikasi dengan jarak dan jumlah | Pro |
47
+
48
+ ## Manage Properties (Campuran)
49
+
50
+ | Aksi | Deskripsi | Tier |
51
+ |------|-----------|------|
52
+ | `get` | Mendapatkan nilai satu properti | Basic |
53
+ | `set` | Mengatur nilai satu properti | Basic |
54
+ | `get_all` | Mendapatkan semua properti dari sebuah instance | Basic |
55
+ | `set_multiple` | Mengatur beberapa properti sekaligus | Basic |
56
+ | `get_attr` | Mendapatkan nilai atribut | Basic |
57
+ | `set_attr` | Mengatur nilai atribut | Basic |
58
+ | `get_all_attrs` | Mendapatkan semua atribut | Basic |
59
+ | `delete_attr` | Menghapus atribut | Basic |
60
+ | `add_tag` | Menambahkan tag ke instance | Basic |
61
+ | `remove_tag` | Menghapus tag dari instance | Basic |
62
+ | `check_tag` | Memeriksa apakah instance memiliki tag | Basic |
63
+ | `get_tags` | Mendapatkan semua tag pada instance | Basic |
64
+ | `get_tagged` | Mendapatkan semua instance dengan tag tertentu | Basic |
65
+ | `set_calculated` | Mengatur properti menggunakan ekspresi matematika | Pro |
66
+ | `set_relative` | Mengatur properti relatif terhadap nilai saat ini | Pro |
67
+ | `mass_set` | Mengatur properti pada beberapa instance | Pro |
68
+ | `mass_get` | Mendapatkan properti dari beberapa instance | Pro |
69
+ | `modify_children` | Memodifikasi semua anak dari sebuah parent | Pro |
70
+
71
+ ## Manage Scripts (Campuran)
72
+
73
+ | Aksi | Deskripsi | Tier |
74
+ |------|-----------|------|
75
+ | `get_source` | Mendapatkan kode sumber script | Basic |
76
+ | `set_source` | Mengatur kode sumber script | Basic |
77
+ | `create` | Membuat script baru | Basic |
78
+ | `delete` | Menghapus script | Basic |
79
+ | `edit_replace` | Mengganti baris tertentu di script | Basic |
80
+ | `edit_insert` | Menyisipkan baris pada posisi | Basic |
81
+ | `edit_delete` | Menghapus baris tertentu | Basic |
82
+ | `search` | Mencari teks di script | Basic |
83
+ | `get_dependencies` | Mendapatkan dependensi script | Basic |
84
+ | `replace` | Penggantian massal di seluruh script | Pro |
85
+
86
+ ## Manage Lighting (Pro)
87
+
88
+ | Aksi | Deskripsi | Tier |
89
+ |------|-----------|------|
90
+ | `lighting` | Mengatur properti layanan Lighting | Pro |
91
+ | `atmosphere` | Mengatur properti Atmosphere | Pro |
92
+ | `sky` | Mengatur properti Sky | Pro |
93
+ | `terrain_props` | Mengatur properti visual/air Terrain | Pro |
94
+ | `time` | Mengatur waktu hari | Pro |
95
+
96
+ ## Manage Selection (Campuran)
97
+
98
+ | Aksi | Deskripsi | Tier |
99
+ |------|-----------|------|
100
+ | `get` | Mendapatkan seleksi saat ini | Basic |
101
+ | `set` | Mengganti seleksi saat ini | Basic |
102
+ | `clear` | Menghapus seleksi | Basic |
103
+ | `cached` | Mendapatkan seleksi dari cache tanpa round-trip | Basic |
104
+ | `context` | Mendapatkan konteks detail dengan sumber dan properti | Pro |
105
+ | `details` | Mendapatkan detail hierarkis dengan leluhur/keturunan | Pro |
106
+ | `add` | Menambahkan item ke seleksi | Pro |
107
+ | `remove` | Menghapus item dari seleksi | Pro |
108
+ | `watch` | Memantau perubahan seleksi | Pro |
109
+
110
+ ## Manage Camera (Basic)
111
+
112
+ | Aksi | Deskripsi | Tier |
113
+ |------|-----------|------|
114
+ | `info` | Mendapatkan posisi, rotasi, FOV, dan ukuran viewport kamera | Basic |
115
+ | `focus_path` | Memindahkan kamera untuk fokus pada instance | Basic |
116
+ | `focus_position` | Memindahkan kamera untuk fokus pada posisi | Basic |
117
+ | `suggest` | Mendapatkan tampilan kamera yang disarankan untuk target | Basic |
118
+
119
+ ## Manage Tween (Pro)
120
+
121
+ | Aksi | Deskripsi | Tier |
122
+ |------|-----------|------|
123
+ | `create` | Membuat tween dengan properti target | Pro |
124
+ | `play` | Memutar tween yang dibuat | Pro |
125
+ | `pause` | Menjeda tween yang berjalan | Pro |
126
+ | `cancel` | Membatalkan tween | Pro |
127
+
128
+ ## Manage Audio (Pro)
129
+
130
+ | Aksi | Deskripsi | Tier |
131
+ |------|-----------|------|
132
+ | `play` | Memutar suara (membuat Sound jika diperlukan) | Pro |
133
+ | `stop` | Menghentikan suara yang diputar | Pro |
134
+ | `pause` | Menjeda suara yang diputar | Pro |
135
+ | `resume` | Melanjutkan suara yang dijeda | Pro |
136
+ | `set_listener` | Mengatur tipe/target listener audio | Pro |
137
+
138
+ ## Manage Animation (Pro)
139
+
140
+ | Aksi | Deskripsi | Tier |
141
+ |------|-----------|------|
142
+ | `load` | Memuat animasi pada Humanoid/AnimationController | Pro |
143
+ | `play` | Memutar track animasi yang dimuat | Pro |
144
+ | `stop` | Menghentikan animasi yang diputar | Pro |
145
+ | `get_tracks` | Mendaftar semua track animasi yang dimuat | Pro |
146
+
147
+ ## Manage Physics (Pro)
148
+
149
+ | Aksi | Deskripsi | Tier |
150
+ |------|-----------|------|
151
+ | `register_group` | Mendaftarkan grup tabrakan | Pro |
152
+ | `set_collidable` | Mengatur apakah dua grup bisa bertabrakan | Pro |
153
+ | `get_groups` | Mendaftar semua grup tabrakan terdaftar | Pro |
154
+
155
+ ## Manage Effects (Pro)
156
+
157
+ | Aksi | Deskripsi | Tier |
158
+ |------|-----------|------|
159
+ | `emit` | Mengeluarkan partikel dari ParticleEmitter | Pro |
160
+ | `clear` | Menghapus semua partikel | Pro |
161
+ | `toggle` | Mengaktifkan atau menonaktifkan efek | Pro |
162
+
163
+ ## Manage Terrain (Pro)
164
+
165
+ | Aksi | Deskripsi | Tier |
166
+ |------|-----------|------|
167
+ | `fill_block` | Mengisi terrain berbentuk blok | Pro |
168
+ | `fill_ball` | Mengisi terrain berbentuk bola | Pro |
169
+ | `fill_cylinder` | Mengisi terrain berbentuk silinder | Pro |
170
+ | `fill_wedge` | Mengisi terrain berbentuk baji | Pro |
171
+ | `clear_region` | Menghapus terrain di region | Pro |
172
+ | `clear_bounds` | Menghapus terrain di batas | Pro |
173
+ | `replace_material` | Mengganti material di region | Pro |
174
+ | `colors_get` | Mendapatkan warna material | Pro |
175
+ | `colors_set` | Mengatur warna material | Pro |
176
+ | `read_voxel` | Membaca data voxel tunggal | Pro |
177
+ | `read_voxels` | Membaca data voxel massal | Pro |
178
+ | `write_voxels` | Menulis data voxel massal | Pro |
179
+ | `generate` | Menghasilkan terrain prosedural | Pro |
180
+ | `smooth` | Menghaluskan terrain | Pro |
181
+
182
+ ## Spatial Query (Pro)
183
+
184
+ | Aksi | Deskripsi | Tier |
185
+ |------|-----------|------|
186
+ | `raycast` | Meluncurkan satu sinar | Pro |
187
+ | `find_ground` | Menemukan posisi tanah di bawah titik | Pro |
188
+ | `check_placement` | Memeriksa apakah penempatan bebas tabrakan | Pro |
189
+ | `multi_raycast` | Meluncurkan beberapa sinar sekaligus | Pro |
190
+ | `scan_area` | Menghasilkan peta ketinggian area | Pro |
191
+ | `find_flat` | Menemukan area datar untuk pembangunan | Pro |
192
+ | `find_spawn` | Menemukan posisi spawn yang sesuai | Pro |
193
+ | `analyze_walkable` | Menganalisis grid kemampuan jalan | Pro |
194
+ | `spatial_map` | Mendapatkan semua posisi BasePart | Pro |
195
+ | `find_space` | Menemukan ruang kosong untuk objek | Pro |
196
+ | `bounds` | Mendapatkan kotak pembatas instance | Pro |
197
+ | `snap_grid` | Menyelaraskan posisi ke grid | Pro |
198
+ | `collision` | Memeriksa tabrakan AABB | Pro |
199
+
200
+ ## Manage Assets (Pro)
201
+
202
+ | Aksi | Deskripsi | Tier |
203
+ |------|-----------|------|
204
+ | `insert` | Menyisipkan model berdasarkan ID aset | Pro |
205
+ | `info` | Mendapatkan metadata aset | Pro |
206
+ | `search` | Mencari di Creator Store | Pro |
207
+ | `search_insert` | Mencari dan menyisipkan kecocokan pertama | Pro |
208
+ | `insert_free` | Menyisipkan model gratis | Pro |
209
+ | `insert_package` | Menyisipkan paket | Pro |
210
+ | `export` | Mengekspor seleksi saat ini | Pro |
211
+
212
+ ## Manage Sync (Pro)
213
+
214
+ | Aksi | Deskripsi | Tier |
215
+ |------|-----------|------|
216
+ | `status` | Mendapatkan status sinkronisasi sebuah Place | Pro |
217
+ | `config` | Mendapatkan konfigurasi sinkronisasi | Pro |
218
+ | `history` | Mendapatkan riwayat perubahan | Pro |
219
+ | `directions` | Mendapatkan arah sinkronisasi per tipe | Pro |
220
+ | `read_file` | Membaca file yang disinkronkan | Pro |
221
+ | `write_file` | Menulis ke file yang disinkronkan | Pro |
222
+ | `progress` | Mendapatkan progres sinkronisasi real-time dan bandwidth | Pro |
223
+
224
+ ## Workspace State (Pro)
225
+
226
+ | Aksi | Deskripsi | Tier |
227
+ |------|-----------|------|
228
+ | `sync` | Mendapatkan state Workspace saat ini | Pro |
229
+ | `snapshot` | Mendapatkan struktur pohon instance lengkap | Pro |
230
+ | `changes` | Mendapatkan perubahan terbaru | Pro |
231
+ | `viewport` | Mendapatkan informasi kamera dan viewport | Pro |
232
+
233
+ ## Manage Logs (Basic)
234
+
235
+ | Aksi | Deskripsi | Tier |
236
+ |------|-----------|------|
237
+ | `get` | Mendapatkan log yang difilter | Basic |
238
+ | `clear` | Menghapus buffer log | Basic |
239
+ | `errors` | Mendapatkan hanya error terbaru | Basic |
240
+
241
+ ## System Info (Campuran)
242
+
243
+ | Aksi | Deskripsi | Tier |
244
+ |------|-----------|------|
245
+ | `ping` | Menguji koneksi | Basic |
246
+ | `connection` | Mendapatkan info koneksi server/plugin | Basic |
247
+ | `usage` | Mendapatkan tier saat ini (basic/pro) | Basic |
248
+ | `place_info` | Mendapatkan Place ID, nama, kreator | Pro |
249
+ | `services` | Mendaftar semua layanan Roblox | Pro |
250
+ | `studio_settings` | Mendapatkan preferensi Studio | Pro |
251
+ | `run_command` | Menjalankan perintah Studio | Pro |
252
+
253
+ ## Batch Execute (Pro)
254
+
255
+ Menjalankan beberapa perintah dalam satu batch. Setiap perintah menentukan nama alat dan argumen. Perintah dijalankan secara berurutan dengan perilaku opsional lanjut saat terjadi error.
256
+
257
+ ## Execute Luau (Pro)
258
+
259
+ Menjalankan kode Luau arbitrer di sandbox Roblox Studio. Layanan yang diblokir: HttpService, DataStoreService, MessagingService. Tidak dapat mengakses CoreGui/CorePackages.
package/docs/ja/README.md CHANGED
@@ -6,74 +6,47 @@
6
6
 
7
7
  [![デモ](https://img.youtube.com/vi/3jrUpBbZPaw/maxresdefault.jpg)](https://youtu.be/3jrUpBbZPaw)
8
8
 
9
- ## できること
9
+ ## 主要機能
10
10
 
11
- ### アイデア一つで、プレイ可能なゲームまで
11
+ ### 1) MCP Tool: 自然言語の指示をStudioで直接実行
12
12
 
13
- 「マインクラフト風サバイバルゲームを作って。昼夜サイクル、採掘、クラフト、ウェーブディフェンスまで。」 一文でAIがゲーム構造を設計し、マップ・オブジェクト・スクリプトまで直接作ってくれます。
13
+ Roblox MCPの第一の柱は**MCP Tool実行**です。
14
+ AIがStudio内で、スクリプト、インスタンス、プロパティ、地形、ライティング、アセット、オーディオ、アニメーションを直接処理します。
14
15
 
15
- > **ヒント**: 「まず計画を立てて」とリクエストし、計画を確認してから「実行して」と指示すると、より完成度の高い結果が得られます。
16
+ - 「プレイヤーのジャンプ時に、パーティクル + サウンド + クールタイムを追加して。」
17
+ - 「マップ中央にボスアリーナを作って、衝突しないスポーンポイントを配置して。」
18
+ - 「このモジュールのインターフェースを変えて、依存スクリプトを全部更新して。」
16
19
 
17
- ### プロジェクト全体を読み込んだAI
20
+ 単なるコード生成ではなく、**実行可能な作業単位**として処理できる点が重要です。
18
21
 
19
- AIがRobloxプロジェクトをローカルに同期して、すべてのスクリプト・オブジェクト・構造を把握します。数十ファイルを一度に理解し、一貫して修正します。
22
+ ### 2) Sync: AIがプロジェクト全体の文脈を維持
20
23
 
21
- - 「RemoteEventを使っている場所を全部見つけて呼び出しフローを整理して。」
22
- - 「敵AIのスクリプト全体を統一したステートマシン構造にリファクタリングして。」
23
- - 「昨日以降に変更されたファイルの中でリスクの高い変更だけ要約して。」
24
+ 第二の柱は**Project Sync**です。
25
+ 同期されたローカルミラーを基準にAIが作業するため、複数ファイルにまたがる変更も一貫して適用できます。
24
26
 
25
- 複数のPlaceを同時に管理し、変更履歴も追跡できます。
27
+ - Basic: 片方向同期 (Studio -> Local)
28
+ - Pro: 双方向同期 + タイプ別Direction/Apply Mode + 変更履歴 + マルチPlace
26
29
 
27
- ### スクリプトの作成・リファクタリング・デバッグ、関連ファイルまとめて
30
+ どちらを正とするかを明確に保ち、変更文脈の取りこぼしを防げます。
28
31
 
29
- 指定したファイルだけでなく、依存関係にある全ファイルをまとめて処理します。
32
+ ## すぐに実感できる価値
30
33
 
31
- - 「プレイヤーがジャンプしたときにパーティクル + サウンド + クールタイムを追加して。」
32
- - 「メモリリークの可能性があるイベント接続を全部見つけて安全に修正して。」
33
- - 「このモジュールのインターフェースを変えて、参照している全スクリプトも一緒に更新して。」
34
+ - 反復作業を圧縮: 多数の手作業を1つの指示に集約
35
+ - 関連ファイルを同時に変更: 単一ファイル修正で終わらない
36
+ - リスク低減: 同期状態と履歴を見ながら安全に変更
37
+ - トークン効率向上 (Pro): バルク処理で往復回数を削減
34
38
 
35
- ### オブジェクトの作成と配置 — 数百個も一コマンドで
39
+ ## 詳細ドキュメント
36
40
 
37
- 「この道に沿って街灯を50本間隔を揃えて立てて」「レンガの家20軒をエリアごとにランダムな向きで配置して」 AIがStudioに直接作成します。複数オブジェクトのプロパティをまとめて変更するのも一コマンドで済みます。
38
-
39
- ### 照明・天気・演出を一文で
40
-
41
- 「夕焼けのほこりっぽい砂漠の雰囲気に変えて」「嵐の夜で、稲妻の瞬間だけ周りが明るくなるようにして」 — 一言で照明、空、大気、霧が一括で自動変更されます。
42
-
43
- ### 会話で彫刻する自然地形
44
-
45
- 「マップ北部に断崖の山脈、中央に川、南部に広い平原を作って」 — 山、川、平原、洞窟を会話だけで生成できます。素材、色、高さ、滑らかさを自由に調整し、地形エディタを開かずにマップ全体を完成させられます。
46
-
47
- ### Creator Storeのアセットを検索してすぐに配置
48
-
49
- 「中世の城のモデルを見つけてマップ中央に配置して、スケールを1.5倍にして」 — 無料アセットを検索してプロジェクトにすぐ追加できます。
50
-
51
- ### 空間インテリジェンスでレベルデザインまで
52
-
53
- 「新しいボスアリーナに使える空きスペースを見つけて」「モンスターが実際にパトロールできるエリアだけ表示して」 — 複雑な空間推論と配置ロジックをAIが処理します。
54
-
55
- ### アニメーション・物理・オーディオ、ゲームシステムとして連携
56
-
57
- - 「ダッシュアニメーション再生中はプレイヤーと敵の衝突ルールを変えて。」
58
- - 「アルティメット発動時に専用BGMをフェードイン、終了時に自然に戻して。」
59
-
60
- キャラクター、衝突、サウンドをバラバラなツールではなくゲームシステムとして連携させます。
61
-
62
- ### どんなRoblox APIも直接実行
63
-
64
- 内蔵ツールで足りないときは、AIがStudio内で任意のLuauコードを直接実行します。
65
-
66
- - 「Workspace全体からAnchored=falseのパーツだけ見つけてリストにして。」
67
- - 「条件に合うオブジェクトを一括更新して、変更結果をログに残して。」
68
-
69
- > [全機能リスト](tools/overview.md)
41
+ - [Tool対応範囲 (Tools Overview)](tools/overview.md)
42
+ - [Sync機能詳細ガイド](sync/overview.md)
70
43
 
71
44
  ## はじめに
72
45
 
73
46
  インストールは2つのステップで完了します:
74
47
 
75
- 1. **Roblox Studioプラグインのインストール** — StudioとAIを接続する橋渡しの役割をします
76
- 2. **AIアプリにMCPサーバーを登録** — 使用するAIアプリでRoblox MCPを認識できるように設定します
48
+ 1. **Roblox Studioプラグインのインストール** — StudioとAIを接続する橋渡し
49
+ 2. **AIアプリにMCPサーバーを登録** — 使用するAIアプリでRoblox MCPを認識
77
50
 
78
51
  5分で終わります。👉 [インストールガイド](installation/README.md)
79
52
 
@@ -0,0 +1,104 @@
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
+ 1. Full Sync: Studioツリー/インスタンスをローカルに初期ミラー
16
+ 2. Incremental Sync: 以後の変更分のみを継続反映
17
+ 3. History/Status追跡: いつ・どの方向で何が変わったかを確認
18
+
19
+ ローカルの既定パスは `roblox-project-sync/place_{placeId}/explorer` です。
20
+
21
+ ## Basic vs Pro
22
+
23
+ | 項目 | Basic | Pro |
24
+ |------|------|-----|
25
+ | 同期方向 | Studio -> Local | 双方向 |
26
+ | タイプ別Direction | 非対応 | 対応 (Scripts / Values / Containers / Data / Services) |
27
+ | タイプ別Apply Mode | 非対応 | 対応 (Auto / Manual) |
28
+ | 状態/履歴API | 非対応 | 対応 (`status`, `history`, `progress`) |
29
+ | `manage_sync` ツール | 非対応 | 対応 |
30
+ | マルチPlace Sync | 非対応 | 対応 (最大3 Place) |
31
+
32
+ ## 同期対象と既定の除外ルール
33
+
34
+ 既定の同期対象サービス:
35
+
36
+ - `Workspace`
37
+ - `Lighting`
38
+ - `ReplicatedStorage`
39
+ - `ServerStorage`
40
+ - `ServerScriptService`
41
+ - `StarterGui`
42
+ - `StarterPlayer`
43
+ - `StarterPack`
44
+ - `ReplicatedFirst`
45
+ - `SoundService`
46
+ - `Chat`
47
+ - `LocalizationService`
48
+
49
+ 既定の除外項目:
50
+
51
+ - クラス: `Terrain`, `Camera`
52
+ - セキュリティ上アクセス禁止のパス: `CoreGui`, `CorePackages`, `RobloxScript`, `RobloxScriptSecurity`
53
+
54
+ ## Direction と Apply Mode
55
+
56
+ ### Direction(タイプ別同期方向)
57
+
58
+ - `forward`: Studio -> Local
59
+ - `reverse`: Local -> Studio
60
+ - `bidirectional`: 双方向
61
+
62
+ タイプは `scripts`, `values`, `containers`, `data`, `services` に分かれて管理されます。
63
+
64
+ ### Apply Mode(reverse変更の適用方法)
65
+
66
+ - `manual`: Studio反映前にユーザー確認
67
+ - `auto`: 検出された変更を自動適用
68
+
69
+ ProではタイプごとにDirection/Apply Modeを細かく制御できます。
70
+
71
+ ## `manage_sync` アクションガイド (Pro)
72
+
73
+ | アクション | 説明 | 主な引数 |
74
+ |------|------|-----------|
75
+ | `status` | Placeの現在の同期状態を確認 | `placeId` |
76
+ | `config` | 同期設定を取得 | `placeId` |
77
+ | `history` | 変更履歴を取得 | `placeId`, `query.limit`, `query.offset` |
78
+ | `directions` | タイプ別Directionを取得 | `placeId` |
79
+ | `read_file` | 同期ファイルを読み取り | `placeId`, `instancePath` |
80
+ | `write_file` | 同期ファイルに書き込み | `placeId`, `instancePath`, `content` |
81
+ | `progress` | リアルタイム進行状況/処理量を取得 | `placeId` |
82
+
83
+ ## 推奨ワークフロー
84
+
85
+ ### 1) 安全に開始
86
+
87
+ - まずFull Syncを完了して基準点を作る
88
+ - 初期は `manual` 適用でリスクを下げる
89
+
90
+ ### 2) AIと変更作業
91
+
92
+ - 「Sync状態を確認して、直近履歴からリスクの高い変更だけ要約して」
93
+ - 「`ServerScriptService` のスクリプトを先にリファクタリングして、履歴も残して」
94
+
95
+ ### 3) 問題時の復旧
96
+
97
+ - `history` で最近の変更を追跡
98
+ - `read_file` で対象ファイルを確認
99
+ - `write_file` で内容を復元してStudio状態を再確認
100
+
101
+ ## 関連ドキュメント
102
+
103
+ - [Tool対応範囲 (Tools Overview)](../tools/overview.md)
104
+ - [Proアップグレードガイド](../pro-upgrade.md)