Unity

🚀 UnityMCP

UnityMCP is a powerful Unity editor plugin that implements the Model Context Protocol (MCP), enabling seamless integration between Unity and AI assistants. It offers real-time editor status monitoring, remote command execution, and comprehensive logging capabilities.

🚀 Quick Start

UnityMCP is a potent Unity editor plugin implementing the Model Context Protocol (MCP), facilitating seamless integration between Unity and AI assistants. It provides real - time editor status monitoring, remote command execution, and comprehensive logging features.

✨ Features

• Core Functionality: Enables bidirectional real - time communication via WebSocket, supporting message transmission in JSON format.
• Use Cases: Ideal for scenarios requiring real - time interaction, such as game development, real - time collaboration tools, or other applications that need dynamic data exchange.
• Target Users: Developers, designers, and researchers.

📦 Installation

1. Install via Smithery

# Example code: Install via Smithery

2. Manual Installation

• Plugin Installation:
  • Place the UnityMCP folder into your Unity project.
  • Import this folder in Unity to complete the plugin installation.
• Server Configuration:
  • Ensure Node.js and npm are installed.
  • Run the following command in the project directory:

    npm install
    

💻 Usage Examples

Start the Server

node server.js

Connect the Plugin

1. Open the Unity editor.
2. Add the MCPManager.cs script to the Assets/Editor folder.
3. Attach the script to an empty object.
4. Configure the WebSocket server address (default is ws://localhost:8080).

📚 Documentation

Compile and Build

npm run build

Monitor Code Changes

npm run watch

Debug Communication

npm run inspector

🔧 Technical Details

Communication Protocol

• Transmission Method: Real - time bidirectional communication based on WebSocket.
• Port Number: Default port is 8080.
• Message Format: All communications use JSON format.

Security Mechanisms

• Command Timeout Protection: Prevents the execution of commands with long - term non - responses.
• Error Handling: Comprehensive handling of connection exceptions, command failures, compilation errors, and runtime exceptions.
• Log Management: Provides reliable logging and buffering functions.
• Status Monitoring: Tracks connection status in real - time to ensure system stability.

Error Handling

The system provides a comprehensive handling mechanism for the following situations:

• Connection interruption
• Command execution failure
• Compilation errors
• Runtime exceptions
• Timeout issues

🤝 Contributing

1. Code Repository: Visit the GitHub repository.
2. Contribution Method:
   • Fork the repository to your account.
   • Create a feature branch (e.g., feature/amazing - feature).
   • Commit your changes and add commit descriptions.
   • Push to the remote repository.
   • Submit a Pull Request.

📄 License

This project is licensed under the [Creative Commons Attribution - NonCommercial 4.0 International (CC BY - NC 4.0)](https://creativecommons.org/licenses/by - nc/4.0/) license.