-
Notifications
You must be signed in to change notification settings - Fork 578
Publish to Docker Hub #468
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
2d51e5f
Add GitHub Actions workflow for Docker Hub publishing
msanatan 0e7a64c
Remove TestPyPI publishing from PyPI workflow
msanatan 771d367
Update Server/DOCKER_OVERVIEW.md
msanatan 1ddd55a
Update .github/workflows/publish-docker.yml
msanatan 13c9bd7
Align docker and pypi publishing so they update on new tags in the sa…
msanatan fb029ed
Add caching to speed up pushes
msanatan 364b584
Remove unnecessary permissions
msanatan f119c93
Let's be super specific about the platform
msanatan File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| name: Publish Docker image 🐳 | ||
|
|
||
| on: | ||
| push: | ||
| tags: | ||
| - "*" | ||
| workflow_dispatch: | ||
| jobs: | ||
| push_to_registry: | ||
| name: Push Docker image to Docker Hub | ||
| runs-on: ubuntu-latest | ||
|
|
||
| steps: | ||
| - name: Check out the repo | ||
| uses: actions/checkout@v6 | ||
|
|
||
| - name: Log in to Docker Hub | ||
| uses: docker/login-action@v3 | ||
| with: | ||
| username: ${{ secrets.DOCKER_USERNAME }} | ||
| password: ${{ secrets.DOCKER_PASSWORD }} | ||
|
|
||
| - name: Extract metadata (tags, labels) for Docker | ||
| id: meta | ||
| uses: docker/metadata-action@v5 | ||
| with: | ||
| images: ${{ secrets.DOCKER_USERNAME }}/mcp-for-unity-server | ||
| tags: | | ||
| type=semver,pattern={{version}} | ||
| type=semver,pattern={{major}}.{{minor}} | ||
| type=ref,event=branch | ||
| type=sha | ||
|
|
||
| - name: Set up Docker Buildx | ||
| uses: docker/setup-buildx-action@v3 | ||
|
|
||
| - name: Build and push Docker image | ||
| uses: docker/build-push-action@v6 | ||
| with: | ||
| context: . | ||
| file: Server/Dockerfile | ||
| platforms: linux/amd64 | ||
| push: true | ||
| tags: ${{ steps.meta.outputs.tags }} | ||
| labels: ${{ steps.meta.outputs.labels }} | ||
| cache-from: type=gha | ||
| cache-to: type=gha,mode=max |
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,88 @@ | ||
| # MCP for Unity Server (Docker Image) | ||
|
|
||
| [](https://modelcontextprotocol.io/introduction) | ||
| [](https://opensource.org/licenses/MIT) | ||
| [](https://discord.gg/y4p8KfzrN4) | ||
|
|
||
| Model Context Protocol server for Unity Editor integration. Control Unity through natural language using AI assistants like Claude, Cursor, and more. | ||
|
|
||
| **Maintained by [Coplay](https://www.coplay.dev/?ref=unity-mcp)** - This project is not affiliated with Unity Technologies. | ||
|
|
||
| 💬 **Join our community:** [Discord Server](https://discord.gg/y4p8KfzrN4) | ||
|
|
||
| **Required:** Install the [Unity MCP Plugin](https://github.com/CoplayDev/unity-mcp?tab=readme-ov-file#-step-1-install-the-unity-package) to connect Unity Editor with this MCP server. | ||
|
|
||
| --- | ||
|
|
||
| ## Quick Start | ||
|
|
||
| ### 1. Pull the image | ||
|
|
||
| ```bash | ||
| docker pull msanatan/mcp-for-unity-server:latest | ||
| ``` | ||
|
|
||
| ### 2. Run the server | ||
|
|
||
| ```bash | ||
| docker run -p 8080:8080 msanatan/mcp-for-unity-server:latest | ||
| ``` | ||
|
|
||
| This starts the MCP server on port 8080. | ||
|
|
||
| ### 3. Configure your MCP Client | ||
|
|
||
| Add the following configuration to your MCP client (e.g., Claude Desktop config, Cursor settings): | ||
|
|
||
| ```json | ||
| { | ||
| "mcpServers": { | ||
| "UnityMCP": { | ||
| "url": "http://localhost:8080/mcp" | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| --- | ||
|
|
||
| ## Configuration | ||
|
|
||
| The server connects to the Unity Editor automatically when both are running. No additional configuration is needed. | ||
|
|
||
| **Environment Variables:** | ||
|
|
||
| - `DISABLE_TELEMETRY=true` - Opt out of anonymous usage analytics | ||
| - `LOG_LEVEL=DEBUG` - Enable detailed logging (default: INFO) | ||
|
|
||
| Example running with environment variables: | ||
|
|
||
| ```bash | ||
| docker run -p 8080:8080 -e LOG_LEVEL=DEBUG msanatan/mcp-for-unity-server:latest | ||
| ``` | ||
|
|
||
| --- | ||
|
|
||
| ## Example Prompts | ||
|
|
||
| Once connected, try these commands in your AI assistant: | ||
|
|
||
| - "Create a 3D player controller with WASD movement" | ||
| - "Add a rotating cube to the scene with a red material" | ||
| - "Create a simple platformer level with obstacles" | ||
| - "Generate a shader that creates a holographic effect" | ||
| - "List all GameObjects in the current scene" | ||
|
|
||
| --- | ||
|
|
||
| ## Documentation | ||
|
|
||
| For complete documentation, troubleshooting, and advanced usage, please visit the GitHub repository: | ||
|
|
||
| 📖 **[Full Documentation](https://github.com/CoplayDev/unity-mcp#readme)** | ||
|
|
||
| --- | ||
|
|
||
| ## License | ||
|
|
||
| MIT License - See [LICENSE](https://github.com/CoplayDev/unity-mcp/blob/main/LICENSE) | ||
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.
Uh oh!
There was an error while loading. Please reload this page.