Skip to main content
Glama
erickow

Roblox Studio MCP Server

by erickow

RobloxUI CLI

Создайте каркас проекта Roblox и подключите его к Roblox Studio за минуты. robloxui init создаёт проект Roblox-TS или Luau/Wally, предварительно настроенный с Rojo, фиксированным набором инструментов через mise, минимальным спавном игрока и сервером Roblox Studio MCP для инструментов ИИ. Компоненты маркетплейса (robloxui.pencicta.com) можно добавить позже с помощью robloxui add.

Быстрый старт

npx robloxui init

Ответьте на запросы (имя проекта, тип, тема), затем:

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

В Roblox Studio: откройте game.rbxl в папке проекта → плагин Rojo → Подключиться → нажмите Play.

Вот и всё — игровое место с спавном и пустым клиентским монтированием, готовое для UI.

Related MCP server: roblox-studio-mcp

robloxui init

Создайте каркас пустого проекта Roblox-TS или Luau/Wally с минимальным спавном игрока, предварительно настроенным для компонентов RobloxUI, набора инструментов и подключения к Studio.

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

Option

Description

-y, --yes

Неинтерактивный (требует --name + --flavor)

--name <dir>

Имя папки проекта, или . для текущей директории

--flavor <f>

roblox-ts or luau-wally

--skip-install

Пропустить установку зависимостей / настройку темы

--no-bootstrap

Не устанавливать отсутствующий mise автоматически

--theme

Включить тему RobloxUI в каркас

--no-theme

Создать каркас без темы

Создаёт: конфигурацию Rojo, фиксации набора инструментов в mise.toml, стандартные сервисы DataModel (Lighting, ServerStorage, SoundService, StarterGui, StarterPack, StarterCharacterScripts), минимальный спавн игрока, пустое клиентское монтирование, папки src/shared и src/server, а также файл места game.rbxl. Тема RobloxUI подключается по желанию: передайте --theme (или ответьте на запрос), чтобы также подключить канонические токены robloxui/theme. Init устанавливает mise с помощью официального установщика при необходимости.

Существующие проекты проверяются без замены пользовательских сопоставлений Rojo. Неинтерактивный режим отклоняет неоднозначный ввод типа или цели.

Подключение к Roblox Studio

Одноразовая настройка

  1. Запустите npx robloxui init — mise и фиксированные инструменты устанавливаются автоматически

  2. Установите плагин Rojo Studio (Roblox Studio → Plugins → поиск "Rojo")

Рабочий процесс Roblox-TS

Запустите одну команду в вашем проекте:

npm run dev          # compiles and syncs into Studio

File

Role

rojo.json

Сопоставляет out/client → StarterPlayerScripts, npm-пакеты → ReplicatedStorage

src/client/

Ваш исходный код TypeScript

out/client/

Скомпилированный Luau (создаётся командой npm run watch)

В Studio: откройте game.rbxl → плагин Rojo → Подключиться → нажмите Play.

Рабочий процесс Luau / Wally

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

File

Role

default.project.json

Файл проекта Rojo для макетов Wally

wally.toml

Метаданные проекта для Wally (тема поставляется встроенной, без зависимостей)

Packages/RuiTheme/

Вендорная тема (создаётся init / robloxui add)

src/client/init.client.luau

Клиентская загрузка

Для ваших собственных пакетов Wally (не RobloxUI) добавьте их в wally.toml и выполните wally install — сама тема RobloxUI поставляется встроенной и не требует зависимостей.

Studio MCP (инструменты ИИ)

Init может подключить сервер Roblox Studio MCP к вашему инструменту ИИ (opencode.json, .mcp.json, .cursor/mcp.json или .vscode/mcp.json). Включите его один раз в Studio: Assistant → ⋯ → Manage MCP Servers → Enable Studio as MCP server — после этого ваш агент сможет читать дерево игры, редактировать скрипты, вставлять модели и запускать игровые тесты.

