feat: add remote host configuration support for Unity WebSocket connection #59
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ction Add configurable host property to McpUnity class with support for UNITY_HOST environment variable and Host configuration in Unity's McpUnitySettings.json. Maintains full backward compatibility with original Unity workflow while enabling remote Unity Editor connections across network.
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the ✨ Finishing Touches🧪 Generate Unit Tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
CoderGamester
requested changes
Jun 28, 2025
added 2 commits
June 28, 2025 09:31
- Add AllowRemoteConnections setting to McpUnitySettings - Update WebSocket server to bind to 0.0.0.0 when remote connections enabled - Add UI checkbox in Unity Editor window for remote connection toggle - Server automatically restarts when binding setting changes - Defaults to localhost-only connections for security
Add documentation for UNITY_HOST environment variable and Unity Editor remote connection settings to all language READMEs.
|
Thanks for review. Docs updated. We also added a checkbox for remote connections in the editor since the WebSocket server was set to listen on localhost only. The checkbox toggles between localhost (default) and 0.0.0.0 in order to allow remote connections.
Tooltip: |
CoderGamester
approved these changes
Jun 29, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Looking at the existing description, I can see it contains substantial content with clear sections including Summary, Changes, Usage Example, and Testing. This is not empty or a template, so I need to enhance it with additional analysis while preserving the existing structure.
Summary
Enables remote Unity Editor connections across network. Useful for development setups where Unity runs on different machine.
Changes
UNITY_HOSTenvironment variable as first priorityHostconfiguration in Unity's McpUnitySettings.json as fallbackTechnical Implementation Details
The implementation adds a new
hostproperty to theMcpUnityclass, initialized to'localhost'by default. The configuration resolution follows a clear priority order:UNITY_HOSTenvironment variable (highest priority)Hostfield in configuration file'localhost'(maintains existing behavior)The WebSocket connection URL construction in the
connect()method is updated from the hardcodedws://localhost:${this.port}/McpUnityto use the configurablews://${this.host}:${this.port}/McpUnityformat.Usage Example
Remote Unity setup:
# Unity running on 192.168.1.100, launch MCP bridge on different machine UNITY_HOST=192.168.1.100 node server.jsOr via Unity settings file:
{ "Host": "192.168.1.100", "Port": 8090 }Default behavior (unchanged):
# Still connects to localhost:8090 if no host specified node server.jsTesting
Tested with Unity Editor on Windows PC and MCP bridge on remote Ubuntu server. Verified GameObject creation, selection, etc work remotely.
Changes that Break Backward Compatibility
N/A - The implementation maintains full backward compatibility by defaulting to
'localhost'when no host configuration is provided.Documentation
N/A - No documentation files were modified in this PR, though the usage examples in the description provide clear guidance for the new functionality.
Created with Palmier