Documentation

Scaffold with init

npx robloxui init creates a production-ready project with Rojo config, mise pins, theme, TSX/React or Luau sample UI, compile step, game.rbxl, and Rojo plugin install when tools are available.

Starting from scratch? npx robloxui init scaffolds a full project — Rojo config, mise.toml toolchain pins, TSX/React or Luau sample UI, and runs a post-setup pipeline (compile, game.rbxl, Rojo plugin). The theme package is opt-in with --theme.

bashnpx robloxui init
bashnpx robloxui init --name my-game --flavor roblox-ts --yes
bashnpx robloxui init --name my-game --flavor luau-wally --yes

Post-setup pipeline (automatic)

  1. 1.Check Node, npm, Rojo, Wally, and mise
  2. 2.Scaffold Rojo config, mise.toml, sample TSX/Luau UI, and components folder
  3. 3.mise install — pin Rojo + Wally for the project
  4. 4.npm install or wally install
  5. 5.Theme (optional) — include with --theme: robloxui/theme for npm, vendored RuiTheme for Luau
  6. 6.npm run build — initial rbxtsc compile (Roblox-TS)
  7. 7.rojo build → game.rbxl when Rojo is available
  8. 8.rojo plugin install — Rojo Studio plugin when Rojo is available

Generated project layout

  • default.project.json
  • mise.toml — pinned Rojo/Wally tools
  • src/client/ui/components/ — marketplace components
  • game.rbxl — open in Studio (when Rojo available)
  • README.md — quick-start commands

Init options

  • --name . — scaffold in the current folder
  • --flavor roblox-ts | luau-wally
  • --yes — non-interactive (requires --name and --flavor)
  • --skip-install — scaffold only, skip post-setup pipeline

Toolchain pins use mise. Run mise install in the project if the pinned tools are not available yet.