Roblox Studio Hub

A tool for managing multiple Roblox Studio instances and executing Lua code remotely via CLI and HTTP API.

Overview

Roblox Studio Hub provides:

• Multi-Studio Management - Connect and manage multiple Roblox Studio instances simultaneously
• Remote Code Execution - Execute Lua code in Studio with three modes (eval, run, play)
• CLI Interface - Full-featured command line interface for all operations
• System Service - Run as background service with auto-start on boot

Architecture

┌─────────────────┐     HTTP Long Polling     ┌─────────────────┐
│  Roblox Studio  │ ◄──────────────────────► │   Studio Hub    │
│    (Plugin)     │                           │    (Server)     │
└─────────────────┘                           └────────┬────────┘
                                                       │
                                              ┌────────▼────────┐
                                              │    CLI / API    │
                                              │  localhost:35888│
                                              └─────────────────┘

Quick Start

1. Install Hub Server

必须保证当前运行在 管理员 权限中, 否则提醒用户并中断本次会话.

# Configure GitHub npm registry
npm config set @white-dragon-tools:registry https://npm.pkg.github.com

# Install globally
npm install -g @white-dragon-tools/roblox-studio-hub

2. Register as System Service (Recommended)

# Register as system service (auto-start on boot)
# Windows: Run as Administrator
# Mac/Linux: Use sudo
roblox-studio-hub install

# Check service status
roblox-studio-hub status

3. Install Studio Plugin

roblox-studio-hub install-plugin

4. Verify Setup

roblox-studio-hub status

CLI Commands Reference

All commands support -h or --help for detailed help.

Service Management

Studio Management

Code Execution

# Basic usage
roblox-studio-hub exec <studioId> <file> [-m mode]

# Examples
roblox-studio-hub exec place:123456 script.lua           # Execute with eval mode
roblox-studio-hub exec local:MyGame test.lua -m run      # Server-side test
roblox-studio-hub exec path:D:/Projects/MyGame test.lua --mode play  # Full play mode

Plugin Management

roblox-studio-hub install-plugin    # Install Studio plugin

Update Hub

roblox-studio-hub update

The update command automatically:

1. Stops running service
2. Executes npm update
3. Restarts service

Execution Modes

Studio ID Format

• Cloud place: place:{placeId} (e.g., place:123456)
• Local file: local:{placeName} (e.g., local:MyGame)
• Custom path: path:{localPath} (e.g., path:D:/Projects/MyGame)

Common Workflows

Check Connected Studios

# List all connected Studios
roblox-studio-hub list

# Get details of a specific Studio
roblox-studio-hub info place:123456

Execute Lua Script

# Create a test script
echo "print('Hello from Hub!'); return 42" > test.lua

# Execute on a connected Studio
roblox-studio-hub exec place:123456 test.lua

View Studio Logs

# View last 100 logs (default)
roblox-studio-hub logs place:123456

# View last 50 logs
roblox-studio-hub logs local:MyGame -n 50

Update Hub to Latest Version

# Update with automatic service handling
roblox-studio-hub update

# Update plugin if needed
roblox-studio-hub install-plugin

API Reference (for programmatic access)

Check Hub Status

GET /api/status

List Connected Studios

GET /api/studios

Get Studio Details

GET /api/studios/:id

Get Studio Logs

GET /api/studios/:id/logs?limit=100

Execute Code

POST /api/execute
Content-Type: application/json

{
  "studioId": "place:123456",
  "code": "print('Hello'); return 42",
  "mode": "eval",
  "timeout": 30
}

Configuration

Environment Variables

Troubleshooting

Additional Resources

Reference Files

For detailed API documentation and patterns:

• references/api-reference.md - Complete API specification
• references/lua-patterns.md - Common Lua code patterns for testing