Documentation

Introduction

RobloxUI is a marketplace of reusable Roblox UI components for Roblox-TS (TSX) and React-Luau. Use the CLI to scaffold projects, sync to Studio, and install components.

Two paths

New project

Run npx robloxui init to scaffold everything, then follow Connect after init.

Existing project

Already have rojo.json or wally.toml? Wire Studio and use npx robloxui add.

Install

global install:

bashnpm i -g robloxui@latest

Quick commands

bashnpx robloxui init

bashnpx robloxui add primary-button

bashnpx robloxui help

Documentation

Getting started

Installation
Node.js, mise, Rojo, Wally, and Roblox Studio — what you need before running the CLI.

Project setup

Scaffold with init
Run npx robloxui init to generate a full Roblox-TS or Luau/Wally project with mise and sample UI.

Roblox Studio

Connect after init
Open game.rbxl, run rojo serve, and press Play in a project created by robloxui init.
Connect existing project
Wire an existing rojo.json or wally.toml project to Studio and add RobloxUI components.

Components & theme

Add components
Install marketplace components with npx robloxui add and use them in your game.
Project types
Roblox-TS vs Luau/Wally — config files, theme packages, and detection.
Theme tokens
Opt into the optional robloxui/theme contract or RuiTheme and browse all design tokens with swatches.

Workflows

AI workflow
Copy AI Context and download project rules for your assistant.
Connect MCP
Connect MCP servers in your IDE and enable the official Roblox Studio MCP server.