Documentation

Connect to Studio (existing project)

Already have a Roblox-TS or Luau/Wally repo? Install the theme, map your components folder in Rojo, sync with rojo serve, then add marketplace components.

Already have a Roblox-TS or Luau/Wally repo? Skip robloxui init and wire your existing project to Studio, then add components with the CLI.

1. Confirm your project type

Roblox-TSrojo.json + default.project.json

TypeScript compiled to Luau via rbxtsc. Init includes @rbxts/react and TSX sample UI; the theme is opt-in.

React-Luau (Wally)wally.toml + default.project.json

Pure Luau with Wally packages. robloxui add --theme vendors the bundled RuiTheme into Packages/.

2. Install the theme package

The CLI runs this automatically when you npx robloxui add, but you can install upfront:

bashnpm install robloxui
bashnpx robloxui add <slug> # vendors bundled RuiTheme to Packages/

3. Map the components folder in Rojo

By default the CLI installs to src/client/ui/components/. Ensure your Rojo tree includes that path (init projects already do).

json
"RobloxUI": {
  "$path": "src/client/ui/components"
}

4. Sync to Studio

bashnpm run watch
bashrojo serve
bashrojo serve -p default.project.json
  1. 1.Open your existing .rbxl place in Roblox Studio (or build one with rojo build).
  2. 2.Install the Rojo plugin (rojo plugin install) if you have not already.
  3. 3.Connect to localhost:34850.
  4. 4.Run npx robloxui add <slug> from your project root.