py-ue5-mcp-server

🚀 Py-UNREAL-MCP-Server

Py-UNREAL-MCP-Server 是一个用于与虚幻引擎（Unreal Engine）进行交互的 Python 服务。它借助远程控制 API（Remote Control API）协议，可实现对 Unreal Engine 场景中演员（Actor）的创建、修改和删除操作，为开发者提供便利。

🚀 快速开始

安装指南

1. 下载最新版本的 Py-UNREAL-MCP-Server.zip 文件。
2. 将下载的文件解压到任意位置。
3. 确保安装以下 Python 包：
   • python-dotenv
   • loguru

运行指南

在终端中运行以下命令启动服务器：

python main.py [--port PORT] [--host HOST]

参数说明

• --port：指定服务器监听的端口，默认为 8000。
• --host：指定服务器绑定的主机地址，默认为 localhost。

✨ 主要特性

演员创建

• 基本演员创建：在当前层级中创建一个指定类别的演员。
• 演员复制：通过 Blueprint 函数对现有演员进行复制。
• 家庭模式创建：一次性生成一组排列整齐的“雪人一家”。

演员修改

• 支持对任意属性进行调整，包括位置、旋转角度和缩放比例。
• 允许重命名演员或选择性地仅更新特定属性。

📦 安装指南

1. 下载最新版本的 Py-UNREAL-MCP-Server.zip 文件。
2. 解压下载的文件到任意位置。
3. 确保安装以下 Python 包：
   • python-dotenv
   • loguru

💻 使用示例

基础用法

在终端中运行以下命令启动服务器：

python main.py

高级用法

指定端口和主机启动服务器：

python main.py --port 8080 --host 127.0.0.1

📚 详细文档

日志记录与调试

服务运行期间会生成详细日志，便于排查问题：

2023-11-15 14:32:45,123 - Unreal-MCP-Server - INFO - Unreal Engine MCP服务器启动中...
2023-11-15 14:32:45,125 - Unreal-MCP-Server - INFO - 默认度量单位：厘米（1 Unreal Unit = 1 cm）
2023-11-15 14:32:45,234 - Unreal-MCP-Server - INFO - 已连接到Unreal Engine远程控制API

故障排除

连接问题

• 确保 Unreal Engine 正在运行，并且远程控制功能已启用。
• 检查防火墙设置，确保端口 30010（默认端口）未被阻挡。

命令执行问题

• 从简单的命令开始测试基础功能。
• 检查请求语法是否正确。

未来发展

计划在后续版本中增加以下特性：

• 支持通过 WebSocket 协议进行实时场景监控和操作。
• 提供图形化界面以便更直观地管理演员属性。