Предварительные требования

  • Node.js ≥ 20.12 (требуется для тестовой/сборочной цепочки CLI)

  • mise устанавливается с помощью официального установщика, если его нет в PATH

  • Rojo CLI + плагин Rojo Studio

  • Wally — только для проектов Luau

Если установка отключена, выполните mise install в проекте, чтобы установить фиксированные инструменты.


Всё остальное

Разделы ниже описывают рабочий процесс маркетплейса — установку компонентов, аутентификацию, просмотр каталога и устранение неполадок. Пропустите их, пока вам не понадобится больше, чем каркас.

Аутентификация

Запустите robloxui login один раз. Два варианта:

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

Браузерный вариант выводит короткий код — откройте URL, подтвердите, готово. Ваш токен сохраняется в ~/.config/robloxui/config.json (Linux/macOS) или %APPDATA%\robloxui\config.json (Windows).

CI / безголовые машины: сгенерируйте ключ на Dashboard → Developer, затем вставьте его.

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

Лимиты — Бесплатные пользователи получают 2 загрузки в день. Подписчики Pro получают всё без ограничений. См. https://robloxui.pencipta.com/pricing.

robloxui add <slug...>

Установите один или несколько компонентов.

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

Option

Description

-y, --yes

Принять все значения по умолчанию

--force

Перезаписать существующие файлы

--path <dir>

Переопределить каталог установки

--theme

Также установить пакет темы RobloxUI

--no-theme

Пропустить пакет темы

CLI будет:

  1. Проверять slug, аутентификацию, цель, тип, менеджер пакетов и инструменты перед сетевыми запросами или записью

  2. Определять тип вашего проекта (rojo.json → Roblox-TS, wally.toml → Luau)

  3. Запрашивать путь установки (по умолчанию: src/client/ui/components/) и необходимость установки темы

  4. Загружать исходный код компонента + метаданные из API

  5. Подготавливать и проверять все файлы; конфликты останавливают по умолчанию (--force явный)

  6. Записывать исходный код и, при запросе, транзакционно устанавливать тему

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

Option

Description

--framework <f>

tsx, luau, or both

--category <name>

Фильтровать по категории

--limit <n>

Максимум результатов (по умолчанию 30, макс. 100)

robloxui info <slug>

robloxui info primary-button

Выводит: фреймворк, категорию, зависимости, токены темы, пример использования и точную команду robloxui add.

Определение проекта

Detected

Метод установки темы (только с --theme или по запросу)

rojo.json

npm install robloxui (поставляется с подпутьём robloxui/theme)

wally.toml

Вендорит встроенный RuiTheme в Packages/

Neither

Ручной выбор типа проекта

Тема никогда не устанавливается автоматически: неинтерактивные запуски пропускают её, интерактивные спрашивают. Компоненты работают автономно, так как содержат собственные токены дизайна.

Устранение неполадок

Каждый сбой CLI выводит подсказку по восстановлению (повторить + ручная команда + сохранённые пути). Частые исправления:

Проблема

Исправление

login fails with "invalid_token"

Срок действия токена истёк или он отозван. Запустите robloxui login снова

add says "daily limit reached"

Бесплатный тариф: 2/день. Обновитесь до Pro: https://robloxui.pencipta.com/pricing

add says "Pro component"

Требуется подписка Pro. Запустите robloxui info <slug>, чтобы проверить

Pro component returns no source

Сначала войдите (robloxui login) — доступ Pro привязан к вашей учётной записи

Rojo won't connect

Убедитесь, что npm run dev запущен в корне проекта

Nothing in Play mode (Roblox-TS)

Держите npm run dev запущенным, чтобы out/client/ компилировался и синхронизировался

RuiTheme not found (Luau)

Вы согласились на тему, но она отсутствует: повторно запустите npx robloxui add <slug> --theme (или npm install robloxui для Roblox-TS)

Want the canonical theme later

npm install robloxui (Roblox-TS) или повторно запустите add с --theme (Luau вендорит Packages/RuiTheme/)

UI doesn't appear

Нажмите Play, а не Edit — скрипты выполняются в StarterPlayerScripts

Ссылки

Related MCP Connectors

Related MCP Servers