UE4资源热更打包工具HotPatcher

HotPatcher是我最近写的用于打包UE项目资源热更的工具，用于追踪工程版本的资源变动来打出Patch。支持一键Cook多平台，一键打包多平台Patch，编辑器支持Windows和MacOS，再写一套从服务器下载patch的流程就是一套完整的游戏热更方案。HotPatcher在项目里已经使用了一段时间，目前比较稳定，今天整理了一下文档，开源出来，会持续更新，欢迎提issus。

HotPatcher与UnrealFrontEnd中的Patch不同，UE的Patch是基于Cook出的资产作为版本管理的内容，这样在管理工程时存在问题：同样的工程版本，很难在不同的电脑上打出相同的Patch（除非把Cooked同步提交，很难管理），也无法基于Patch的版本再打出一个Patch，而且我们还需要能够方便地能够把外部文件打包到pak中（如lua文件），并且方便管理工程和Patch版本，这个插件就是为了解决上面这样的问题。

注意：该插件只能打出包含UE的资源以及添加的外部文件作为热更的内容（支持lua），修改的C++代码无法热更，需要自己设计好架构。如果是纯蓝图项目则可以完全使用这个工具进行热更。

HotPatcher插件支持根据选择只打包指定的资源（可以指定包含过滤器以及忽略过滤器以及可以指定单个资源），支持资源的递归依赖分析（如只打包某个地图及其所有依赖的资源），打包的Path中可以选择不包含未引用的资源，也不会包含未改动的资源，还会分析项目中的无效资产以及忽略重定向器的资源，实现了基于项目资产的版本追踪而无需管理Cooked的内容，只需要在打Patch之前Cook一遍保证Cook的内容是基于最新工程版本的即可。

除了包含UE的资源文件外，额外的支持：

支持包含Cooked出的非资源文件如AssetRegistry.bin/GlobalShaderCache*.bin/ShaderBytecode*.ushaderbytecode；
支持包含引擎、项目、和插件的ini文件；
支持包含外部的文件夹和文件（如lua文件，视频文件等），并且可以自定义挂载点，供运行时访问；
打出的pak中可以不包含任何UE的资源文件（只要在HotPatcher中不添加任何资源即可），方便只更新lua的代码或者只更新Ini之类的配置文件；

插件的其他功能：

支持基于上一个patch版本再打出一个patch版本；
支持检测未cook的资源；
支持版本间的diff，可以看到新增、修改、删除（但是删除的资源在之前的版本的pak中是无法删除的，只是diff展示用）的资源信息；
支持检测重复的文件包含；
支持导出该插件所有的中间生成信息和配置；
支持自定义UnrealPak的参数；
支持同时打出多个平台的patch；

同时，我也写了一个批量Cook的工具，用于一键Cook指定的多个平台（当然使用命令行也可以），目的就是使用最少的步骤完成任务。

插件使用流程

为了方便版本管理，项目一定要使用某种版本控制工具，建议Git.

打开HotPatcher，选择ByRelease，导出*_Release.json，其中记录了所指定的每个资源的信息；
使用UE直接打包任意平台的项目（如windows/android/ios）
在工程中修改/添加/删除资源，修改引擎/项目/插件的设置等；
打开HotPatch，在Cook项选择你要打Patch的平台并执行Cook；
打开HotPatcher，选择ByPatch，以上面导出的*_Release.json为基础版本，根据需求选择你需要打到Pak中的内容；
点击GeneratedPatch，会生成Pak文件和各种信息（其中也包含当前版本的*_Release.json，使Patch可以增量更新）
生成的Pak中就包含了与上次打出的包中所有差异的内容。

Cook参数说明

HotPatcher中的Cook部分是为了打Patch时方便Cook多个平台，以及方便指定地图（插件会扫描整个项目中的所有地图并列出），不用每次Cook都使用命令行。

Cook可选的分为Platforms/Map(s)/Settings：

Platforms：选择Cook 的平台，可以多选；
Map(s)：选择要Cook的Map，该选项下会列出当前工程里所有的Map，可以多选；
Settings：选择Cook设置，默认提供了Iterator/UnVersioned/CookAll/Compressed四个选项，我也提供了OtherOptions可以自己指定要Cook 的参数。

注意：Map(s)中的地图和Settings中的CookAll必须要选中其中的一个才可以打包，如果只选了CookMap，则只会Cook该Map所引用到的资源，没有被引用的不会被Cook，这个需要注意。

点击CookContent之后会将Cook的log输出到UE的OutputLog中。

ByRelease参数说明

ByRelease操作导出的是一个json的文件，记录了导出时所选择的每个Asset资源的HASH值，基于此HASH值我们可以在后续的Patch中知道该资源是不是被修改了。

VersionId：指定当前导出的资源信息是什么版本。
IncludeFilter：当前Release扫描哪些目录下的资源。
IgnoreFilter：当前Release忽略哪些目录下的资源。
IncludeHasRefAssetsOnly：对选中的过滤器中的资源文件进行依赖分析（递归分析至Map），如果资源没有被引用则不会打包到Patch中。
IncludeSpecifyAssets：结构的数组，可以指定当前Release中的单个资源，该结构的第一个参数需要指定资源，第二个参数控制是否分析并包含当前指定资源的依赖到pak中。

