Skip to content

Commit 6665eac

Browse files
committed
Readme update with badges and more
1 parent e5793a6 commit 6665eac

File tree

1 file changed

+19
-6
lines changed

1 file changed

+19
-6
lines changed

README.md

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,17 @@
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

@@ -47,8 +58,6 @@ Unity MCP connects your tools using two components:
4758
4859
### Prerequisites
4960

50-
<details>
51-
<summary><strong>Click to view required software...</strong></summary>
5261

5362
* **Git CLI:** For cloning the server code. [Download Git](https://git-scm.com/downloads)
5463
* **Python:** Version 3.12 or newer. [Download Python](https://www.python.org/downloads/)
@@ -63,7 +72,6 @@ Unity MCP connects your tools using two components:
6372
* [Cursor](https://www.cursor.com/en/downloads)
6473
* [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

@@ -183,7 +191,7 @@ If Auto-Configure fails or you use a different client:
183191
- [ ] **CodeGeneration Improvements** - Better generated code handling
184192
- [ ] **Error Handling Improvements** - Better error messages and recovery mechanisms
185193
- [ ] **Remote Connection** - Enable remote connection between host and server
186-
- [ ] **Documentation Expansion** - Add tutorials on how to add your own tools
194+
- [ ] **Documentation Expansion** - Add tutorials on how to add your own tools, and documentation on existing tools and functions
187195

188196
### Medium Priority
189197
- [ ] **Custom Tool Creation** - GUI for users to create their own MCP tools
@@ -249,7 +257,7 @@ Help make Unity MCP better!
249257

250258
</details>
251259

252-
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)!
253261

254262
---
255263

@@ -270,3 +278,8 @@ MIT License. See [LICENSE](https://www.google.com/url?sa=E&q=https%3A%2F%2Fgithu
270278
## Acknowledgments 🙏
271279

272280
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)

0 commit comments

Comments
 (0)