Unity Editor

🚀 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 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.

✨ Features

The project consists of two main components:

1. Unity Plugin (UnityMCPPlugin)

A Unity editor plugin with the following features:

• Real-time Status Updates: Monitors the editor's status via WebSocket.
• Command Execution: Receives and executes commands from the MCP server.
• Logging: Collects and manages editor log information.

2. MCP Server

An independent server component responsible for:

• Handling requests from the Unity plugin.
• Executing a preset set of commands.
• Providing a REST API for easy integration into other toolchains.

📦 Installation

1. Install via npm:

npm install unitymcp

2. Run the server after installation:

npx unitymcp start

3. Import the plugin into the Unity editor
   • Add the plugin folder to the editor's Assets/ directory.
   • Enable the MCP plugin in Unity.

💻 Usage Examples

Basic Usage

1. Start the MCP server:

npx unitymcp start --port=8080

2. Initialize the plugin in a Unity script:

using UnityMCP;

public class MCPInitializer : MonoBehaviour {
    void Start() {
        MCPManager.Instance.Connect("ws://localhost:8080");
    }
}

Advanced Usage

• Subscribe to events: Subscribe to server events via MCPManager.

MCPManager.Instance.OnCommand += HandleCommand;

• Custom commands:
  • Register a custom command handler:

  [MCPCommand("customcommand")]
  public class CustomCommandHandler {
      public static void Execute(string[] args) {
          // Handle the custom command
      }
  }
  

📚 Documentation

Creating New Commands

1. Create a new C# class:

   [MCPCommand("newcommand")]
   public class NewCommandHandler {
       public static void Execute(string[] args) {
           // Implement the logic
       }
   }
   

2. Register the command handler:

   MCPManager.Register(typeof(NewCommandHandler));
   

Extending Plugin Functionality

1. Add new functional modules:

   • Create a new folder Assets/Plugins/Extensions.
   • Add custom scripts or assets to it.

2. Write an extension program:

   public class ExtensionExample : MonoBehaviour {
       void Update() {
           if (MCPManager.IsConnected) {
               MCPManager.Instance.SendHeartbeat();
           }
       }
   }
   

🔧 Technical Details

Communication Protocol

• Uses the WebSocket protocol on port 8080.
• Supports bidirectional real-time updates.
• All communication is based on the JSON format.

Security Features

• Command execution timeout protection.
• Error handling and validation mechanisms.
• Log buffer management.
• Connection status monitoring.

🐞 Troubleshooting

1. Connection issues

   • Ensure the server is running and the WebSocket port is open.
   • Check the network configuration to avoid firewall blocking the port.

2. Commands not executed

   • Confirm that the command is correctly registered and handled.
   • Check the logs for more debugging information.

🤝 Contribution Guidelines

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

📄 License

This project is licensed under the MIT License.