注意：导出Release时，资源的包含需要与UE直接打包时的设置一致，因为这里导出的Release是记录使用UE直接打出的包所包含的资源。

ByPatch参数说明

ByPatch是真正执行打包出Pak的工具，可以基于之前导出的版本(通过ByRelease导出的Json文件)，也可以包含外部文件/文件夹、配置文件（ini）、Cook出的非资源文件（AssetRegistry.bin等），并且可以指定多个平台，支持输入UnrealPak的参数，可以导出当前Patch的各种信息。

支持指定资源过滤器：

HotPatcher打Patch的选项解析：

bByBaseVersion：是否是基于某个基础版本的Patch，若为false，则只打包选择的过滤器文件（依然会分析依赖）和添加的外部文件，若为true则必须要指定一个基础版本，否则无法执行Patch。同时该属性也会控制是否生成Diff信息，若为false则不生成Diff（没有基础版本diff也无意义）。
BaseVersion：该选项应选择Patch所基于的版本文件，可以ByRelease或者上次一的Patch生成，默认为*_Release.json。
VersionId：当前Patch的版本的ID
IncludeFilter：当前Patch扫描哪些目录下的资源变动。
IgnoreFilter：当前Patch忽略哪些目录下的资源变动。
IncludeHasRefAssetsOnly：对选中的过滤器中的资源文件进行依赖分析（递归分析至Map），如果资源没有被引用则不会打包到Patch中。
IncludeSpecifyAssets：结构的数组，可以指定需要打到Pak中的单个资源，该结构的第一个参数需要指定资源，第二个参数控制是否分析并包含当前指定资源的依赖到pak中。
IncludeAssetRegistry：在当前的Patch打出的Pak中包含AssetRegistry.bin文件。
IncludeGlobalShaderCache：在当前的Patch打出的Pak中包含GlobalShaderCache-*.bin文件。
IncludeShaderBytecode：在当前Patch打出的Pak中包含PROJECT_NAME\Content\ShaderArchive*.ushaderbytecode文件。
IncludeEngineIni：在当前打出的Patch中包含引擎目录下的ini，也会包含平台相关的ini
IncludePluginIni：在当前打出的Patch中包含所有启用的插件中的ini（引擎目录和项目目录的插件都会包含）
IncludeProjectIni：在当前的Patch打出的Pak中包含项目的ini文件（不会包含DefaultEditor*.ini）
AddExternFileToPak：添加外部的非资源文件到Pak中，如txt、视频。

AddExternFileToPak的元素要求：

FilePath需要指定所选文件的路径。
MountPath为该文件被打包到Pak中的挂载路径，默认是../../../PROJECT_NAME/下。

在游戏运行时可以通过FPaths::ProjectDir来访问。
如，AAAA.json的MountPath为../../../HotPatcherExample/AAAAA.json，在运行时加载的路径：

1	FPaths::Combine(FPaths::ProjectDir(),TEXT("AAAAAA.json"));

Pak中的所有文件可以通过IPlatformFile来访问。

AddExternDirectoryToPak：结构的数组，添加外部文件夹到Pak中，该结构第一个参数(DirectoryPath)为指定系统中的文件夹路径，第二个参数(Mount Point)指定该路径在Pak中的挂载路径；指定文件夹下的所有文件会被递归包含，并且挂载路径均相对于所指定的MountPoint。
IncludePakVersionFile：是否在当前打出的Patch中存储版本信息。
PakVersionFileMountPoint：由IncludePakVersionFile控制是否可以编辑，用于指定*_PakVersion.json文件在Pak文件中的挂载点，默认为../../../PROJECT_NAME/Extention/Versions。

如果选择了在Pak存储版本信息，则可以使用FPakHelper::LoadVersionInfoByPak来读取Pak中的版本信息，可以用在Pak文件验证上。

Pak的版本信息为以下结构：

USTRUCT(BlueprintType)
struct FPakVersion
{
	GENERATED_USTRUCT_BODY()
public:
	UPROPERTY(EditAnywhere,BlueprintReadWrite)
		FString VersionId;
	UPROPERTY(EditAnywhere,BlueprintReadWrite)
		FString BaseVersionId;
	UPROPERTY(EditAnywhere,BlueprintReadWrite)
		FString Date;
	UPROPERTY(EditAnywhere,BlueprintReadWrite)
		FString CheckCode;
};

其中：VersionId为Pak的版本Id，BaseVersionId为该Pak的基础版本ID，Date为Pak创建的日期，CheckCode的值默认为把VersionId_BaseVersionId_Date拼接到一块进行的SHA1编码。

UnrealPakOptions：该数组为UnrealPak.exe程序的参数。如果什么都不指定，默认的配置为UnrealPak.exe PAKFILE.pak -create=PAK_LIST.txt.
PakTargetPlatforms：该数组为选择要打出的Patch的平台，可以多选，一定要注意所选的平台已经被Cook。
SavePakList：是否存储UnrealPak.exe 的-Create参数文件。
SaveDiffAnalysis：是否存储当前的Patch版本与Base版本的差异信息。
SavePatchConfig：是否存储当前Patch的所有选项信息。
SavePath：本次的Patch信息存储位置。会在当前目录下创建出名字为VersionId的文件夹，所有的文件在此文件夹中。