UE4工具链配置与开发技巧

工欲善其事,必先利其器!掌握好的工具会使开发效率上一个层次。
本文是我平时记录在notes中关于UE工具链以及一些组合UE使用的工具配置和使用技巧的笔记整理,后续这方面的内容也会收录到这篇文章中。
下面是我之前写的关于UE工具链或扩展相关的单独的文章:

使用Doxygen从UE代码生成文档

最近使用doxygen从UnrealEngine源码生成了Runtime/Engine模块文档,导出的chm都700M了(主要是各种grahp大),好大。
注意,使用doxygen从UE源码生成文档之前,记得删除源码中所有的.h/.hpp中的UE的宏(我自己写了个简单的程序来处理这个事情),不然生成出来的会有问题(比如函数名不见了,显示出来的时UFUNCTION,或者成员变量不见了,显示出来的是UPROPERTY)。主要删除以下这几个MACRO就可以。

1
2
3
4
5
6
7
8
"UFUNCTION",
"DEPRECATED",
"UCLASS",
"UINTERFACE",
"UPROPERTY",
"GENERATED_BODY()",
"GENERATED_UCLASS_BODY()",
"GENERATED_INTERFACE_BODY()"

使用sed就是如下的命令:

1
2
3
4
# 删除源文件中的宏并保存
$ sed -i -e /UFUNCTION/d -e /DEPRECATED/d -e /UCLASS/d -e /UINTERFACE/d -e /UPROPERTY/d -e /GENERATED_BODY/d -e /GENERATED_UCLASS_BODY/d -e /GENERATED_INTERFACE_BODY/d ${filename}
# Example Actor.h
$ sed -i -e /UFUNCTION/d -e /DEPRECATED/d -e /UCLASS/d -e /UINTERFACE/d -e /UPROPERTY/d -e /GENERATED_BODY/d -e /GENERATED_UCLASS_BODY/d -e /GENERATED_INTERFACE_BODY/d Actor.h

UnrealVersionSelector的参数

  • -register:Add the current directory to the list of installations
  • -fileassociations:Update all the settings.
  • -switchversion:Associate with an engine label
  • -switchversionsilent:Associate with a specific engine label
  • -editor:Open a project with the editor
  • -projectlist:Open the editor
  • -game:Play a game using the editor executable
  • -projectfiles:Generate Visual Studio project files

UnrealPak的参数

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
Usage:
UnrealPak <PakFilename> -Test
UnrealPak <PakFilename> -List
UnrealPak <PakFilename> <GameUProjectName> <GameFolderName> -ExportDependencies=<OutputFileBase> -NoAssetRegistryCache -ForceDependsGathering
UnrealPak <PakFilename> -Extract <ExtractDir>
UnrealPak <PakFilename> -Create=<ResponseFile> [Options]
UnrealPak <PakFilename> -Dest=<MountPoint>
UnrealPak GenerateKeys=<KeyFilename>
UnrealPak GeneratePrimeTable=<KeyFilename> [-TableMax=<N>]
UnrealPak <PakFilename1> <PakFilename2> -diff
UnrealPak -TestEncryption
Options:
-blocksize=<BlockSize>
-bitwindow=<BitWindow>
-compress
-encrypt
-order=<OrderingFile>
-diff (requires 2 filenames first)
-enginedir (specify engine dir for when using ini encryption configs)
-projectdir (specify project dir for when using ini encryption configs)
-encryptionini (specify ini base name to gather encryption settings from)
-encryptindex (encrypt the pak file index, making it unusable in unrealpak without supplying the key)

比较常用的命令组合:

1
2
3
4
5
6
7
8
# 将COOCKED_ASSET_FOLDER路径下所有cookedd的资源打包到一个pak里面,并执行压缩
unrealpak.exe NEW_PAK_FILE_NAME.pak -create=COOCKED_ASSET_FOLDER -compress
# 加密pak,需要指定32位的AES key,要执行加密-encrypt/-encrtptindex/-aes缺一不可。
unrealpak.exe NEW_PAK_FILE_NAME.pak -create=COOCKED_ASSET_FOLDER -compress -encrypt -encryptindex -aes=32BIT_AES_KEY
# 查看pak中的资源列表
unrealpak.exe PAK_FILE_NAME.pak -list
# 查看加密的pak中的资源列表
unrealpak.exe NEW_PAK_FILE_NAME.pak -list -aes=32BIT_AES_KEY

