Choose your operating system:
Windows
macOS
Linux
容器快速入门旨在帮助你访问虚幻引擎的官方容器镜像,并运行一个简单容器。本指南将引导你完成如下任务:
-
在计算机上安装Docker。
-
登录GitHub容器注册表(GitHub Container Registry),下载预构建的虚幻引擎容器镜像。
-
下载用于虚幻引擎的预构建Linux开发容器镜像。
使用开发镜像启动容器。
-
在容器内构建并打包项目。
1.要求
如需运行此快速入门中的虚幻引擎容器镜像,你的计算机需满足 硬件和软件要求 一文中Linux容器小节注明的软硬件要求。
2.验证GitHub访问权限
请验证你是否可以访问GitHub上的虚幻引擎源代码仓库: https://github.com/EpicGames/UnrealEngine 。如果无法访问仓库,则需 将你的GitHub账号与你的Epic Games账号绑定 。
3.安装Docker
推荐使用Docker来构建并运行包含在虚幻引擎中的容器镜像。安装Docker步骤依你使用的操作系统而定。以下链接将提供安装说明,指导你在每个可用的平台上进行安装:
-
Windows: 安装Windows版Docker桌面版
-
macOS: 安装Mac版Docker桌面版
-
Linux: 按照相应说明为你的特定Linux发行版安装Docker引擎:
4.使用GitHub容器注册表进行身份认证
如需要使用Docker通过GitHub容器注册表(GitHub Container Registry)下载容器镜像,则需使用你的个人访问令牌进行身份验证。如果你未持有`read:packages`范围的个人访问令牌,则需 按照步骤创建一个 。
创建具有所需范围的个人访问令牌后,可按照[GitHub提供的说明]使用
docker login
命令通过GitHub容器注册表(GitHub Container Registry)进行身份认证(https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry#authenticating-to-the-container-registry)。此命令需从命令行界面运行,该界面的访问方式依你使用的操作系统而定。
-
Windows: 打开开始(Start)菜单,在搜索框中键入"cmd"。显示的第一个搜索结果应该就是应用程序"命令提示符"。单击命令提示符或按回车键打开命令提示符。
-
macOS: 同时按命令+空格键打开Spotlight搜索,然后在搜索框中输入"terminal"。显示的第一个搜索结果应该就是应用程序"终端"。单击该终端或按回车键打开终端。
-
Linux: 打开桌面环境的搜索功能(通常可按超键访问),然后在搜索框中键入"terminal"。显示的第一个搜索结果应该就是终端应用程序。单击该终端或按回车键打开终端。
打开命令行提示符后,运行如下命令,将
ACCESS_TOKEN
替换为你的个人访问令牌,同时将
USERNAME
替换为你的GitHub用户名:
echo ACCESS_TOKEN | docker login ghcr.io -u USERNAME --password-stdin
如果身份验证流程成功,你应该会看到 "登录成功(Login Succeeded)" 消息提醒。
5.拉取预构建容器镜像
虚幻引擎的官方预构建容器镜像作为镜像标签存储在
ghcr.io/epicgames/unreal-engine
仓库中。如需下载虚幻引擎4.27的Linux开发镜像,请使用下文所示的
docker pull
命令:
docker pull ghcr.io/epicgames/unreal-engine:dev-4.27
执行该命令将下载一个封装了虚幻编辑器专用文件和构建工具的容器镜像,该镜像非常大。下载过程可能需要耗费一些时间,具体用时依你的互联网连接速度而定。下载完成后,你应该会看到消息*"状态:已下载ghcr.io/epicgames/unreal-engine:dev-4.27的最新镜像(Status:Downloaded newer image for ghcr.io/epicgames/unreal-engine:dev-4.27")。
6.在开发容器中构建一个项目
如果你没有可用于测试的虚幻引擎项目,则需 按照步骤创建新项目 。只要项目未使用与Linux不兼容的代码插件,你都可以用来测试开发容器镜像。
打开命令行提示符,然后运行下文所示命令,使用开发镜像启动新容器,将
PROJECT_PATH
替换为包含项目
.uproject
文件的目标路径:
docker run --rm -ti -v "PROJECT_PATH:/project" ghcr.io/epicgames/unreal-engine:dev-4.27
该操作将打开可访问项目文件的容器。因容器运行的是Linux,所以可使用该容器为Linux设备构建和打包项目。如需打包项目,请运行以下所示命令,将
PROJECT_NAME
替换为项目名称:
/home/ue4/UnrealEngine/Engine/Build/BatchFiles/RunUAT.sh \
BuildCookRun \
-utf8output \
-platform=Linux \
-clientconfig=Shipping \
-serverconfig=Shipping \
-project=/project/PROJECT_NAME.uproject \
-noP4 -nodebuginfo -allmaps \
-cook -build -stage -prereqs -pak -archive \
-archivedirectory=/project/Packaged
项目的C++ 代码模块将会经过编译(如果项目不是仅蓝图项目),然后项目资产将接受烘焙和打包。经打包的文件将放置在包含
.uproject
文件的目录下一个名为
Packaged
的子目录中。
如需终止此容器,请运行以下所示命令:
exit
后续步骤
既然你已熟悉了预构建容器镜像的基础用法,现在可以继续学习更多有关如何使用虚幻引擎容器的资源:
-
除下载预构建的容器镜像外,也可通过代码源来自定义和构建包含在虚幻引擎中的所有镜像:
-
操作方法: 通过源代码编译Linux容器镜像
-
操作方法: 通过源代码构建Windows容器镜像
-
如果无法确定需要开发镜像还是运行时镜像,请查看虚幻容器(Unreal Container)社区中心的交互式 快速入门指南 。
-
探索可从虚幻引擎容器中受益的 用例列表 。