From 426ad262b16ae2800e70e3d6eff885d3e89be95b Mon Sep 17 00:00:00 2001 From: hevinci Date: Thu, 3 Mar 2022 19:33:36 +0800 Subject: [PATCH] Update document --- Docs/AssetBuilder.md | 28 ++++++++++++------------- Docs/AssetCollector.md | 45 ++++++++++++++++++++++------------------- Docs/Settings.md | 14 ++++++------- Docs/YooAssetUpdater.md | 19 +++++------------ 4 files changed, 50 insertions(+), 56 deletions(-) diff --git a/Docs/AssetBuilder.md b/Docs/AssetBuilder.md index 1843a3f..7d41c71 100644 --- a/Docs/AssetBuilder.md +++ b/Docs/AssetBuilder.md @@ -4,33 +4,33 @@ ### 界面介绍 -**Build Output** +- **Build Output** -构建输出的目录，会根据Unity编辑器当前切换的平台自动划分构建结果。 + 构建输出的目录，会根据Unity编辑器当前切换的平台自动划分构建结果。 -**Build Version** +- **Build Version** -构建版本号，也是资源版本号，版本号必须大于零。 + 构建版本号，也是资源版本号，版本号必须大于零。 -**Compression** +- **Compression** -资源包的压缩方式。 + 资源包的压缩方式。 -**Append Extension** +- **Append Extension** -构建的资源包文件名是否包含后缀格式。 + 构建的资源包文件名是否包含后缀格式。 -**Force Rebuild** +- **Force Rebuild** -是否为强制重新构建，如果不勾选则为增量构建模式。注意：强制重建会删除当前平台下所有的补丁包文件。 + 是否为强制重新构建，如果不勾选则为增量构建模式。注意：强制重建会删除当前平台下所有的补丁包文件。 -**Buildin Tags** +- **Buildin Tags** -标记为安装包里的资源标签列表。构建成功后，会将相关标记的资源包拷贝到StreamingAssets文件夹下。 + 标记为安装包里的资源标签列表。构建成功后，会将相关标记的资源包拷贝到StreamingAssets文件夹下。 -**Build** +- **Build** -点击Build按钮会开始构建流程，构建流程分为多个节点顺序执行，如果某个节点发生错误，会导致构建失败。错误信息可以在控制台查看。 + 点击Build按钮会开始构建流程，构建流程分为多个节点顺序执行，如果某个节点发生错误，会导致构建失败。错误信息可以在控制台查看。 ### 资源包加密 diff --git a/Docs/AssetCollector.md b/Docs/AssetCollector.md index 5e8411b..f56cc3d 100644 --- a/Docs/AssetCollector.md +++ b/Docs/AssetCollector.md @@ -4,25 +4,26 @@ ### 界面介绍 -**着色器收集** +- **着色器收集** -勾选收集所有着色器复选框后，打包系统会自动收集所有依赖的材质球使用的着色器，并将这些着色器打进一个AssetBundle文件内。 + 勾选收集所有着色器复选框后，打包系统会自动收集所有依赖的材质球使用的着色器，并将这些着色器打进一个AssetBundle文件内。 -**Directory** +- **Directory** -收集的资源目录，目录下的所有文件将会根据打包规则和过滤规则进行打包。 + 收集的资源目录，目录下的所有文件将会根据打包规则和过滤规则进行打包。 -**PackRule** +- **PackRule** -打包规则，规则可以自定义扩展。下面是内置的打包规则： + 打包规则，规则可以自定义扩展。下面是内置的打包规则： -1. PackExplicit 目录下的资源文件会各自打进自己的资源包里。 -2. PackDirectory 目录下的资源文件会被打进一个资源包里。 -3. PackRawFile 目录下的资源文件会被处理为原生资源包。 + - PackExplicit 目录下的资源文件会各自打进自己的资源包里。 -自定义扩展范例 + - PackDirectory 目录下的资源文件会被打进一个资源包里。 + + - PackRawFile 目录下的资源文件会被处理为原生资源包。 ````c# +//自定义扩展范例 public class PackDirectory : IPackRule { string IPackRule.GetAssetBundleLabel(string assetPath) @@ -32,18 +33,20 @@ public class PackDirectory : IPackRule } ```` -**FilterRule** +- **FilterRule** -过滤规则，规则可以自定义扩展。下面是内置的过滤规则： + 过滤规则，规则可以自定义扩展。下面是内置的过滤规则： -1. CollectAll 收集目录下的所有资源文件 -2. CollectScene 只收集目录下的场景文件 -3. CollectPrefab 只收集目录下的预制体文件 -4. CollectSprite 只收集目录下的精灵类型的文件 + - CollectAll 收集目录下的所有资源文件 -自定义扩展范例 + - CollectScene 只收集目录下的场景文件 + + - CollectPrefab 只收集目录下的预制体文件 + + - CollectSprite 只收集目录下的精灵类型的文件 ````c# +//自定义扩展范例 public class CollectScene : IFilterRule { public bool IsCollectAsset(string assetPath) @@ -53,13 +56,13 @@ public class CollectScene : IFilterRule } ```` -**DontWriteAssetPath** +- **DontWriteAssetPath** -资源目录下的资源对象不写入清单 + 资源目录下的资源对象不写入清单 -**AssetTags** +- **AssetTags** -资源标签列表（多个标签使用分号间隔） + 资源标签列表（多个标签使用分号间隔） ### 配置表 diff --git a/Docs/Settings.md b/Docs/Settings.md index fdb56f7..7446c0b 100644 --- a/Docs/Settings.md +++ b/Docs/Settings.md @@ -6,15 +6,15 @@ **注意**：请将配置文件放在Resources文件夹下 -**Asset Bundle File Variant** : AssetBundle资源包后缀名 +配置说明： -**Raw File Variant** : 原生资源包后缀名 +- **Asset Bundle File Variant** : AssetBundle资源包后缀名 +- **Raw File Variant** : 原生资源包后缀名 -**Patch Manifest File Name** : 补丁清单文件名 +- **Patch Manifest File Name** : 补丁清单文件名 -**Patch Manifest Hash File Name** : 补丁清单哈希文件名 +- **Patch Manifest Hash File Name** : 补丁清单哈希文件名 -**Unity Manifest File Name** : Unity构建的清单名称 - -**Readme File Name** : 说明文件名称 +- **Unity Manifest File Name** : Unity构建的清单名称 +- **Readme File Name** : 说明文件名称 diff --git a/Docs/YooAssetUpdater.md b/Docs/YooAssetUpdater.md index 39096ef..d75cb0c 100644 --- a/Docs/YooAssetUpdater.md +++ b/Docs/YooAssetUpdater.md @@ -33,7 +33,7 @@ private IEnumerator UpdatePatchManifest() 根据产品需求，可以选择更新全部资源，或者只更新部分资源。 ````c# -private PatchDownloader _downloader; +private DownloaderOperation _downloader; /// /// 创建下载器 @@ -43,7 +43,7 @@ private void CreateDownloader() string[] tags = { "buildin", "config" }; int downloadingMaxNum = 10; int failedTryAgain = 3; - _downloader = YooAssets.CreateDLCDownloader(tags, 10, 3); + _downloader = YooAssets.CreatePatchDownloader(tags, downloadingMaxNum, failedTryAgain); if (_downloader.TotalDownloadCount == 0) { //没有需要下载的资源 @@ -56,25 +56,16 @@ private void CreateDownloader() } } -/// -/// 更新下载器 -/// -private void UpdateDownloader() -{ - if (_downloader != null) - _downloader.Update(); -} - /// /// 开启下载 /// private IEnumerator Download() { //注册下载回调 - _downloader.OnPatchFileDownloadFailedCallback = OnPatchFileDownloadFailed; + _downloader.OnDownloadFileFailedCallback = OneDownloadFileFailed; _downloader.OnDownloadProgressCallback = OnDownloadProgressUpdate; _downloader.OnDownloadOverCallback = OnDownloadOver; - _downloader.Download(); + _downloader.BeginDownload(); yield return _downloader; //检测下载结果 @@ -91,7 +82,7 @@ private IEnumerator Download() /// /// 文件下载失败 /// -private void OnPatchFileDownloadFailed(string fileName) +private void OneDownloadFileFailed(string fileName) { Debug.LogError($"File download failed : {fileName}"); }