🚀 rbx-sync-init

CLI sederhana untuk membuat struktur folder project Roblox secara otomatis ⚡

Tool ini dibuat untuk membantu workflow menggunakan Sync Script (fitur bawaan Roblox Studio) + membantu AI memahami struktur project kamu melalui file .md.

⚠️ Project ini bersifat private dan dibuat untuk penggunaan pribadi / circle kecil.

🧠 Kenapa Tool Ini Dibuat?

Saat membuat game Roblox dengan Sync Script, biasanya workflow seperti ini:

1. Buat folder manual
2. Sync ke Roblox Studio
3. Rapihin struktur
4. Jelaskan struktur ke AI (biar bisa bantu coding)

Masalahnya:

• 🔁 Repetitif (ulang terus tiap project)
• 🤯 Mudah berantakan
• 🤖 AI sering tidak paham struktur project

⚡ Solusi

Dengan tool ini:

rbx-sync-init

👉 Semua folder langsung dibuat 👉 File .md dibuat untuk membantu dokumentasi 👉 AI bisa memahami struktur project kamu lebih mudah

📦 STEP 1 — Install Node.js (WAJIB)

1. Buka https://nodejs.org
2. Download LTS (Recommended)
3. Install sampai selesai

✅ STEP 2 — Cek Install

node -v
npm -v

Kalau muncul versi → berarti berhasil

📥 STEP 3 — Download Project

git clone https://github.com/USERNAME/rbx-sync-init.git
cd rbx-sync-init

⚙️ STEP 4 — Install CLI

npm link

🧪 STEP 5 — Cara Pakai

Masuk ke folder project kamu:

cd D:\ProjectRobloxBaru

Jalankan:

rbx-sync-init

🎉 Hasil

Folder dibuat:

Workspace/
ReplicatedFirst/
ReplicatedStorage/
ServerScriptService/
ServerStorage/
StarterGui/
StarterPlayer/
  StarterCharacterScripts/
  StarterPlayerScripts/

File tambahan:

Workspace/Workspace-Structure.md
StarterGui/StarterGui-Structure.md
Plans.md
Readme.md

🔁 LANGKAH PENTING SETELAH INIT

Setelah menjalankan:

rbx-sync-init

👉 Kamu HARUS melakukan sync folder ke Roblox Studio menggunakan Sync Script.

⚠️ Jika Sync Gagal

Biasanya bukan karena foldernya, tapi karena:

👉 struktur script / module di dalam project tidak sesuai

Contoh masalah:

• require path salah
• module tidak sesuai struktur
• dependency tidak ditemukan

⚠️ Catatan Penting Tentang Workspace & StarterGui

• ❌ Workspace tidak bisa di-sync langsung
• ❌ StarterGui tidak bisa di-sync langsung

Namun folder tetap dibuat karena:

👉 digunakan untuk dokumentasi struktur

🧠 Fungsi File .md

File ini bukan sekadar catatan, tapi punya tujuan penting:

Contoh:

Workspace/Workspace-Structure.md
StarterGui/StarterGui-Structure.md

Digunakan untuk:

👉 menulis struktur isi Workspace & StarterGui secara manual

💡 Kenapa Ini Penting?

Karena:

👉 AI tidak bisa membaca isi Roblox Studio secara langsung

Jadi kamu perlu:

1. Tulis struktur di .md
2. Update manual setiap ada perubahan

Contoh isi:

Workspace
- Map
- NPC
- SpawnLocation

StarterGui
- MainUI
- InventoryUI

🤖 Manfaat untuk AI

Dengan .md ini:

• AI bisa memahami struktur project
• AI bisa bantu debugging lebih akurat
• AI bisa bantu generate script sesuai konteks

⚡ Mode Lain

🔹 Tanpa file .md

rbx-sync-init nomd

🔹 Mode Simple

rbx-sync-init simple

Hanya membuat:

ReplicatedStorage/
ServerScriptService/
ServerStorage/
StarterPlayer/
  StarterPlayerScripts/

🔁 Workflow yang Direkomendasikan

1. Jalankan:

   rbx-sync-init

2. Sync folder ke Roblox Studio

3. Tulis struktur Workspace & StarterGui di .md

4. Gunakan AI untuk bantu development 🚀

💡 Kenapa Tool Ini Berguna?

• ⏱️ Hemat waktu setup
• 📁 Struktur project rapi
• 🤖 AI lebih paham project kamu
• 🔁 Konsisten antar project

🚀 Roadmap

• Auto generate isi .md
• Template project
• CLI flag modern (--simple, --no-md)

📄 License

MIT

✨ Author

Dibuat untuk mempermudah workflow pribadi dalam development Roblox + AI 🔥