项目简介

VibeUE (Vibe Unreal Engine) 是一个强大的Model Context Protocol (MCP) 服务器，它将虚幻引擎5.6+与AI助手客户端（如VS Code、Cursor、Claude Desktop等）连接起来。通过VibeUE，AI助手可以使用自然语言理解和操作虚幻引擎中的蓝图、UMG用户界面和项目资产，实现自动化开发、快速原型设计和智能工作流。

主要功能点

资产管理与发现:
- 通用资产搜索: 全局搜索任意资产类型（如UI控件、纹理、蓝图、材质），支持智能过滤。
- 资产编辑器启动器: 直接在对应的编辑器中打开任何资产。
- 纹理导入/导出: 支持本地文件导入（含格式验证）和AI兼容的导出，用于视觉分析。
蓝图开发套件:
- 蓝图创建与管理: 创建、编译、重定向蓝图类。
- 组件系统: 添加和配置网格、摄像机、光源、物理和其他自定义组件。
- 节点图操纵: 创建事件节点、函数调用、变量，并连接节点。
- 属性管理: 设置蓝图属性、物理设置和组件配置。
完整的UMG UI系统:
- UI蓝图创建: 创建和管理UMG UI蓝图，支持完整的层级结构。
- 组件库: 提供20多种UI控件类型，包括文本、按钮、图片、滑块、进度条、列表等。
- 布局面板: 支持画布、叠加、水平/垂直盒、滚动盒和网格面板等布局方式。
- 高级样式: 全面的属性系统，控制颜色、字体、定位和变换。
- 数据绑定与事件: 支持MVVM模式、事件绑定和动态内容管理。
发现与分析工具:
- 组件内省: 详细分析UI控件层级和属性。
- 事件图分析: 列出节点、函数、自定义事件，并提供完整的图表摘要。
- 属性发现: 探索任何组件的可用属性和当前值。
- 验证工具: 检查UI控件层级和组件关系。
样式与视觉增强:
- 颜色管理: 支持完整的RGBA颜色控制，用于文本、背景和UI元素。
- 字体控制: 提供字体大小、样式和字体的排版设置。
- 变换系统: 控制位置、大小、缩放、旋转、锚点和对齐。
- 可见性控制: 多种可见性状态和Z轴顺序管理。
- 图片集成: 应用纹理，支持着色和缩放选项。
集成与连接性:
- 智能工作流: 工具设计为协同工作，支持“搜索 → 检查 → 修改 → 验证”的流程。
- 错误预防: 内置验证和精确名称匹配，防止常见错误。
- 性能优化: 快速直接的资产访问，避免耗时的注册表搜索。
- AI指导: 提供全面的样式指南和最佳实践建议。

安装步骤

先决条件:
- 虚幻引擎 5.6+
- Python 3.12+
- Git
- MCP客户端 (例如，VS Code安装"Model Context Protocol"扩展，或使用Claude Desktop/Cursor/Windsurf)

克隆仓库: 将VibeUE仓库克隆到你的虚幻引擎项目 'Plugins' 文件夹内。

cd /path/to/your/unreal/project/Plugins
git clone https://github.com/kevinpbuckley/VibeUE.git

例如 (Windows):

cd C:\MyProject\Plugins
git clone https://github.com/kevinpbuckley/VibeUE.git

这将在 'YourProject/Plugins/VibeUE/' 目录下创建插件结构。

在虚幻引擎中启用插件:
- 打开你的虚幻引擎项目。
- 进入 'Edit > Plugins' 菜单。
- 在 'Editor' 类别中找到 "VibeUE" 并勾选启用。
- 按提示重启编辑器，插件将在重启时自动编译。

服务器配置 (MCP客户端使用)

VibeUE MCP服务器由Python脚本 'vibe_ue_server.py' 启动，并与虚幻引擎C++插件进行通信。MCP客户端需要配置此Python脚本的启动命令和参数来连接到VibeUE MCP服务器。

VS Code (推荐): 在你的项目根目录下创建或更新 '.vscode/mcp.json' 文件：

{
  "servers": {
    "VibeUE": {
      "type": "stdio",
      "command": "python",
      "args": ["Plugins\\VibeUE\\Python\\vibe-ue-main\\Python\\vibe_ue_server.py"],
      "env": {},
      "cwd": "${workspaceFolder}"
    }
  },
  "inputs": []
}

说明：
- 'servers.VibeUE.type': 指定MCP客户端与服务器之间的通信传输协议为标准输入输出（stdio）。
- 'servers.VibeUE.command': 启动MCP服务器所使用的命令行程序，这里是'python'解释器。
- 'servers.VibeUE.args': 传递给'python'命令的参数，即MCP服务器的核心Python脚本 'vibe_ue_server.py' 的相对路径。请确保此路径与你克隆仓库后的实际位置相符。
- 'servers.VibeUE.cwd': 服务器的工作目录，'${workspaceFolder}' 是VS Code内置变量，表示当前打开的工作区根目录。

其他MCP客户端 (如Claude Desktop, Cursor, Windsurf): 根据你使用的MCP客户端，在相应的配置文件中（例如Claude Desktop的'~/.config/claude-desktop/mcp.json'，或Cursor项目根目录下的'.cursor/mcp.json'）添加以下配置：
```
{
  "mcpServers": {
    "VibeUE": {
      "command": "python",
      "args": ["Plugins\\VibeUE\\Python\\vibe-ue-main\\Python\\vibe_ue_server.py"],
      "cwd": "<path/to/your/unreal/project>"
    }
  }
}
```
- 说明：
  - 'mcpServers.VibeUE.command': 启动MCP服务器所使用的命令行程序，这里是'python'解释器。
  - 'mcpServers.VibeUE.args': 传递给'python'命令的参数，即MCP服务器的核心Python脚本 'vibe_ue_server.py' 的相对路径。请确保此路径与你克隆仓库后的实际位置相符。
  - 'mcpServers.VibeUE.cwd': 服务器的工作目录，'<path/to/your/unreal/project>' 需要替换为你的虚幻引擎项目根目录的绝对路径。

基本使用方法

确保虚幻引擎项目已打开，且VibeUE插件已启用并编译成功。
打开配置好的MCP客户端（例如VS Code，它将根据配置自动启动VibeUE MCP服务器）。
在你的AI助手中，尝试使用自然语言提问，例如："Search for widgets in my project" (搜索项目中的UI控件)。
如果AI助手能够成功返回UI控件信息，则表示VibeUE已成功安装并运行。
为了获得更全面的工具使用指南、最佳实践和AI集成提示，请在AI助手中调用以下工具：
- 'info()': 获取所有可用VibeUE工具的详细参考。
- 'get_umg_guide()': 获取UMG UI样式设计、背景实现和层级管理的综合指南。
- 'server_status()': 检查当前MCP服务器的运行状态和与虚幻引擎的连接情况。

关键词

项目简介

主要功能点

安装步骤

服务器配置 (MCP客户端使用)

基本使用方法

信息