Roblox game synced with azul — agents commit .luau under sync/, Studio syncs via the azul companion plugin
Find a file
2026-11-08 19:47:43 +02:00
.gitignore azul project layout: sync/ mirror dir, gitignore for azul state, README with agent flow 2026-11-08 19:17:11 +02:00
README.md azul project layout: sync/ mirror dir, gitignore for azul state, README with agent flow 2026-11-08 19:17:11 +02:00

roblox-game

Roblox game developed via a git → azul → Roblox Studio sync bridge (azul). Studio is the source of truth; the sync/ folder mirrors Studio's DataModel 1:1.

The flow

  1. Agents work all day: edit/commit .luau files under sync/ in this repo (every change = a commit, that's the audit trail).
  2. You (at home, on the mesh): git pull.
  3. Sync into Studio:
    • run azul in this folder (daemon serves WebSocket on port 8080),
    • open the place in Roblox Studio, click Connect in the Azul Companion Plugin — everything committed under sync/ syncs into Studio.

Handy commands

  • azul build — force-push local files into Studio (recover from Studio drift).
  • azul push <path> — selectively push files into Studio.
  • azul pack — snapshot Studio-only state (models, maps, properties) back to sync/ so nothing is lost. Commit what it produces.

One-time setup (your PC)

  1. Install Node.js ≥ 20.19 from nodejs.org.
  2. npm install azul-sync -g
  3. Install the Azul Companion Plugin into Roblox Studio.
  4. Optional but recommended: VS Code + Luau-LSP — azul auto-generates sourcemap.json (git-ignored) so IntelliSense works out of the box.

Layout

  • sync/ — DataModel mirror: agents commit .luau here; Studio syncs from it.

sourcemap.json and azul local state (.azul/) are git-ignored.