# Installation Guide

To use Roblox MCP, you need to install **two things**.

```
AI App (Claude, Codex, Gemini, etc.)
       │
   MCP Server ← Converts AI commands into a format Roblox understands
       │
Roblox Studio Plugin ← Executes commands inside Studio
```

When an AI app says "Create a blue part", the MCP server converts this request, and the Roblox Studio plugin actually creates the part.

---

## One-Line Install (Recommended)

Installs the MCP server, Roblox Studio plugin, and registers with your AI apps in one step:

**macOS / Linux**

```bash
curl -fsSL https://raw.githubusercontent.com/hope1026/weppy-roblox-mcp/main/install.sh | bash
```

**Windows (PowerShell)**

```powershell
irm https://raw.githubusercontent.com/hope1026/weppy-roblox-mcp/main/install.ps1 | iex
```

Then restart Roblox Studio — done!

Automatic MCP registration currently supports **Claude Code, Claude Desktop, Cursor, Codex CLI, and Gemini CLI**.
**Codex App** and **Antigravity** still require manual setup after the script finishes.

If PowerShell execution is blocked on Windows, use the manual install path below. If you're using the ZIP package, you can also run `setup-plugin.bat` and `setup-mcp.bat`.

---

## Manual Install

If the one-line install does not work, or automatic installation is not available in your environment, use the manual install path below as an alternative.

### Step 1: Install Roblox Studio Plugin

Download the plugin file from GitHub, then place it in Roblox Studio's Plugins folder.

👉 [Plugin Installation Guide](roblox-plugin.md)

---

### Step 2: Register MCP Server with AI App

Register the MCP server with your AI app. You can use it with any AI app that supports MCP.

| AI App | Installation Guide |
|--------|-------------------|
| Claude Code | [Setup Instructions](ai-apps/claude-code.md) |
| Claude Desktop | [Setup Instructions](ai-apps/claude-app.md) |
| Cursor | [Setup Instructions](ai-apps/cursor.md) |
| Codex CLI | [Setup Instructions](ai-apps/codex-cli.md) |
| Codex Desktop | [Setup Instructions](ai-apps/codex-app.md) |
| Gemini CLI | [Setup Instructions](ai-apps/gemini-cli.md) |
| Antigravity | [Setup Instructions](ai-apps/antigravity.md) |

> Even if your AI app isn't listed above, you can use it if it supports MCP. The MCP server command is `npx -y @weppy/roblox-mcp`.

---

## Optional: Install Roblox Explorer (VSCode Extension)

Browse synced instance trees inside VSCode with Roblox class icons.
This optional extension requires the Roblox MCP setup above, because it reads `roblox-project-sync` data generated by Sync.

👉 [Roblox Explorer Installation Guide](roblox-explorer.md)

---

## After Installation

1. Open **Roblox Studio**, go to Plugins tab and click **W-MCP** → **Connect**
2. Test in your **AI app** with:

```
Create a blue part in Roblox Studio
```

If the part is created successfully, installation is complete!
