文档

    Unreal Editor 插件

    面向 Unreal Engine 团队的云端 CI/CD。触发构建、实时查看日志、下载构建产物,并获得 AI 辅助的报错修复——全程不离开编辑器。

    前提条件

    • Unreal Engine 5.7
    • 主机平台: Windows 64 位,或 macOS(Apple Silicon 或 Intel)
    • SpeedrunCI 账户 — 可在 app.speedrun.ci 免费注册
    • 版本控制连接(Git、Perforce 或 Plastic SCM)— 在你的 SpeedrunCI 控制台中配置一次即可
    • 至少一条流水线,需在你的 SpeedrunCI 控制台中配置完成,插件才能触发构建

    插件只是编辑器一侧的触发与监控入口,实际构建运行在 SpeedrunCI 的托管基础设施上。你无需自行搭建或运维任何后端,但需要一个账户。

    安装

    1. 通过 Epic Games Launcher 从 Fab Marketplace 安装插件(库 → 引擎版本 → 已安装插件)。
    2. 打开你的 UE 5.7 项目。若提示重新编译缺失的模块,请点击是。
    3. 打开编辑 → 插件,搜索 “SpeedrunCI”,确认已启用;若有提示,请重启编辑器。

    首次登录

    1. 打开 SpeedrunCI 面板:按 Ctrl+Shift+K(Windows)或 Cmd+Shift+K(Mac)。也可以依次进入工具 → 杂项 → SpeedrunCI。
    2. 引导向导随即出现。点击 Browser Sign-In。
    3. 默认浏览器会打开 app.speedrun.ci/auth/editor-plugin,请在该页面登录。
    4. 浏览器会重定向回本地回调地址,向导随即自动进入 Project Selection 步骤。
    5. 选择你的组织、项目和默认流水线,然后点击 Finish Setup。

    你的编辑器令牌存储在操作系统的安全凭据库中(macOS 钥匙串或 Windows 凭据管理器)——在受支持的平台上,绝不会以明文形式写入磁盘。

    macOS 提示: 登录期间,编辑器会在 19847–19857 端口范围内短暂启动一个本地回调服务器。macOS 可能会询问是否允许传入的网络连接——请点击允许。登录完成后,该服务器会立即关闭。

    你可以做什么

    • 触发构建,可点击 Play 旁边的工具栏按钮,也可在面板中操作。会在当前分支上运行你团队的默认流水线。
    • 实时查看日志流,支持按严重级别高亮显示(错误、警告),以及可点击的 file:line 引用。
    • AI 推荐 — 构建失败时,可查看 AI 生成的原因分析和修复建议。审阅改动后一键应用到本地。
    • 下载构建产物,以 8 个并行分块快速取回 Cook 后的 PAK、IPA、APK、Xbox .xvc、PS5 .pkg 等。
    • 预检会在触发构建前标记出未保存的资产、未提交的更改和蓝图编译错误。
    • 构建连胜和轻量的游戏化机制,帮你把 CI 维持在绿色状态。
    • 本地着色器编译加速(仅限 Windows)会在你编辑时,将 ShaderCompileWorker 和 UnrealLightmass 进程提升到高于正常的优先级,让着色器 Cook 和光照构建更快完成。

    配置

    打开编辑 → 项目设置,然后在左侧导航的插件下选择 SpeedrunCI:

    • API 基础 URL(默认为 https://app.speedrun.ci;仅在自托管部署时才需要修改)
    • 默认组织、项目和流水线
    • 构建产物下载路径
    • 声音、构建连胜、着色器加速和通知等偏好设置

    可在 SpeedrunCI 控制台的组织设置 → AI 提供方中按组织级别关闭 AI 推荐。

    隐私与安全

    • 编辑器令牌存储在 macOS 钥匙串或 Windows 凭据管理器中——在受支持的平台上,绝不会以明文形式写入磁盘。
    • 所有 API 流量均通过 HTTPS 发往 app.speedrun.ci。
    • 插件不会传输源代码、项目资产或关卡文件。源代码是通过你在 SpeedrunCI 控制台中单独配置的版本控制连接抵达构建基础设施的。
    • 插件仅在浏览器登录流程期间,于 19847–19857 端口范围内启动一个本地 HTTP 服务器(TCP,仅限回环地址),流程结束后随即关闭。
    • 有关插件发送和存储哪些数据的详情,请参阅完整的隐私政策。

    故障排查

    工具栏按钮不显示

    在编辑 → 插件中确认 SpeedrunCI 已启用,并重启一次编辑器。若插件已启用但按钮仍未出现,请在输出日志中按 “SpeedrunCI” 过滤查看错误。

    浏览器登录后没有跳回编辑器

    多半是操作系统防火墙拦截了本地回调。在 macOS 上,打开系统设置 → 网络 → 防火墙,允许 Unreal Editor 接受传入连接。在 Windows 上,请在 Windows Defender 防火墙中放行 Unreal Editor。

    “AI Recommendations not yet available”(AI 推荐尚不可用)

    该次构建的 AI 摘要尚未生成。AI 摘要是在构建完成后由后端生成的,可在 SpeedrunCI 控制台中打开该构建确认。插件会在下次刷新时自动取回。

    引导流程中提示“No projects found”(未找到项目)

    你的账户尚未加入任何组织,或者还没有创建项目。请访问 app.speedrun.ci 创建一个组织和至少一个项目,然后重新打开插件面板。

    退出登录 / 重新认证

    在插件内的设置面板中点击 Sign Out。此操作会清除钥匙串条目和本地凭据文件。下次点击工具栏按钮时,系统会提示你再次通过浏览器登录。

    其他问题

    打开输出日志并按 SpeedrunCI 过滤——插件的日志记录相当详尽。第一条警告或错误通常就指向根因。若仍无法解决,请将相关日志片段发送至 support@speedrun.ci。

    链接与支持

    © 2026 Navi Interactive Inc. 保留所有权利。