Documentation

Project types

The CLI scans for rojo.json or wally.toml and installs components to src/client/ui/components/ with the matching theme package.

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.

Theme install:

bashnpm install robloxui # optional robloxui/theme subpath

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

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

Theme install:

bashrobloxui add <slug> --theme # vendors bundled RuiTheme

See the full token reference with install examples on the Theme tokens.