这是一个笔记,梳理一下自己整理的自动打包工具,当成 Readme 也不错。
前言:
之前没想过,一旦遇见了才发现原来真有这样的情况,用一个项目打包 N 个应用,区别只是选择的 Scene 不同。这种需求如果用人工来处理就得在 Build Settings/Scene In Build
中不停的切换和组合 Scene,同时还要考虑修改 ProjectSettings/Player/Product Name
中的软件名称。
这种耗时还容易出错的事情,我们完全可以写一个一键处理的插件来解放双手!
需求:
实现一次配置,一键打包多个应用,还要有高可配置性:
- 打包平台可配置
- 打包存储位置可配置 ,使用 OpenFolderAttribute实现。
- 打包后处理可配置:打调试包、打包并运行、打包后打开存储位置
- 能够配置打成哪些个应用
- 能够配置出包的应用的场景列表哪些需要包含哪些不需要
- 优秀的人机交互,打包前有配置校验,打包后也要输出报告。
- 更广域的 Unity 版本支持(实测支持 2018.4 及以上)- 请使用高版本
实现:
由于笔者需要向下兼容到 Unity 2018.4.8,因为集合在旧版本 Unity 检视器(Inspecter)上还不支持拖动排序(亦既是暂未支持 ReorderableList),所以本工具将用到第三方的 ReorderableList 插件。
那么问题就简单了,直接变成了怎么用好 ReorderableList 插件,按人家示例看看就能用好,就 nice。
剩下的事情只是按需求设计好数据结构就行,数据结构在如下图所示 Data 文件夹中,这些数据构成了上面插件预览图中你看到的内容:
当我们有了数据,接下来就是数据的取用了:一来用于绘制在 Inspector 上,二来用户保存和提供打包时各个自定义的数据。
打包就更简单了,只需要将用户配置的数据进行整理,然后使用 Unity 的 BuildPlayer 接口即可,该系列接口为(演示了:设置应用名、设置版本、打包、展示打包结果):
var dir = $"{config.appLocationPath}/{profile.productName}";
var file = $"{dir}/{profile.productName}.exe";
PlayerSettings.productName = profile.productName;
PlayerSettings.bundleVersion= profile.productVersion;
var report = BuildPipeline.BuildPlayer(scenes.ToArray(), file, config.targetPlatform, options_unity);
Debug.Log($"{profile.productName} 打包结果:{report.summary.result}");
关于校验,只需要判断各个层级的数据是否合理的配置了即可,比如存储路径是否为空啊,软件名是否为空,软件是否没有指定 Scene或者 Scene没勾选呀这样。
/// <summary>
/// 配置校验,如果配置不对不打包
/// </summary>
/// <param name="config"></param>
static void ValidateProfiles(AutoBuildConfiguration config)
{
if (string.IsNullOrEmpty(config.appLocationPath))
{
throw new Exception("应用打包存储路径未指定!");
}
if (config.profiles.Any(v => string.IsNullOrEmpty(v.productName)))
{
throw new Exception("配置中存在软件名称为空的情况,请修复!");
}
if (config.profiles.All(v => !v.isBuild))
{
throw new Exception("请至少保证一个打包的配置 isBuild = true");
}
foreach (var profile in config.profiles)
{
if (profile.isBuild)
{
if (profile.scenes.Count == 0)
{
throw new Exception($"请至少给 {profile.productName} 一个场景!");
}
if (profile.scenes.Any(v => !v.scene))
{
throw new Exception("场景列表请不要留空!");
}
if (profile.scenes.All(v => !v.enabled))
{
throw new Exception($"{profile.productName} 场景列表请至少勾选一个场景!");
}
}
}
}
演示:
- 演示了打包前的校验
- 演示了打包完成的应用唤起
- 演示了打包完成的报告展示
- 应用中则展示了场景的包含关系与配置的包含关系的一致性
扩展阅读:
- 本插件地址:Unity-Application-Auto-Builder
- 本插件依赖:Unity-Reorderable-List
写到最后:
内容很简单,效果很理想,总结几个关键字吧 :ReorderableList 、ScriptableObject、EditorWindow、BuildPipeline、PropertyAttribute、PropertyAtrributeDrawer、.asmdef、UPM。
2023年9月17日 更新
- 支持了用户自定义任务,现在更实用了
- 使用了新语法,移除了第三方 ReorderableList,故而请尽量使用高版本Unity (笔者 Unity 2021.3)
版权所有,转载请注明出处