相关工具:

UE4:修改Setup.bat使用的线程数加速下载

在下载UE4的源码之后,需要先执行Setup.bat下载依赖才可以开始生成VS项目文件以及编译。

但是国内的网络环境又极差,默认的Setup.bat是没有指定线程数量的(Setup.bat只给GitDenpencies传递了--prompt参数)。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
@echo off
setlocal
pushd %~dp0

rem Figure out if we should append the -prompt argument
set PROMPT_ARGUMENT=
for %%P in (%*) do if /I "%%P" == "--prompt" goto no_prompt_argument
for %%P in (%*) do if /I "%%P" == "--force" goto no_prompt_argument
set PROMPT_ARGUMENT=--prompt
:no_prompt_argument

rem Sync the dependencies...
.\Engine\Binaries\DotNET\GitDependencies.exe %PROMPT_ARGUMENT% %*
if ERRORLEVEL 1 goto error

rem Setup the git hooks...
if not exist .git\hooks goto no_git_hooks_directory
echo Registering git hooks...
echo #!/bin/sh >.git\hooks\post-checkout
echo Engine/Binaries/DotNET/GitDependencies.exe %* >>.git\hooks\post-checkout
echo #!/bin/sh >.git\hooks\post-merge
echo Engine/Binaries/DotNET/GitDependencies.exe %* >>.git\hooks\post-merge
:no_git_hooks_directory

rem Install prerequisites...
echo Installing prerequisites...
start /wait Engine\Extras\Redist\en-us\UE4PrereqSetup_x64.exe /quiet

rem Register the engine installation...
if not exist .\Engine\Binaries\Win64\UnrealVersionSelector-Win64-Shipping.exe goto :no_unreal_version_selector
.\Engine\Binaries\Win64\UnrealVersionSelector-Win64-Shipping.exe /register
:no_unreal_version_selector

rem Done!
goto :EOF

rem Error happened. Wait for a keypress before quitting.
:error
pause

GitDependencies.exe支持的参数为:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
Usage:
GitDependencies [options]

Options:
--all Sync all folders
--include=<X> Include binaries in folders called <X>
--exclude=<X> Exclude binaries in folders called <X>
--prompt Prompt before overwriting modified files
--force Always overwrite modified files
--root=<PATH> Set the repository directory to be sync
--threads=<N> Use N threads when downloading new files
--dry-run Print a list of outdated files and exit
--max-retries Override maximum number of retries per file
--proxy=<user:[email protected]> Sets the HTTP proxy address and credentials
--cache=<PATH> Specifies a custom path for the download cache
--cache-size-multiplier=<N> Cache size as multiplier of current download
--cache-days=<N> Number of days to keep entries in the cache
--no-cache Disable caching of downloaded files

Detected settings:
Excluded folders: Mac, Android, Linux
Proxy server: none
Download cache: E:\UnrealEngine\EngineSource\UE_4.21_Source\.git\ue4-gitdeps

Default arguments can be set through the UE4_GITDEPS_ARGS environment variable.

所以我们可以将Setup.bat中的变量PROMPT_ARGUMENT增加上指定的线程数即可(N替换为数字):

1
set PROMPT_ARGUMENT=--prompt --threads=N

我一般开8个线程,基本可以跑2-3M/s...

UE4:Clion debug project on MacOS

使用Clion打开项目之后设置debug(Run-Edit Configuration):

Executable选择为项目目录下的Binaries中编译出来的可执行文件,然后加上参数-game -log即可。

MacOS安装UE

