@@ -18,7 +18,41 @@ This project is perfect for developers who want to leverage LLMs to enhance thei
1818
1919## Installation
2020
21- Follow these simple steps to get started with the Unity MCP Server:
21+ ### Prerequisites
22+
23+ - Unity 2020.3 LTS or newer
24+ - Python 3.7 or newer
25+ - uv package manager
26+
27+ ** If you're on Mac, please install uv as**
28+
29+ ``` bash
30+ brew install uv
31+ ```
32+
33+ ** On Windows**
34+
35+ ``` bash
36+ powershell -c " irm https://astral.sh/uv/install.ps1 | iex"
37+ ```
38+
39+ and then add to your PATH:
40+
41+ ``` bash
42+ set Path=%USERPROFILE%\. local\b in; %Path%
43+ ```
44+
45+ ** On Linux**
46+
47+ ``` bash
48+ curl -LsSf https://astral.sh/uv/install.sh | sh
49+ ```
50+
51+ Otherwise, installation instructions are on their website: [ Install uv] ( https://docs.astral.sh/uv/getting-started/installation/ )
52+
53+ ** ⚠️ Do not proceed before installing UV**
54+
55+ ### Unity Package Installation
2256
23571 . ** Add the Unity Package**
2458
@@ -27,27 +61,62 @@ Follow these simple steps to get started with the Unity MCP Server:
2761 - Enter: ` https://github.com/justinpbarnett/unity-mcp.git `
2862
29632 . ** Set Up Python Environment**
30-
31- - Install [ Python] ( https://www.python.org/downloads/ ) (version 3.7 or higher)
32- - Install ` uv ` package manager:
33- ``` bash
34- pip install uv
35- ```
36- - Navigate to ` Python` in your project
64+ - Navigate to the Python directory in your project:
65+ - If installed as a package: ` Library/PackageCache/com.justinpbarnett.unity-mcp/Python `
66+ - If installed locally: ` Assets/unity-mcp/Python `
3767 - Install dependencies:
3868 ``` bash
3969 uv venv
4070 uv pip install -e .
4171 ```
4272
43- 3. ** Configure Claude Desktop**
73+ # ## Claude Desktop Integration
74+
75+ 1. Open the Unity MCP window (` Window > Unity MCP` )
76+ 2. Click the " Configure Claude" button
77+ 3. Follow the on-screen instructions to set up the integration
78+
79+ Alternatively, manually configure Claude Desktop:
80+
81+ 1. Go to Claude > Settings > Developer > Edit Config
82+ 2. Edit ` claude_desktop_config.json` to include:
83+
84+ ` ` ` json
85+ {
86+ " mcpServers" : {
87+ " unityMCP" : {
88+ " command" : " uv" ,
89+ " args" : [
90+ " --directory" ,
91+ " /path/to/your/unity-mcp/Python" ,
92+ " run" ,
93+ " server.py"
94+ ]
95+ }
96+ }
97+ }
98+ ` ` `
99+
100+ Replace ` /path/to/your/unity-mcp/Python` with the actual path to the Unity MCP Python directory.
101+
102+ # ## Cursor Integration
103+
104+ 1. Open the Unity MCP window (` Window > Unity MCP` )
105+ 2. Click the " Configure Cursor" button
106+ 3. Follow the on-screen instructions to set up the integration
107+
108+ Alternatively, go to Cursor Settings > MCP and paste this as a command:
109+
110+ ` ` ` bash
111+ uv --directory " /path/to/your/unity-mcp/Python" run server.py
112+ ` ` `
113+
114+ Replace ` /path/to/your/unity-mcp/Python` with the actual path to the Unity MCP Python directory.
44115
45- - Open the Unity MCP window (` Window > Unity MCP` )
46- - Click the " Configure Claude" button
47- - Follow the on-screen instructions to set up the integration
116+ ** ⚠️ Only run one instance of the MCP server (either on Cursor or Claude Desktop), not both**
48117
49- 4. ** Start Claude Desktop**
50- - Launch Claude Desktop
118+ 4. ** Start Claude Desktop or Cursor **
119+ - Launch your preferred tool
51120 - The Unity MCP Server will automatically connect
52121
53122# # Configuration
@@ -97,7 +166,7 @@ If you prefer to manually configure your MCP client (like Claude Desktop or Curs
97166
981673. **Find the Correct Python Path**
99168
100- - If installed as a package: Look in `Library/PackageCache/com.justinpbarnett.unitymcpserver /Python`
169+ - If installed as a package: Look in `Library/PackageCache/com.justinpbarnett.unity-mcp /Python`
101170 - If installed locally: Look in `Assets/unity-mcp/Python`
102171
1031724. **Verify Configuration**
0 commit comments