unreal

This MCP server provides the Minecraft Protocol (MCP) interface for the Unreal integration. It is part of the unified Unreal MCP stack and is intended to be run alongside the Unreal engine tooling to allow MCP-compatible clients to connect and interact with the Unreal-based Minecraft-like environment. Once running, you can use the server to manage protocol handshakes, game state synchronization, and plugin-based extensions that communicate with the Unreal runtime. Typical workflows involve starting the server, connecting a Minecraft-compatible client to the configured host/port, and using any provided admin or telemetry tools to monitor connections, player data, and plugin events. For most users, interacting with the server will be through the unified tooling in the repository it belongs to (GenOrca/unreal-mcpython) rather than direct lower-level protocol tweaks.

Prerequisites:

• Docker (recommended) or a compatible container runtime installed on your machine.
• Access to the unified Unreal MCP repository (GenOrca/unreal-mcpython) for the latest server code and configuration.

Option A: Run via Docker

1. Install Docker: follow the official installation guide for your OS.
2. Pull or build the Unreal MCP server image. If using a prebuilt image name, ensure it is available:
   • docker pull unreal-mcp-server-image
   • or build from a Dockerfile provided in the unified repo: docker build -t unreal-mcp-server-image path/to/dockerfile
3. Run the container with appropriate environment variables and port mappings:
   • docker run -i -p 25565:25565 -e UNREAL_MCP_LOG_LEVEL=info -e UNREAL_MCP_CONFIG_PATH=/config/server.yaml unreal-mcp-server-image
4. Verify the server starts and listens on the mapped port. Connect a MCP-compatible client to localhost:25565.

Option B: Other runtimes (if you prefer UV/UVX or node)

• If a non-Docker option is provided by the Unreal MCP repository, follow the specific instructions in GenOrca/unreal-mcpython/mcp-server for uvx/python/node execution, ensuring you install any required dependencies first and set environment variables as documented.

Note: The authoritative server code and configuration for Unreal MCP live in the unified repository. Refer to GenOrca/unreal-mcpython for the exact server entry point, configuration schema, and plugin hooks.

Tips and common questions:

• The Unreal MCP server is now maintained in the unified repository GenOrca/unreal-mcpython. Always check that you are using the latest image or code from that source.
• Environment variables like UNREAL_MCP_LOG_LEVEL and UNREAL_MCP_CONFIG_PATH can help control logging verbosity and where the server reads its configuration from.
• If you encounter connection issues, verify port mappings and that the container has network access. Ensure the MCP client is configured to connect to the correct host/port.
• Configuration files (e.g., server.yaml) define gameplay hooks, plugin permissions, and player telemetry. Keep backups before upgrades.
• When upgrading, re-check compatibility with the Unreal runtime version you are using, as protocol support can vary between versions.
• If you are using Docker, ensure the image is built for the correct platform (Linux x86_64 is the most common).