UE要求MacOS的分区格式为不区分大小写(不然EpicLauncher也无法安装),而且安装引擎的要求是系统版本大于10.13.5,否则会出现引擎崩溃和一些不支持的情况(尝试忽略错误无法安装成功)。
编译依赖xcode,就像依赖VS一样,需要安装编译环境。
如果安装完UE和Xcode之后创建项目提示下列错误:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
An error occurred while trying to generate project files.
Running Mono...
Setting up Mono
/Users/Shared/UnrealEngine/4.22/Engine /Users/Shared/UnrealEngine/4.22/Engine/Binaries/Mac
Discovering modules, targets and source code for project...
Compiling with non-standard Xcode (xcode-select): /Library/Developer/CommandLineTools/
Triggered an exception while looking for SDK directory in Xcode.app
System.IO.DirectoryNotFoundException: Directory '/Library/Developer/CommandLineTools/Platforms/MacOSX.platform/Developer/SDKs' not found.
at System.IO.Directory.ValidateDirectoryListing (System.String path, System.String searchPattern, System.Boolean& stop) [0x00000] in <filename unknown>:0
at System.IO.Directory.GetFileSystemEntries (System.String path, System.String searchPattern, FileAttributes mask, FileAttributes attrs) [0x00000] in <filename unknown>:0
at System.IO.Directory.GetDirectories (System.String path, System.String searchPattern) [0x00000] in <filename unknown>:0
at System.IO.Directory.GetDirectories (System.String path) [0x00000] in <filename unknown>:0
at UnrealBuildTool.AppleToolChain.SelectSDK (System.String BaseSDKDir, System.String OSPrefix, System.String& PlatformSDKVersion, Boolean bVerbose) [0x00000] in <filename unknown>:0
ERROR: Invalid SDK MacOSX.sdk, not found in /Library/Developer/CommandLineTools/Platforms/MacOSX.platform/Developer/SDKs

则安装Xcode Command Line Tools,然后执行以下命令即可:

1
$ sudo ln -s /Applications/Xcode.app/Contents/Developer/Platforms /Library/Developer/CommandLineTools/

使用VSC编写代码(UE_4.18+)

下面是UE的官方介绍:New: Visual Studio Code Supported on Windows, Mac and Linux

You can now use Visual Studio Code to write code on all UE4 host platforms. To use it, select "Visual Studio Code" as your preferred IDE from the editor preferences dialog, or add the -vscode argument when generating project files on the command line. All platforms are also required to have the .NET Core 2.0 runtimes installed, which can be obtained from the Microsoft .NET Core website.
To use Visual Studio Code to build and debug all project types, some additional extensions are required. On all platforms, make sure the Microsoft C/C++ extension, and the C# extension are installed. On Linux and Mac, the "Mono Debug" extension is required to debug C# projects, and the “LLDB Debugger” extension is required to debug C++ projects. Also, in order to debug C# projects, the mono runtime must be installed:

  • On OS X: brew install mono
  • On Linux:sudo apt-get install mono-complete

UE蓝图的Paste工具

可以把蓝图的代码复制到blueprintue.com,把网址发给别人,就能够让别人看到蓝图里的节点,就像在UE的编辑器里一样。

UE4:添加UE的Code Snippet到VS

首先,打开源码版UE以下目录(从EpicGameLauncher安装的没有,若没有源码版引擎可以点这里下载):

1
Engine\Extras\VisualStudioSnippets

这个目录下有很多的*.snippet文件,就是VS中的代码片段,主要是对UE的各种宏的封装,这样在VS中写UE的代码时就不用每次都敲一遍了。

导入VS的方法为:在VS中打开Tools-Code Snippets Manager

点击Import,选择上面找到的引擎中的目录Engine\Extras\VisualStudioSnippets,全选导入即可。

在VS里触发的方式为依此按下组合键Ctrl+KCtrl+X,然后选择My Code Snippets,就可以看到导入进来的所有UE的Code Snippets了。

UE4:在VS中调试时显示对象值

打开引擎路径:

1
Engine\Extras\VisualStudioDebugging

该路径下会有一个UE4.natvis文件,将其拷贝到VS的下列路径中:

1
C:\Program Files (x86)\Microsoft Visual Studio\2017\Community\Common7\Packages\Debugger\Visualizers

然后重启启动调试,就可以在调试窗口看到对象值了。

VS调试独立运行的UE项目

