From b13661c8fba91f50bf4869acc29aed384eebccaa Mon Sep 17 00:00:00 2001 From: Shutong Wu <51266340+Scriptwonder@users.noreply.github.com> Date: Mon, 14 Jul 2025 02:01:25 -0400 Subject: [PATCH] Update README.md --- README.md | 62 ++++++++++++++++++++++++++++++++----------------------- 1 file changed, 36 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index 09168c8..60439a5 100644 --- a/README.md +++ b/README.md @@ -25,8 +25,8 @@ Unity MCP acts as a bridge, allowing AI assistants (like Claude, Cursor) to inte * **🤖 Automation:** Automate repetitive Unity workflows. * **🧩 Extensible:** Designed to work with various MCP Clients. -
- Expand for Available Tools... +
+ Available Tools Your LLM can use functions like: @@ -184,30 +184,40 @@ If Auto-Configure fails or you use a different client: 3. **Interact!** Unity tools should now be available in your MCP Client. - Example Prompt: `Create a 3D player controller.` + Example Prompt: `Create a 3D player controller`, `Create a yellow and bridge sun`, `Create a cool shader and apply it on a cube`. --- -## TODOs (Besides PR) 📝 -### High Priority -- [ ] **AssetsGeneration Improvements** - Better server request handling -- [ ] **CodeGeneration Improvements** - Better generated code handling -- [ ] **Error Handling Improvements** - Better error messages and recovery mechanisms -- [ ] **Remote Connection** - Enable remote connection between host and server -- [ ] **Documentation Expansion** - Add tutorials on how to add your own tools, and documentation on existing tools and functions +## Future Dev Plans (Besides PR) 📝 -### Medium Priority -- [ ] **Custom Tool Creation** - GUI for users to create their own MCP tools -- [ ] **Logging System** - Comprehensive logging for debugging and monitoring +### 🔴 High Priority +- [ ] **Asset Generation Improvements** - Enhanced server request handling and asset pipeline optimization +- [ ] **Code Generation Enhancements** - Improved generated code quality, validation, and error handling +- [ ] **Robust Error Handling** - Comprehensive error messages, recovery mechanisms, and graceful degradation +- [ ] **Remote Connection Support** - Enable seamless remote connection between Unity host and MCP server +- [ ] **Documentation Expansion** - Complete tutorials for custom tool creation and API reference -### Low Priority -- [ ] **Mobile Platform Support** - Extended tools for mobile development workflows -- [ ] **Easier Setup** +### 🟡 Medium Priority +- [ ] **Custom Tool Creation GUI** - Visual interface for users to create and configure their own MCP tools +- [ ] **Advanced Logging System** - Logging with filtering, export, and debugging capabilities -### Research & Exploration -- [ ] **AI-Powered Asset Generation** - Integration with AI tools for automatic asset creation -- [ ] **Real-time Collaboration** - Live editing sessions between multiple developers (Currently ongoing) -- [ ] **Analytics Dashboard** - Usage analytics and project insights +### 🟢 Low Priority +- [ ] **Mobile Platform Support** - Extended toolset for mobile development workflows and platform-specific features +- [ ] **Easier Tool Setup** +- [ ] **Plugin Marketplace** - Community-driven tool sharing and distribution platform + +
+ ✅ Completed Features + + - [x] **Shader Generation** - Generate shaders using CGProgram template +
+ +### 🔬 Research & Exploration +- [ ] **AI-Powered Asset Generation** - Integration with AI tools for automatic 3D models, textures, and animations +- [ ] **Real-time Collaboration** - Live editing sessions between multiple developers *(Currently in progress)* +- [ ] **Analytics Dashboard** - Usage analytics, project insights, and performance metrics +- [ ] **Voice Commands** - Voice-controlled Unity operations for accessibility +- [ ] **AR/VR Tool Integration** - Extended support for immersive development workflows --- @@ -264,18 +274,18 @@ Still stuck? [Open an Issue](https://www.google.com/url?sa=E&q=https%3A%2F%2Fgit --- -## License 📜 - -MIT License. See [LICENSE](https://www.google.com/url?sa=E&q=https%3A%2F%2Fgithub.com%2Fjustinpbarnett%2Funity-mcp%2Fblob%2Fmaster%2FLICENSE) file. - ---- - ## Contact 👋 - **justinpbarnett:** [X/Twitter](https://www.google.com/url?sa=E&q=https%3A%2F%2Fx.com%2Fjustinpbarnett) - **scriptwonder**: [Email](mailto:swu85@ur.rochester.edu), [LinkedIn](https://www.linkedin.com/in/shutong-wu-214043172/) +--- + +## License 📜 + +MIT License. See [LICENSE](https://www.google.com/url?sa=E&q=https%3A%2F%2Fgithub.com%2Fjustinpbarnett%2Funity-mcp%2Fblob%2Fmaster%2FLICENSE) file. + --- ## Acknowledgments 🙏