Skip to content

Commit 7087797

Browse files
committed
docs: improve README formatting and add note about package reinstallation
1 parent 823bae6 commit 7087797

File tree

1 file changed

+13
-25
lines changed

1 file changed

+13
-25
lines changed

README.md

Lines changed: 13 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# Unity MCP ✨
2+
23
#### Proudly sponsored and maintained by [Coplay](https://www.coplay.dev/?ref=unity-mcp), the AI assistant for Unity.
34

45
[![Discord](https://img.shields.io/badge/discord-join-red.svg?logo=discord&logoColor=white)](https://discord.gg/y4p8KfzrN4)
@@ -20,10 +21,8 @@ Unity MCP acts as a bridge, allowing AI assistants (like Claude, Cursor) to inte
2021

2122
**Get help, share ideas, and collaborate with other Unity MCP developers!**
2223

23-
2424
---
2525

26-
2726
## Key Features 🚀
2827

2928
* **🗣️ Natural Language Control:** Instruct your LLM to perform Unity tasks.
@@ -65,7 +64,6 @@ Unity MCP connects your tools using two components:
6564
6665
### Prerequisites
6766

68-
6967
* **Git CLI:** For cloning the server code. [Download Git](https://git-scm.com/downloads)
7068
* **Python:** Version 3.12 or newer. [Download Python](https://www.python.org/downloads/)
7169
* **Unity Hub & Editor:** Version 2020.3 LTS or newer. [Download Unity](https://unity.com/download)
@@ -98,9 +96,8 @@ Unity MCP connects your tools using two components:
9896
3. Ensure .NET compatibility settings are correct
9997
4. Add `USE_ROSLYN` to Scripting Define Symbols
10098
5. Restart Unity
101-
102-
**Note:** Without Roslyn, script validation falls back to basic structural checks. Roslyn enables full C# compiler diagnostics with precise error reporting.</details>
10399

100+
**Note:** Without Roslyn, script validation falls back to basic structural checks. Roslyn enables full C# compiler diagnostics with precise error reporting.</details>
104101

105102
### Step 1: Install the Unity Package (Bridge)
106103

@@ -114,6 +111,8 @@ Unity MCP connects your tools using two components:
114111
5. Click `Add`.
115112
6. The MCP Server should automatically be installed onto your machine as a result of this process.
116113

114+
**Note:** If you installed the MCP Server before Coplay's maintenance, you will need to uninstall the old package before re-installing the new one.
115+
117116
### Step 2: Configure Your MCP Client
118117
119118
Connect your MCP Client (Claude, Cursor, etc.) to the Python server you installed in Step 1.
@@ -177,6 +176,7 @@ If Auto-Configure fails or you use a different client:
177176
}
178177
}
179178
```
179+
180180
(Replace YOUR_USERNAME if using ~/bin)
181181

182182
**Linux:**
@@ -200,18 +200,18 @@ If Auto-Configure fails or you use a different client:
200200

201201
(Replace YOUR_USERNAME)
202202

203-
204-
205203
**For Claude Code**
206204

207205
If you\'re using Claude Code, you can register the MCP server using these commands:
208206

209207
**macOS:**
208+
210209
```bash
211210
claude mcp add UnityMCP -- uv --directory /[PATH_TO]/UnityMCP/UnityMcpServer/src run server.py
212211
```
213212

214213
**Windows:**
214+
215215
```bash
216216
claude mcp add UnityMCP -- "C:/Users/USERNAME/AppData/Roaming/Python/Python313/Scripts/uv.exe" --directory "C:/Users/USERNAME/AppData/Local/Programs/UnityMCP/UnityMcpServer/src" run server.py
217217
```
@@ -228,23 +228,26 @@ claude mcp add UnityMCP -- "C:/Users/USERNAME/AppData/Roaming/Python/Python313/S
228228
3. **Interact!** Unity tools should now be available in your MCP Client.
229229

230230
Example Prompt: `Create a 3D player controller`, `Create a yellow and bridge sun`, `Create a cool shader and apply it on a cube`.
231-
231+
232232
---
233233

234234
## Future Dev Plans (Besides PR) 📝
235235

236236
### 🔴 High Priority
237+
237238
- [ ] **Asset Generation Improvements** - Enhanced server request handling and asset pipeline optimization
238239
- [ ] **Code Generation Enhancements** - Improved generated code quality and error handling
239240
- [ ] **Robust Error Handling** - Comprehensive error messages, recovery mechanisms, and graceful degradation
240241
- [ ] **Remote Connection Support** - Enable seamless remote connection between Unity host and MCP server
241242
- [ ] **Documentation Expansion** - Complete tutorials for custom tool creation and API reference
242243

243244
### 🟡 Medium Priority
245+
244246
- [ ] **Custom Tool Creation GUI** - Visual interface for users to create and configure their own MCP tools
245247
- [ ] **Advanced Logging System** - Logging with filtering, export, and debugging capabilities
246248

247249
### 🟢 Low Priority
250+
248251
- [ ] **Mobile Platform Support** - Extended toolset for mobile development workflows and platform-specific features
249252
- [ ] **Easier Tool Setup**
250253
- [ ] **Plugin Marketplace** - Community-driven tool sharing and distribution platform
@@ -257,6 +260,7 @@ claude mcp add UnityMCP -- "C:/Users/USERNAME/AppData/Roaming/Python/Python313/S
257260
</details>
258261

259262
### 🔬 Research & Exploration
263+
260264
- [ ] **AI-Powered Asset Generation** - Integration with AI tools for automatic 3D models, textures, and animations
261265
- [ ] **Real-time Collaboration** - Live editing sessions between multiple developers *(Currently in progress)*
262266
- [ ] **Analytics Dashboard** - Usage analytics, project insights, and performance metrics
@@ -302,28 +306,17 @@ Help make Unity MCP better!
302306
<summary><strong>Click to view common issues and fixes...</strong></summary>
303307

304308
- **Unity Bridge Not Running/Connecting:**
305-
306309
- Ensure Unity Editor is open.
307-
308310
- Check the status window: Window > Unity MCP.
309-
310311
- Restart Unity.
311-
312312
- **MCP Client Not Connecting / Server Not Starting:**
313-
314313
- **Verify Server Path:** Double-check the --directory path in your MCP Client\'s JSON config. It must exactly match the location where you cloned the UnityMCP repository in Installation Step 1 (e.g., .../Programs/UnityMCP/UnityMcpServer/src).
315-
316314
- **Verify uv:** Make sure `uv` is installed and working (pip show uv).
317-
318315
- **Run Manually:** Try running the server directly from the terminal to see errors: `# Navigate to the src directory first! cd /path/to/your/UnityMCP/UnityMcpServer/src uv run server.py`
319-
320316
- **Permissions (macOS/Linux):** If you installed the server in a system location like /usr/local/bin, ensure the user running the MCP client has permission to execute uv and access files there. Installing in ~/bin might be easier.
321-
322317
- **Auto-Configure Failed:**
323-
324318
- Use the Manual Configuration steps. Auto-configure might lack permissions to write to the MCP client\'s config file.
325319

326-
327320
</details>
328321

329322
Still stuck? [Open an Issue](https://github.com/CoplayDev/unity-mcp/issues) or [Join the Discord](https://discord.gg/y4p8KfzrN4)!
@@ -336,19 +329,14 @@ MIT License. See [LICENSE](LICENSE) file.
336329

337330
---
338331

339-
## Acknowledgments 🙏
340-
341-
Thanks to the contributors and our sponsors [Coplay](https://coplay.dev/?ref=unity-mcp).
342-
343332
## Star History
344333

345334
[![Star History Chart](https://api.star-history.com/svg?repos=CoplayDev/unity-mcp&type=Date)](https://www.star-history.com/#CoplayDev/unity-mcp&Date)
346335

347-
348336
## Sponsor
349337

350338
<p align="center">
351339
<a href="https://www.coplay.dev/?ref=unity-mcp" target="_blank" rel="noopener noreferrer">
352340
<img src="logo.png" alt="Coplay Logo" width="100%">
353341
</a>
354-
</p>
342+
</p>

0 commit comments

Comments
 (0)