Documentation

Connect to Studio (after init)

Projects created with robloxui init include game.rbxl when Rojo is available. Open it in Studio, run npm run dev, connect, and press Play.

One-time on your machine

  • mise (recommended) — run mise install in the project to get pinned Rojo + Wally
  • Rojo CLI — syncs files into Studio; init runs rojo plugin install when available
  • Wally — Luau projects only (or bundled RuiTheme fallback from init)
  • Roblox Studio — required to open game.rbxl and press Play
Roblox-TS default.project.json

Daily dev commands:

bashnpm run dev

One command manages the compiler and Rojo processes while you develop.

Appears in Studio after Rojo sync:

  • StarterPlayer → StarterPlayerScripts → TS → main
  • ReplicatedStorage → rbxts_include → node_modules → robloxui (with --theme)
React-Luau (Wally) default.project.json

Daily dev commands:

bashnpm run dev

One command manages the compiler and Rojo processes while you develop.

Appears in Studio after Rojo sync:

  • StarterPlayer → StarterPlayerScripts → Client → init.client
  • ReplicatedStorage → Packages → RuiTheme (with --theme)
  • src/client/ui/components

Open in Roblox Studio

  1. 1 Open game.rbxl from your project folder in Roblox Studio (generated by init when Rojo is available).
  2. 2 Run npm run dev in the project root; it starts the compiler and Rojo together.
  3. 3 Open the Rojo plugin → Connect (default localhost:34850).
  4. 4 Press Play — the sample button should appear.
  5. 5 Add marketplace components with npx robloxui add <slug> into src/client/ui/components/.

Troubleshooting

  • No game.rbxl — run mise install and then npm run build:place (Roblox-TS) or rojo build default.project.json -o game.rbxl
  • Rojo won't connect — ensure npm run dev is running
  • Nothing in Play (Roblox-TS) — keep npm run dev running so out/client/ stays compiled
  • RuiTheme not found — the theme is opt-in; re-run npx robloxui add <slug> --theme to vendor the bundled theme, then reconnect Rojo