Editor workflow

Editor command reference

Every command registered by Bricklayer Editor, and where to find it: the Command Palette, the Home panel, context menus, or a keyboard shortcut.

Accessing commands

Commands can be run through five primary interfaces:

Command Palette. Press Cmd+Shift+P/Ctrl+Shift+P and type Bricklayer to view palette commands.
Home Panel. Activity bar tiles provide shortcuts for Welcome, Agent Chat, Studio Connection, and Setup.
View Toolbars. The Game Tree, Game Panel, and Checkpoints view titles contain dedicated command icons.
Context Menus. Right-click items in the Game Tree to access instance-level actions.
Status Bar. Clicking the status bar indicator launches the diagnostics troubleshooter.

Important concept distinctions

Bricklayer: Connect to Studio starts the background mirror companion runtime and ensures workspace settings are present. Pair This Folder With Studio explicitly binds the open local folder to the active place in Roblox Studio, writing bricklayer.json.

If Studio is open but scripts are not syncing, running Pair is required.

Start Playtest (F5) vs Start Playtest in Studio

Bricklayer: Start Playtest (F5) checks whether Studio MCP controls are available. If available, it starts the playtest session directly. If unavailable, it flushes pending file edits to disk and prompts you to press F5 inside Studio. Bricklayer: Start Playtest in Studio invokes the direct API route and requires active Studio MCP integration.

Command Palette reference

Commands accessible directly from the Command Palette (Cmd+Shift+P/Ctrl+Shift+P).

Onboarding & Setup

Initial configuration, plugin installation, and diagnostics.

Bricklayer: Open Welcome

Opens the Welcome tab. Used to create new games from starters, open existing places, configure folder pairing, install the plugin, or launch the agent picker.

bricklayer.welcome

Bricklayer: Choose AI Agent

Cmd+I/Ctrl+I

Focuses the agent sidebar chat. Configures models from OpenRouter, OpenAI, Ollama, ACP presets, or installed agent extensions.

bricklayer.agents

Bricklayer: Troubleshoot (Setup & Diagnostics)

Opens a quick pick menu evaluating workspace trust, project status, plugin install, companion status, and sync health. Provides one-click fixes for identified issues.

bricklayer.setup

Bricklayer: Install Studio Plugin

Copies the bundled plugin file (Bricklayer.rbxm) into the local Roblox Studio plugins folder.

bricklayer.installPlugin

Studio Connection & Pairing

Manage the connection and binding between your workspace folder and Roblox Studio.

Bricklayer: Connect to Studio

Ensures configuration files (.mcp.json and Luau settings) exist and starts the companion runtime if it is not already running.

bricklayer.connect

Pair This Folder With Studio

Binds the current open folder to the active place in Roblox Studio, writing bricklayer.json and project settings.

bricklayer.pairFolder

Bricklayer: Connect Another AI Agent (MCP)

Generates Model Context Protocol configuration snippets for external clients like Claude Code, Cursor, Windsurf, Cline, Roo, Zed, and JetBrains.

bricklayer.mcpConnect

Bricklayer: Start Companion

Launches the local mirror companion process responsible for communication between the editor and the Studio plugin.

bricklayer.startCompanion

Bricklayer: Stop Managed Companion

Stops the companion process managed by the current editor window.

bricklayer.stopCompanion

Playtesting & Debugging

Control playtests, capture viewports, and inspect runtime data.

Bricklayer: Start Playtest

F5

Initiates a playtest. If Studio MCP control is present, starts play directly. Otherwise flushes pending edits and prompts to start play in Studio.

bricklayer.playtest

Bricklayer: Start Playtest in Studio

Sends a direct request to Studio to start a playtest session. Requires Studio MCP play control.

bricklayer.game.play

Bricklayer: Stop Playtest in Studio

Shift+F5

Stops an active playtest session in Studio.

bricklayer.game.stop

Bricklayer: Capture Studio Window

Takes a viewport screenshot of the current Studio window and displays it in the Game panel.

bricklayer.game.capture

Bricklayer: Show Game Panel

Opens the bottom Game panel containing play controls, stats, console logs, and screenshots.

bricklayer.game.show

Bricklayer: Show Status

Opens the diagnostics quick pick menu. Triggered when clicking the status bar item.

bricklayer.showStatus

Game Tree Explorer

Inspect and search the game instance hierarchy.

Bricklayer: Refresh Game Tree

Reloads the place structure map and updates the Game Tree view.

bricklayer.explorer.refresh

Bricklayer: Find in Game Tree

Cmd+Shift+O/Ctrl+Shift+O

Opens an input box to filter instances in the Game Tree by name fragment.

bricklayer.explorer.search

Checkpoints

Save and refresh project state snapshots.

Bricklayer: Save a Checkpoint

Prompts for a label and creates a project checkpoint containing a Git commit and Studio waypoint.

bricklayer.checkpoint.create

Bricklayer: Refresh Checkpoints

Reloads and renders the Checkpoints timeline view.

bricklayer.checkpoint.refresh

Editor Updates

Check for updates and manage releases.

Bricklayer: Check for Updates

Checks the release manifest to verify whether a newer editor build is available.

bricklayer.checkForUpdate

Bricklayer: Open the Update Download Page

Navigates to the GitHub release page for downloading the latest release.

bricklayer.downloadUpdate

Commands triggered directly from Game Tree right-click menus, CodeLens links, or view toolbars. These are hidden from the Command Palette to avoid clutter.

Command title	Trigger location	Action
Bricklayer: Open Script`bricklayer.explorer.openScript`	Clicking a script in the Game Tree	Opens the corresponding local Luau file in a preview editor tab.
Bricklayer: Select in Studio`bricklayer.explorer.revealInStudio`	Game Tree context menu / Luau CodeLens	Selects the specified instance inside Roblox Studio.
Bricklayer: Show Properties`bricklayer.explorer.inspect`	Game Tree context menu	Loads instance properties into the Properties panel.
Bricklayer: Point Studio Camera at This`bricklayer.explorer.frameCamera`	Game Tree context menu (geometry objects)	Positions the Studio viewport camera onto the selected instance.
Bricklayer: Drop to Ground`bricklayer.explorer.snapToGround`	Game Tree context menu (geometry objects)	Raycasts the selected instance downward until it touches a surface.
Bricklayer: Copy Instance Path`bricklayer.explorer.copyPath`	Game Tree context menu	Copies the full path string (e.g. game.Workspace.Lobby) to the clipboard.
Bricklayer: Clear Game Console`bricklayer.game.clear`	Game Panel clear button	Clears captured output logs and screenshot previews from the Game panel.

Keyboard shortcuts

Default keybindings mapped to Bricklayer actions.

Shortcut	Command	Context
`Cmd+Shift+P`/`Ctrl+Shift+P`	VS Code Command Palette	Global
`Cmd+I`/`Ctrl+I`	Focus AI Agent Chat	When chat is available
`F5`	Start Playtest	Project open, debug inactive
`Shift+F5`	Stop Playtest in Studio	Project open, debug inactive
`Cmd+Shift+O`/`Ctrl+Shift+O`	Find in Game Tree	Game Tree focused