Unitymcpintegration

🚀 Unity MCP Integration

This Unity MCP integration enables AI assistants to interact with the Unity Editor via the MCP protocol. It offers a comprehensive set of tools that allow AI assistants to perform code operations, manage the file system, and monitor the status of Unity projects.

✨ Features

🛠️ Unity Editor Tools

• get_editor_state: Retrieve detailed information about the Unity project and editor state.
• get_current_scene_info: Obtain detailed information about the current scene.
• get_game_objects_info: Get information about specific game objects.
• execute_editor_command: Execute C# code directly in the Unity Editor.
• get_logs: Retrieve and filter Unity console logs.
• verify_connection: Check if there is a valid connection to the Unity Editor.

📁 File System Tools

• read_file: Read the content of a file in the project.
• read_multiple_files: Read multiple files at once.
• write_file: Create or overwrite a specified file.
• edit_file: Make targeted edits to an existing file with a preview feature.
• list_directory: Get a list of files and folders in a directory.
• directory_tree: Obtain a hierarchical view of a directory.
• search_files: Find files that match a specific pattern.
• get_file_info: Get the metadata of a specific file or directory.
• find_assets_by_type: Find all assets of a certain type (e.g., Material, Prefab).
• list_scripts: Get a list of all C# scripts in the project.

File paths can be either absolute paths or relative paths relative to the Unity project's Assets folder. For example, "Scenes/MyScene.unity" actually points to <project>/Assets/Scenes/MyScene.unity.

🏷️ Environment Requirements

• Unity Editor: Version 2018.4 or higher is supported.
• Node.js: Version 16.0 or higher.

📦 Installation

Install via npm

npm install @quaza/unitymcpintegration

🛠️ Installation for Development Environment

Unity Plugin

1. Open the project in Unity.
2. Modify the C# scripts in the UnityMCPConnection/Editor directory.

MCP Server

1. Navigate to the mcpServer directory.
2. Install dependencies: npm install.
3. Compile the server: npm run build.
4. Run the server: node build/index.js.

🚀 Quick Start

Initialize the MCP Service

Run the following command in the project root directory:

npx @quaza/unitymcpintegration init

This will create the necessary configuration files and directory structure.

Start the MCP Server

Run the following command to start the MCP service:

npm run start

💻 Usage Examples

📈 Debugging and Monitoring

Open the MCP Debug window in Unity to monitor the connection status and test features:

1. Go to Window > MCP Debug.
2. In the debug window:
   • Check the connection status.
   • Test code execution.
   • View logs.
   • Monitor events.

🎯 Available Tools

Unity Editor Tools

• get_editor_state: Retrieve detailed information about the Unity project and editor state.
• get_current_scene_info: Obtain detailed information about the current scene.
• get_game_objects_info: Get information about specific game objects.
• execute_editor_command: Execute C# code directly in the Unity Editor.
• get_logs: Retrieve and filter Unity console logs.
• verify_connection: Check if there is a valid connection to the Unity Editor.

File System Tools

• read_file: Read the content of a file in the project.
• read_multiple_files: Read multiple files at once.
• write_file: Create or overwrite a specified file.
• edit_file: Make targeted edits to an existing file with a preview feature.
• list_directory: Get a list of files and folders in a directory.
• directory_tree: Obtain a hierarchical view of a directory.
• search_files: Find files that match a specific pattern.
• get_file_info: Get the metadata of a specific file or directory.
• find_assets_by_type: Find all assets of a certain type (e.g., Material, Prefab).
• list_scripts: Get a list of all C# scripts in the project.

Basic Usage

using MCPIntegration;

public class MCPExample : MonoBehaviour {
    void Start() {
        // Initialize the MCP client
        MCPClient.Initialize("localhost", 3000);
        
        // Get the editor state
        EditorState state = MCPClient.GetEditorState();
        Debug.Log($"Editor Version: {state.Version}");
    }
}

Advanced Usage

const mcpServer = require('@quaza/unitymcpintegration');

// Initialize the server
mcpServer.initialize('localhost', 3000);

// Listen for file change events
mcpServer.on('fileChanged', (event) => {
    console.log(`File changed: ${event.path}`);
});

📄 License

This library is licensed under the MIT License. Please refer to the LICENSE file for details.

🔗 Links

• GitHub Repository: https://github.com/quaza/unitymcpintegration
• Documentation Website: https://docs.quaza.com/unity-mcp-integration

With the Unity MCP integration, you can seamlessly integrate AI capabilities into your game development workflow, enhancing development efficiency and expanding possibilities.