From 8b08907ea82225db2432abac393bc233161d273d Mon Sep 17 00:00:00 2001 From: hevinci Date: Thu, 3 Mar 2022 18:40:58 +0800 Subject: [PATCH] Update document --- Docs/AssetBuilder.md | 2 +- Docs/AssetCollector.md | 2 +- Docs/YooAssetInit.md | 2 +- Docs/YooAssetLoader.md | 2 +- Docs/YooAssetUpdater.md | 58 ++++++++++++++++++++--------------------- README.md | 17 ++++++------ 6 files changed, 42 insertions(+), 41 deletions(-) diff --git a/Docs/AssetBuilder.md b/Docs/AssetBuilder.md index b401b5a..3883e5c 100644 --- a/Docs/AssetBuilder.md +++ b/Docs/AssetBuilder.md @@ -98,7 +98,7 @@ private static void BuildInternal(BuildTarget buildTarget) buildParameters.BuildTarget = buildTarget; buildParameters.BuildVersion = buildVersion; buildParameters.CompressOption = ECompressOption.LZ4; - buildParameters.AppendFileExtension = false; + buildParameters.AppendFileExtension = false; buildParameters.IsForceRebuild = isForceBuild; buildParameters.BuildinTags = "buildin"; diff --git a/Docs/AssetCollector.md b/Docs/AssetCollector.md index 74169ec..3023a31 100644 --- a/Docs/AssetCollector.md +++ b/Docs/AssetCollector.md @@ -67,7 +67,7 @@ public class CollectScene : IFilterRule ````xml - + ```` diff --git a/Docs/YooAssetInit.md b/Docs/YooAssetInit.md index 10c9392..a1f4915 100644 --- a/Docs/YooAssetInit.md +++ b/Docs/YooAssetInit.md @@ -54,7 +54,7 @@ private IEnumerator InitializeYooAsset() private IEnumerator InitializeYooAsset() { var createParameters = new YooAssets.HostPlayModeParameters(); - createParameters.LocationRoot = "Assets/GameRes"; + createParameters.LocationRoot = "Assets/GameRes"; createParameters.DecryptServices = null; createParameters.ClearCacheWhenDirty = false; createParameters.IgnoreResourceVersion = false; diff --git a/Docs/YooAssetLoader.md b/Docs/YooAssetLoader.md index b9ce148..fe45374 100644 --- a/Docs/YooAssetLoader.md +++ b/Docs/YooAssetLoader.md @@ -57,7 +57,7 @@ async Task AsyncLoad() { AssetOperationHandle handle = YooAssets.LoadAssetAsync("Audio/bgMusic.mp3"); await handle.Task; - AudioClip audioClip = handle.AssetObject as AudioClip; + AudioClip audioClip = handle.AssetObject as AudioClip; } ```` diff --git a/Docs/YooAssetUpdater.md b/Docs/YooAssetUpdater.md index b8101fc..594486f 100644 --- a/Docs/YooAssetUpdater.md +++ b/Docs/YooAssetUpdater.md @@ -9,18 +9,18 @@ ````c# private IEnumerator UpdatePatchManifest() { - int updateResourceVersion = 123; - int timeout = 30; + int updateResourceVersion = 123; + int timeout = 30; UpdateManifestOperation operation = YooAssets.UpdateManifestAsync(updateResourceVersion, timeout); - yield return operation; - - if(operation.Status == EOperationStatus.Succeed) + yield return operation; + + if (operation.Status == EOperationStatus.Succeed) { //更新成功 } else { - //更新失败 + //更新失败 Debug.LogError(operation.Error); } } @@ -41,19 +41,19 @@ private PatchDownloader _downloader; private void CreateDownloader() { string[] tags = { "buildin", "config" }; - int downloadingMaxNum = 10; - int failedTryAgain = 3; - _downloader = YooAssets.CreateDLCDownloader(tags, 10, 3); - if (_downloader.TotalDownloadCount == 0) - { - //没有需要下载的资源 - } - else - { - //需要下载的文件总数和总大小 - int totalDownloadCount = _downloader.TotalDownloadCount; + int downloadingMaxNum = 10; + int failedTryAgain = 3; + _downloader = YooAssets.CreateDLCDownloader(tags, 10, 3); + if (_downloader.TotalDownloadCount == 0) + { + //没有需要下载的资源 + } + else + { + //需要下载的文件总数和总大小 + int totalDownloadCount = _downloader.TotalDownloadCount; long totalDownloadBytes = _downloader.TotalDownloadBytes; - } + } } /// @@ -61,8 +61,8 @@ private void CreateDownloader() /// private void UpdateDownloader() { - if(_downloader != null) - _downloader.Update(); + if (_downloader != null) + _downloader.Update(); } /// @@ -73,19 +73,19 @@ private IEnumerator Download() //注册下载回调 _downloader.OnPatchFileDownloadFailedCallback = OnPatchFileDownloadFailed; _downloader.OnDownloadProgressCallback = OnDownloadProgressUpdate; - _downloader.OnDownloadOverCallback = OnDownloadOver; + _downloader.OnDownloadOverCallback = OnDownloadOver; _downloader.Download(); yield return _downloader; //检测下载结果 if (_downloader.DownloadStates == EDownloaderStates.Succeed) - { - //下载成功 - } - else - { - //下载失败 - } + { + //下载成功 + } + else + { + //下载失败 + } } /// @@ -93,7 +93,7 @@ private IEnumerator Download() /// private void OnPatchFileDownloadFailed(string fileName) { - Debug.LogError($"File download failed : {fileName}"); + Debug.LogError($"File download failed : {fileName}"); } /// diff --git a/README.md b/README.md index 18f5f8d..20e6c60 100644 --- a/README.md +++ b/README.md @@ -31,13 +31,14 @@ YooAsset是一个基于Unity3D引擎的资源管理插件。 支持线上版本快速回退，支持区分审核版本，测试版本，线上版本，支持灰度更新及测试。 ## 入门教程 -**1. 快速开始** -**2. 全局配置** -**3. 资源收集** -**4. 资源打包** -**5. 资源部署** +1. [快速开始](https://github.com/tuyoogame/YooAsset/blob/master/Docs/QuickStart.md) +2. [全局配置](https://github.com/tuyoogame/YooAsset/blob/master/Docs/Settings.md) +3. [资源收集](https://github.com/tuyoogame/YooAsset/blob/master/Docs/AssetCollector.md) +4. [资源打包](https://github.com/tuyoogame/YooAsset/blob/master/Docs/AssetBuilder.md) +5. [资源部署](https://github.com/tuyoogame/YooAsset/blob/master/Docs/AssetDeploy.md) ## 代码教程 -**1. 初始化** -**2. 资源更新** -**3. 资源加载** +1. [初始化](https://github.com/tuyoogame/YooAsset/blob/master/Docs/YooAssetInit.md) +2. [资源更新](https://github.com/tuyoogame/YooAsset/blob/master/Docs/YooAssetUpdater.md) +3. [资源加载](https://github.com/tuyoogame/YooAsset/blob/master/Docs/YooAssetLoader.md) +