UERunner 是一个用于构建和运行 Unreal Engine 工程的 Windows 版 Visual Studio Code 扩展。
系统要求
- Windows
- Unreal Engine 4 或 Unreal Engine 5
.uproject中包含有效的EngineAssociation- 暂不支持通过 Remote SSH、WSL 或 Dev Container 构建远程工程
功能
编辑器标题栏中提供四个按钮,位于“向右拆分编辑器”按钮左侧:
- 重新选择工程:选择新的
.uproject文件,仅更新当前工程,不触发构建或运行。 - 构建:调用引擎的
Engine/Build/BatchFiles/Build.bat,在 VS Code 任务终端中显示彩色日志。 - 构建并运行:构建成功后自动启动 UE5 的
UnrealEditor.exe或 UE4 的UE4Editor.exe。 - 运行:自动识别 UE4/UE5 编辑器程序并打开工程。
构建日志
UERunner 会保留构建工具的原始输出,并逐行自动识别 UTF-8 与 Windows 本地代码页,确保 UBT、MSVC 和 Link.exe 的中文日志正确显示;同时按语义染色:错误为红色、警告为黄色、成功为绿色、编译进度为青色、构建阶段为蓝色。MSVC 和 UnrealHeaderTool 的源码诊断还会同步到 VS Code“问题”面板,可点击跳转到对应文件和行号。终止任务时会通过 Windows 进程树终止机制结束 Unreal Build Tool 及其编译器子进程。
使用
- 在 VS Code 中打开一个工作区。
- 首次点击任一 UERunner 按钮,选择目标
.uproject文件。 - UERunner 将所选文件保存在 VS Code 内部工作区状态中,并以其所在目录作为工程根目录;同一目录可以存在多个
.uproject。 - UERunner 读取所选
.uproject的EngineAssociation,自动查找对应引擎。
也可以通过命令面板执行:
UERunner: 重新选择 .uproject 工程文件UERunner: 选择构建配置
配置
| 设置 | 默认值 | 说明 |
|---|---|---|
uerunner.buildTarget |
空 | 留空时使用 ${工程名}Editor。 |
uerunner.buildPlatform |
Win64 |
Unreal Build Tool 目标平台。 |
uerunner.buildConfiguration |
Development |
可在设置界面通过下拉框选择。 |
引擎查找顺序:
HKCU\SOFTWARE\Epic Games\Unreal Engine\Builds中与EngineAssociation同名的源码引擎注册项。- Epic Games Launcher 的
LauncherInstalled.dat。 - Epic 安装版引擎注册项。
Program Files\Epic Games\UE_<版本>默认安装位置。
开发
npm install
npm run compile
按 F5 启动扩展开发宿主进行调试。