|
| 1 | +# MCP for Unity v5 Migration Guide |
| 2 | + |
| 3 | +This guide will help you migrate from the legacy UnityMcpBridge installation to the new MCPForUnity package structure in version 5. |
| 4 | + |
| 5 | +## Overview |
| 6 | + |
| 7 | +Version 5 introduces a new package structure. The package is now installed from the `MCPForUnity` folder instead of the legacy `UnityMcpBridge` folder. |
| 8 | + |
| 9 | +## Migration Steps |
| 10 | + |
| 11 | +### Step 1: Uninstall the Current Package |
| 12 | + |
| 13 | +1. Open the Unity Package Manager (**Window > Package Manager**) |
| 14 | +2. Select **Packages: In Project** from the dropdown |
| 15 | +3. Find **MCP for Unity** in the list |
| 16 | +4. Click the **Remove** button to uninstall the legacy package |
| 17 | + |
| 18 | + |
| 19 | + |
| 20 | +### Step 2: Install from the New Path |
| 21 | + |
| 22 | +1. In the Package Manager, click the **+** button in the top-left corner |
| 23 | +2. Select **Add package from disk...** |
| 24 | +3. Navigate to the `MCPForUnity` folder (NOT the old `UnityMcpBridge` folder) |
| 25 | +4. Select the `package.json` file inside the `MCPForUnity` folder |
| 26 | +5. Click **Open** to install the package |
| 27 | + |
| 28 | + |
| 29 | + |
| 30 | +### Step 3: Rebuild MCP Server |
| 31 | + |
| 32 | +After installing the new package, you need to rebuild the MCP server: |
| 33 | + |
| 34 | +1. In Unity, go to **Window > MCP for Unity > Open MCP Window** |
| 35 | + |
| 36 | +2. Click the **Rebuild MCP Server** button |
| 37 | + |
| 38 | +3. You should see a success message confirming the rebuild |
| 39 | + |
| 40 | + |
| 41 | +## Verification |
| 42 | + |
| 43 | +After completing these steps, verify the migration was successful: |
| 44 | + |
| 45 | +- Check that the package appears in the Package Manager as **MCP for Unity** |
| 46 | +- Confirm the package location shows the new `MCPForUnity` path |
| 47 | +- Test basic MCP functionality to ensure everything works correctly |
| 48 | + |
| 49 | +## Troubleshooting |
| 50 | + |
| 51 | +- Check the Unity Console for specific error messages |
| 52 | +- Ensure Python dependencies are properly installed |
| 53 | +- Try pressing the rebuild button again |
| 54 | +- Try restarting Unity and repeating the installation steps |
0 commit comments