MCP Unreal Server logo

MCP Unreal Server

by radial-hks

A server implementation for interacting with Unreal Engine instances through remote Python execution. It enables management, remote code execution, and monitoring of Unreal Engine environments.

View on GitHub

Last updated: N/A

What is MCP Unreal Server?

MCP Unreal Server is a server application that allows you to control and interact with Unreal Engine instances remotely using Python. It provides features for discovering, managing, and executing code within Unreal Engine environments.

How to use MCP Unreal Server?

To use the server, first clone the repository and install the dependencies using pip install -r requirements.txt. Configure the network and logging settings in server.py. Start the server using python -m src.mcp_server_unreal.server. You can then connect to Unreal instances and execute Python code remotely using the provided API.

Key features of MCP Unreal Server

  • Automatic discovery of Unreal nodes via multicast

  • Real-time node status monitoring

  • Remote Python code execution in Unreal Engine environments

  • Support for attended and unattended execution modes

Use cases of MCP Unreal Server

  • Automated testing of Unreal Engine projects

  • Remote control and management of Unreal Engine instances

  • Real-time data processing and visualization within Unreal Engine

  • Scripting and automation of tasks in Unreal Engine

FAQ from MCP Unreal Server

No nodes discovered?

Verify Unreal instances are running with the MCP plugin.

Execution timeout?

Check firewall settings for multicast traffic.

Connection drops?

Monitor mcp_unreal.log for node status changes.

How do I configure the multicast group?

Modify the multicast_group_endpoint in the RemoteExecutionConfig within server.py.

How do I adjust the logging verbosity?

Modify the log levels for file_handler and console_handler in server.py.