Skip to content

Commit ed98fee

Browse files
authored
Merge pull request #161 from justinpbarnett/Scriptwonder-patch-1
Readme update and minor fix
2 parents 8211d85 + 6665eac commit ed98fee

File tree

2 files changed

+46
-10
lines changed

2 files changed

+46
-10
lines changed

README.md

Lines changed: 44 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,22 @@
11
# Unity MCP ✨
22

3-
**Connect your Unity Editor to LLMs using the Model Context Protocol.**
3+
4+
[![](https://img.shields.io/badge/Unity-000000?style=flat&logo=unity&logoColor=blue 'Unity')](https://unity.com/releases/editor/archive)
5+
[![python](https://img.shields.io/badge/Python-3.12-3776AB.svg?style=flat&logo=python&logoColor=white)](https://www.python.org)
6+
[![](https://badge.mcpx.dev?status=on 'MCP Enabled')](https://modelcontextprotocol.io/introduction)
7+
![GitHub commit activity](https://img.shields.io/github/commit-activity/w/justinpbarnett/unity-mcp)
8+
![GitHub Issues or Pull Requests](https://img.shields.io/github/issues/justinpbarnett/unity-mcp)
9+
[![](https://img.shields.io/badge/License-MIT-red.svg 'MIT License')](https://opensource.org/licenses/MIT)
10+
11+
12+
13+
14+
**Create your Unity apps with LLMs!**
415

516
Unity MCP acts as a bridge, allowing AI assistants (like Claude, Cursor) to interact directly with your Unity Editor via a local **MCP (Model Context Protocol) Client**. Give your LLM tools to manage assets, control scenes, edit scripts, and automate tasks within Unity.
617

718
---
819

9-
## <picture><source media="(prefers-color-scheme: dark)" srcset="https://github.com/justinpbarnett/unity-mcp/assets/11047284/c279675a-dd58-406b-9613-5b16b5c6bb63"><source media="(prefers-color-scheme: light)" srcset="https://github.com/justinpbarnett/unity-mcp/assets/11047284/b54f891d-961b-4048-a9c4-3af46e2a52fc"><img alt="UnityMCP Workflow" width="100%" style="max-width: 600px; display: block; margin-left: auto; margin-right: auto;"></picture>
1020

1121
## Key Features 🚀
1222

@@ -48,8 +58,6 @@ Unity MCP connects your tools using two components:
4858
4959
### Prerequisites
5060

51-
<details>
52-
<summary><strong>Click to view required software...</strong></summary>
5361

5462
* **Git CLI:** For cloning the server code. [Download Git](https://git-scm.com/downloads)
5563
* **Python:** Version 3.12 or newer. [Download Python](https://www.python.org/downloads/)
@@ -62,8 +70,8 @@ Unity MCP connects your tools using two components:
6270
* **An MCP Client:**
6371
* [Claude Desktop](https://claude.ai/download)
6472
* [Cursor](https://www.cursor.com/en/downloads)
73+
* [Visual Studio Code Copilot](https://code.visualstudio.com/docs/copilot/overview)
6574
* *(Others may work with manual config)*
66-
</details>
6775

6876
### Step 1: Install the Unity Package (Bridge)
6977

@@ -84,7 +92,7 @@ Connect your MCP Client (Claude, Cursor, etc.) to the Python server you installe
8492
**Option A: Auto-Configure (Recommended for Claude/Cursor)**
8593

8694
1. In Unity, go to `Window > Unity MCP`.
87-
2. Click `Auto Configure Claude` or `Auto Configure Cursor`.
95+
2. Click `Auto Configure` on the IDE you uses.
8896
3. Look for a green status indicator 🟢 and "Connected". *(This attempts to modify the MCP Client's config file automatically)*.
8997
9098
**Option B: Manual Configuration**
@@ -175,6 +183,28 @@ If Auto-Configure fails or you use a different client:
175183

176184
Example Prompt: `Create a 3D player controller.`
177185

186+
---
187+
188+
## TODOs (Besides PR) 📝
189+
### High Priority
190+
- [ ] **AssetsGeneration Improvements** - Better server request handling
191+
- [ ] **CodeGeneration Improvements** - Better generated code handling
192+
- [ ] **Error Handling Improvements** - Better error messages and recovery mechanisms
193+
- [ ] **Remote Connection** - Enable remote connection between host and server
194+
- [ ] **Documentation Expansion** - Add tutorials on how to add your own tools, and documentation on existing tools and functions
195+
196+
### Medium Priority
197+
- [ ] **Custom Tool Creation** - GUI for users to create their own MCP tools
198+
- [ ] **Logging System** - Comprehensive logging for debugging and monitoring
199+
200+
### Low Priority
201+
- [ ] **Mobile Platform Support** - Extended tools for mobile development workflows
202+
- [ ] **Easier Setup**
203+
204+
### Research & Exploration
205+
- [ ] **AI-Powered Asset Generation** - Integration with AI tools for automatic asset creation
206+
- [ ] **Real-time Collaboration** - Live editing sessions between multiple developers (Currently ongoing)
207+
- [ ] **Analytics Dashboard** - Usage analytics and project insights
178208

179209
---
180210

@@ -227,7 +257,7 @@ Help make Unity MCP better!
227257

228258
</details>
229259

230-
Still stuck? [Open an Issue](https://www.google.com/url?sa=E&q=https%3A%2F%2Fgithub.com%2Fjustinpbarnett%2Funity-mcp%2Fissues).
260+
Still stuck? [Open an Issue](https://www.google.com/url?sa=E&q=https%3A%2F%2Fgithub.com%2Fjustinpbarnett%2Funity-mcp%2Fissues) or [Join the Discord](https://discord.gg/vhTUxXaqYr)!
231261

232262
---
233263

@@ -239,11 +269,17 @@ MIT License. See [LICENSE](https://www.google.com/url?sa=E&q=https%3A%2F%2Fgithu
239269

240270
## Contact 👋
241271

242-
- **X/Twitter:** [@justinpbarnett](https://www.google.com/url?sa=E&q=https%3A%2F%2Fx.com%2Fjustinpbarnett)
272+
- **justinpbarnett:** [X/Twitter](https://www.google.com/url?sa=E&q=https%3A%2F%2Fx.com%2Fjustinpbarnett)
273+
- **scriptwonder**: [Email](mailto:[email protected]), [LinkedIn](https://www.linkedin.com/in/shutong-wu-214043172/)
243274

244275

245276
---
246277

247278
## Acknowledgments 🙏
248279

249280
Thanks to the contributors and the Unity team.
281+
282+
283+
## Star History
284+
285+
[![Star History Chart](https://api.star-history.com/svg?repos=unity-mcp/unity-mcp,justinpbarnett/unity-mcp&type=Date)](https://www.star-history.com/#unity-mcp/unity-mcp&justinpbarnett/unity-mcp&Date)

UnityMcpBridge/Editor/Tools/ManageAsset.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -907,9 +907,9 @@ private static bool ApplyMaterialProperties(Material mat, JObject properties)
907907
);
908908
}
909909
}
910-
} else if (properties["_Color"] is JArray colorArr) //Current Prevention for systems that use _Color instead of color
910+
} else if (properties["color"] is JArray colorArr) //Use color now with examples set in manage_asset.py
911911
{
912-
string propName = "_Color"; // Default main color
912+
string propName = "_Color";
913913
try {
914914
if (colorArr.Count >= 3)
915915
{

0 commit comments

Comments
 (0)