在UE的编辑器模式下以Standalone方式运行,在VS中是没办法及时Attach to process上的。
比如我们想要在standalone模式下调试引擎和项目,在editor下直接启动会创建一个新的进程,在VS中手动点Attach to process是很不方便的,也没有那么及时(因为点完启动在等我们在VS中attach到进程上有可能引擎都已经启动完毕了)。
幸好UE提供了一个插件:UnrealVS,该插件的VS安装程序在引擎的Engine\Extras\UnrealVS目录下,根据你的VS版本选择安装。
安装完之后启动VS,在View->Toolbars->UnrealVS启用,就会在VS的工具栏看到了。在这里选择你的项目:

后面的框是命令行框,填入的参数会在启动时传递给程序(具体介绍看UnrealVS里面的描述),所以我们可以在后面填参数使其以独立模式启动(可以从Command-Line Arguments查看支持的参数):

1
"$(SolutionDir)$(ProjectName).uproject" -game -windowed -log -verbose

这样就会在VS中使用F5启动项目时自动attach的到进程上的。

UE Package:Create a patch

最需要注意的是下面三点:
You can patch a project you have previously released using a versioned release. Some things to keep in mind are:

  • Lock down the serialization code paths at the time of release.
  • Keep the released cooked content, as the UnrealPak tool uses this to determine which content should be in the patch package file.
  • At runtime, mount both pak files, with a higher priority for the patch file so any content within it is loaded first.

总结来说就是,要保证与上次打包的资源路径不变/保留上次打包版本的Saved/Cooked目录(因为创建的Patch是通过UnrealPak来检测当前项目里的资源与上次Cooked的差异),程序运行时优先加载Patch的文件*0_P.pak,其中数字越大加载的优先级越高。

蓝图的功能实现也是uasset的,所以也会打包在pak里面,而不会在.exe里。蓝图是运行在虚拟机上的(详见Blueprint FAQ and Tips),并不是类似C++的直接编译成二进制文件,即蓝图也是资源,所以会打包在pak里面,这意味着如果纯用蓝图实现的项目可以不用变动.exe只增加patch就可以达到游戏更新。

注:UnrealFrontend创建的配置是存储在Engine/Programs/UnrealFrontend/Profiles下的*.ulp2文件。

UE4: 修改UnrealForntend的语言

编辑Engine/Programs/UnrealFrontend/Config/DefaultEngine.ini,加入以下配置:

1
2
[Internationalization]
Culture=en

改成zh-CN是中文,不过不建议改成中文的,看着中文的词有歧义,都不知道是什么。

UE创建StandaloneApplication

使用UE也可以写应用程序(StandaloneApplication: Target is Program),可以把UE当作一个超大的ThridParty.
我写了一个模板:hxhb/UEProgramTemplate.
运行效果:

但是想要创建新的StandaloneApplication太麻烦了,我写了一个小工具可以直接创建:hxhb/UECreateProgramTemplateTool.

1
2
3
# Usage
$ create_program.exe $ProgramName
Create Standalone Program Successed!
  1. move $ProgramName Folder to Engine\Source\Programs (version of source code)
  2. run GenerateProgramProject.bat
  3. OpenProgramProject.bat

用起来相当酸爽。

注意
*.target.cs中的配置会影响UBT生成的一些宏定义,比如:

  • bBuildWithEditorOnlyData控制的是WITH_EDITORONLY_DATA
  • bCompileAgainstEngine控制的是WITH_ENGINE

开发Program类型的程序时需要注意这些配置。可以在UnrealBuildSystem/Targets查看*.target.cs支持的全部参数。
UBT的代码里解析*.Target.cs里的配置在Programs\UnrealBuildTools\Configuration\URBuildTarget.csSetupGlobalEnvironment函数。

全文完,若有不足之处请评论指正。
本文标题:UE4工具链配置与开发技巧
文章作者:ZhaLiPeng
发布时间:2019年09月09日 23时32分
本文字数:本文一共有2.9k字
原始链接:https://imzlp.me/posts/12143/
许可协议: CC BY-NC-SA 4.0
转载请保留原文链接及作者信息,谢谢!
您的捐赠将鼓励我继续创作!