RobloxUI CLI

Erstellen Sie in Minuten ein Roblox-Projekt und verbinden Sie es mit Roblox Studio. robloxui init erstellt ein Roblox-TS- oder Luau/Wally-Projekt, das bereits mit Rojo, einer mise-fixierten Toolchain, einem minimalen Player-Spawn und dem Roblox Studio MCP-Server für KI-Tools vorkonfiguriert ist. Marktplatzkomponenten (robloxui.pencicta.com) können später mit robloxui add hinzugefügt werden.

Schnellstart

npx robloxui init

Beantworten Sie die Eingabeaufforderungen (Projektname, Geschmacksrichtung, Theme), dann:

cd my-game
npm run dev          # compiles and syncs into Studio

In Roblox Studio: Öffnen Sie game.rbxl im Projektordner → Rojo-Plugin → Verbinden → drücken Sie Play.

Das war's – ein spielbarer Ort mit einem Spawn und einem leeren Client-Mount, bereit für die Benutzeroberfläche.

robloxui init

Erstellt ein leeres Roblox-TS- oder Luau/Wally-Projekt mit einem minimalen Player-Spawn, vorkonfiguriert für RobloxUI-Komponenten, Toolchain und Studio-Verbindung.

robloxui init --name my-game --flavor roblox-ts --yes
robloxui init --name . --flavor luau-wally --yes   # scaffold in cwd
robloxui init --name my-game --flavor roblox-ts --yes --theme  # include the theme

Erstellt: Rojo-Konfiguration, mise.toml-Toolchain-Festlegungen, die standardmäßigen DataModel-Dienste (Lighting, ServerStorage, SoundService, StarterGui, StarterPack, StarterCharacterScripts), einen minimalen Player-Spawn, leeren Client-Mount, src/shared + src/server-Ordner und eine game.rbxl-Ortsdatei. Das RobloxUI-Theme ist optional: Übergeben Sie --theme (oder beantworten Sie die Eingabeaufforderung), um auch die kanonischen robloxui/theme-Tokens einzubinden. Init bootet mise bei Bedarf mit dem offiziellen Installer.

Vorhandene Projekte werden überprüft, ohne benutzerdefinierte Rojo-Zuordnungen zu ersetzen. Der nicht-interaktive Modus lehnt mehrdeutige Geschmacksrichtungs- oder Ziel-Eingaben ab.

Mit Roblox Studio verbinden

Einmalige Einrichtung

1. Führen Sie npx robloxui init aus – mise und festgelegte Tools werden automatisch gebootet

2. Installieren Sie das Rojo Studio-Plugin (Roblox Studio → Plugins → suchen Sie "Rojo")

Roblox-TS-Workflow

Führen Sie einen Befehl in Ihrem Projekt aus:

npm run dev          # compiles and syncs into Studio

In Studio: Öffnen Sie game.rbxl → Rojo-Plugin → Verbinden → drücken Sie Play.

Luau / Wally-Workflow

npm run dev                                # installs/syncs the Wally project into Studio

Fügen Sie für Ihre eigenen (nicht-RobloxUI) Wally-Pakete diese zu wally.toml hinzu und führen Sie wally install aus – das RobloxUI-Theme selbst wird gebündelt geliefert und benötigt keine Abhängigkeit.

Studio MCP (KI-Tools)

Init kann den Roblox Studio MCP-Server in Ihr KI-Tool einbinden (opencode.json, .mcp.json, .cursor/mcp.json oder .vscode/mcp.json). Aktivieren Sie es einmal in Studio: Assistant → ⋯ → Manage MCP Servers → Enable Studio as MCP server – dann kann Ihr Agent den Spielbaum lesen, Skripte bearbeiten, Modelle einfügen und Playtests ausführen.

Voraussetzungen

• Node.js ≥ 20.12 (erforderlich durch die CLI-Test-/Build-Toolchain)

• mise wird mit dem offiziellen Installer gebootet, wenn es nicht im PATH ist

• Rojo CLI + Rojo Studio-Plugin

• Wally – nur Luau-Projekte

Wenn das Bootstrap deaktiviert ist, führen Sie mise install im Projekt aus, um die festgelegten Tools zu installieren.

Alles andere

Die folgenden Abschnitte behandeln den Marktplatz-Workflow – das Installieren von Komponenten, Authentifizierung, Durchsuchen des Katalogs und Fehlerbehebung. Überspringen Sie sie, bis Sie mehr als das Gerüst benötigen.

Authentifizierung

Führen Sie robloxui login einmal aus. Zwei Abläufe:

robloxui login                     # browser device flow (recommended)
robloxui login --token <key>       # manual API key (CI / headless)

Der Browser-Ablauf gibt einen kurzen Code aus – öffnen Sie die URL, genehmigen Sie, fertig. Ihr Token wird in ~/.config/robloxui/config.json (Linux/macOS) oder %APPDATA%\robloxui\config.json (Windows) gespeichert.

CI-/Headless-Maschinen: Generieren Sie einen Schlüssel unter Dashboard → Developer, fügen Sie ihn dann ein.

robloxui whoami      # check who you're logged in as
robloxui logout      # remove saved token

Grenzen – Kostenlose Benutzer erhalten 2 Downloads/Tag. Pro-Abonnenten erhalten unbegrenzt alles. Siehe https://robloxui.pencipta.com/pricing.

robloxui add <slug...>

Installiert eine oder mehrere Komponenten.

robloxui add primary-button
robloxui add button card dialog --yes   # non-interactive (CI)
robloxui add button --theme             # also install the theme package

Die CLI wird:

1. Preflight Slug, Authentifizierung, Ziel, Geschmacksrichtung, Paketmanager und Tools vor Netzwerk- oder Schreibvorgängen durchführen

2. Erkennen Ihres Projekttyps (rojo.json → Roblox-TS, wally.toml → Luau)

3. Auffordern zur Eingabe des Installationspfads (Standard: src/client/ui/components/) und ob das Theme installiert werden soll

4. Abrufen des Komponentenquellcodes + der Metadaten von der API

5. Staging und Validierung aller Dateien; Konflikte stoppen standardmäßig (--force ist explizit)

6. Schreiben des Quellcodes und, falls angefordert, transaktionale Installation des Themes

robloxui list / robloxui search

robloxui list                        # browse all components
robloxui search dialog               # search by name/description
robloxui list --framework tsx        # filter by framework
robloxui list --category buttons --limit 20

robloxui info <slug>

robloxui info primary-button

Gibt aus: Framework, Kategorie, Abhängigkeiten, Theme-Tokens, Nutzungsbeispiel und den genauen robloxui add-Befehl.

Projekterkennung

Das Theme wird niemals automatisch installiert: Nicht-interaktive Ausführungen überspringen es, interaktive Ausführungen fragen nach. Komponenten laufen eigenständig, da sie ihre eigenen Design-Tokens enthalten.

Fehlerbehebung

Jeder CLI-Fehler gibt einen Wiederherstellungshinweis aus (Wiederholung + manueller Befehl + erhaltene Pfade). Häufige Korrekturen:

Links

• RobloxUI-Marktplatz

• Preise

• Dokumentation

• npm-Paket