PHXH
/
unity-mcp
51
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: update README(s) for Auto-Setup and dev cache path

main
dsarno 2025-08-09 15:38:11 -07:00
parent 07b35837b7
commit 24ed3a2e2a
2 changed files with 15 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README-DEV.md
View File

@ -46,16 +46,22 @@ Restores original files from backup.
## Finding Unity Package Cache Path ## Finding Unity Package Cache Path
Unity package cache is typically located at: Unity stores Git packages under a version-or-hash folder. Expect something like:
``` ```
X:\UnityProject\Library\PackageCache\com.coplaydev.unity-mcp@1.0.0 X:\UnityProject\Library\PackageCache\com.coplaydev.unity-mcp@<version-or-hash>
```
Example (hash):
```
X:\UnityProject\Library\PackageCache\com.coplaydev.unity-mcp@272123cfd97e
``` ```
To find it: To find it reliably:
1. Open Unity Package Manager 1. Open Unity Package Manager
2. Select "Unity MCP" package 2. Select "Unity MCP" package
3. Right click on the package and "Show in Explorer" 3. Right click the package and choose "Show in Explorer"
4. Navigate to the path above with your username and version 4. That opens the exact cache folder Unity is using for your project
Note: In recent builds, the Python server sources are also bundled inside the package under `UnityMcpServer~/src`. This is handy for local testing or pointing MCP clients directly at the packaged server.
## Workflow ## Workflow

8
README.md
View File

@ -120,15 +120,15 @@ Connect your MCP Client (Claude, Cursor, etc.) to the Python server you installe
<img width="609" alt="image" src="https://github.com/user-attachments/assets/cef3a639-4677-4fd8-84e7-2d82a04d55bb" /> <img width="609" alt="image" src="https://github.com/user-attachments/assets/cef3a639-4677-4fd8-84e7-2d82a04d55bb" />
**Option A: Auto-Configure (Recommended for Claude/Cursor/VSC Copilot)** **Option A: Auto-Setup (Recommended for Claude/Cursor/VSC Copilot)**
1. In Unity, go to `Window > Unity MCP`. 1. In Unity, go to `Window > Unity MCP`.
2. Click `Auto Configure` on the IDE you uses. 2. Click `Auto-Setup`.
3. Look for a green status indicator 🟢 and "Connected". *(This attempts to modify the MCP Client\'s config file automatically)*. 3. Look for a green status indicator 🟢 and "Connected ✓". *(This attempts to modify the MCP Client\'s config file automatically)*.
**Option B: Manual Configuration** **Option B: Manual Configuration**
If Auto-Configure fails or you use a different client: If Auto-Setup fails or you use a different client:
1. **Find your MCP Client\'s configuration file.** (Check client documentation). 1. **Find your MCP Client\'s configuration file.** (Check client documentation).
* *Claude Example (macOS):* `~/Library/Application Support/Claude/claude_desktop_config.json` * *Claude Example (macOS):* `~/Library/Application Support/Claude/claude_desktop_config.json`