unity

Files (1)

• SKILL.md

SKILL.md (first lines)

# Unity

AI-driven Unity Editor automation through the Unity MCP server. Enables
script generation, asset management, scene manipulation, and play-mode testing
from any MCP-capable agent (ox, Claude, Kilo).

## Installation

### Prerequisites

- Unity Hub + Unity Editor (2021.3 LTS or newer)
- Node.js >= 18
- ox agent with MCP support

### Step 1 — Install the Unity MCP server

```bash
# Via npm
npm install -g @ox-mcp/unity-mcp

# Or via npx (no global install needed)
# The server will be fetched on first run
```

### Step 2 — Enable Unity Editor integration

1. Open Unity Hub → Installs → select your Unity version
2. In Unity Editor, open the project you want to automate
3. Install the Unity MCP package:

```bash
# From your Unity project root
openupm add com.ox.mcp.unity
```

Or via Unity Package Manager → Add package from git URL:
```
https://github.com/ox-platform/unity-mcp.git
```

### Step 3 — Configure MCP in ox

Add to `~/.config/ox/mcp.json`:

```json
{
  "mcpServers": {
    "unity": {
      "command": "npx",
      "args": ["@ox-mcp/unity-mcp"],
      "env": {
        "UNITY_PROJECT_PATH": "/path/to/your/unity/project",
        "UNITY_EDITOR_PATH": "/Applications/Unity/Hub/Editor/2022.3.5f1/Unity.app/Contents/MacOS/Unity",
        "UNITY_MCP_PORT": "8090"
      }
    }
  }
}
```

### Step 4 — Connect the Unity Editor

In the Unity Editor, open the **MCP Bridge** window (Window → Analysis → MCP Bridge)
and click **Connect**. Or run from the Unity console:

```csharp
MCPBridge.Connect("localhost", 8090);
```

### Step 5 — Verify

```bash
ox mcp list
# unity — registered, connected to Editor
```

## Available Tools

| Tool | Description |
|---|---|
| `unity_create_script(name, className, template?)` | Create a C# MonoBehaviour script |
| `unity_edit_script(path, changes)` | Edit an existing script |
| `unity_list_scenes()` | List all scenes in the project |
| `unity_load_scene(name)` | Load a scene into the editor |
| `unity_create_object(type, name, parent?)` | Create a GameObject in the scene |
| `unity_find_objects(query)` | Find GameObjects by name, tag, or type |
| `unity_get_component(go, type)` | Read component properties |
| `unity_set_component(go, type, props)` | Modify component properties |
| `unity_build_player(outputPath, platform?)` | Build the project |
| `unity_play()` | Enter Play Mode |
| `unity_stop()` | Exit Play Mode |
| `unity_take_screenshot(path?)` | Screenshot the Game view |
| `unity_console()` | Read console logs |
| `unity_import_asset(path)` | Import an asset into the project |
| `unity_create_prefab(go, name)` | Convert GameObject to a prefab |

## Usage Examples

### Generate a Script

```js
const script = await tools.unity_create_script(
  "PlayerController", "PlayerController", "monobehaviour"
);

// Then edit it
await tools.unity_edit_script(script.path, {
  methods: [{
    name: "Update",
    body: `if (Input.GetKeyDown(KeyCode.Space)) {
  Jump();
}`
  }]
});
```

### Scene Setup

```js

From SAI141003/ox, MIT.

More from SAI141003/ox