diff --git a/Docs/AssetBuilder.md b/Docs/AssetBuilder.md index b0e2f92..5c71213 100644 --- a/Docs/AssetBuilder.md +++ b/Docs/AssetBuilder.md @@ -1,6 +1,6 @@ # 资源构建 -![image](https://github.com/tuyoogame/YooAsset/raw/main/Docs/Image/AssetBuilder-img1.jpg) +![image](https://github.com/tuyoogame/YooAsset/raw/main/Docs/Image/AssetBuilder-img1.png) ### 界面介绍 @@ -20,10 +20,6 @@ 加密服务类列表。 -- **Redundancy Services** - - 冗余服务类列表。 - - **Append Extension** 构建的资源包文件名是否包含后缀格式。 @@ -110,7 +106,6 @@ private static void BuildInternal(BuildTarget buildTarget) buildParameters.CompressOption = ECompressOption.LZ4; buildParameters.AppendFileExtension = false; buildParameters.EncryptionServices = new GameEncryption(); - buildParameters.RedundancyServices = null; buildParameters.IsForceRebuild = true; buildParameters.BuildinTags = "buildin"; diff --git a/Docs/AssetCollector.md b/Docs/AssetCollector.md deleted file mode 100644 index f56cc3d..0000000 --- a/Docs/AssetCollector.md +++ /dev/null @@ -1,77 +0,0 @@ -# 资源收集 - -![image](https://github.com/tuyoogame/YooAsset/raw/main/Docs/Image/AssetCollector-img1.jpg) - -### 界面介绍 - -- **着色器收集** - - 勾选收集所有着色器复选框后，打包系统会自动收集所有依赖的材质球使用的着色器，并将这些着色器打进一个AssetBundle文件内。 - -- **Directory** - - 收集的资源目录，目录下的所有文件将会根据打包规则和过滤规则进行打包。 - -- **PackRule** - - 打包规则，规则可以自定义扩展。下面是内置的打包规则： - - - PackExplicit 目录下的资源文件会各自打进自己的资源包里。 - - - PackDirectory 目录下的资源文件会被打进一个资源包里。 - - - PackRawFile 目录下的资源文件会被处理为原生资源包。 - -````c# -//自定义扩展范例 -public class PackDirectory : IPackRule -{ - string IPackRule.GetAssetBundleLabel(string assetPath) - { - return Path.GetDirectoryName(assetPath); //"Assets/Config/test.txt" --> "Assets/Config" - } -} -```` - -- **FilterRule** - - 过滤规则，规则可以自定义扩展。下面是内置的过滤规则： - - - CollectAll 收集目录下的所有资源文件 - - - CollectScene 只收集目录下的场景文件 - - - CollectPrefab 只收集目录下的预制体文件 - - - CollectSprite 只收集目录下的精灵类型的文件 - -````c# -//自定义扩展范例 -public class CollectScene : IFilterRule -{ - public bool IsCollectAsset(string assetPath) - { - return Path.GetExtension(assetPath) == ".unity"; - } -} -```` - -- **DontWriteAssetPath** - - 资源目录下的资源对象不写入清单 - -- **AssetTags** - - 资源标签列表（多个标签使用分号间隔） - -### 配置表 - -点击Import按钮可以导入外部的XML配置表，配置表规范如下图： - -````xml - - - - -```` - diff --git a/Docs/AssetDebugger.md b/Docs/AssetDebugger.md index 827a952..2700fee 100644 --- a/Docs/AssetDebugger.md +++ b/Docs/AssetDebugger.md @@ -4,7 +4,7 @@ 未来计划支持在编辑器下通过远程调试真机信息。 -注意：该工具仅支持Unity2019+ +**注意**：该工具仅支持Unity2019+ ### 资源对象列表视图 diff --git a/Docs/AssetDeploy.md b/Docs/AssetDeploy.md index 1eac871..c86c100 100644 --- a/Docs/AssetDeploy.md +++ b/Docs/AssetDeploy.md @@ -4,11 +4,23 @@ 如果是本地测试，可以在本地创建一个WEB服务器，然后将补丁包拷贝到WEB服务器下。 +**按照补丁版本目录部署** + ```` CDN └─android - ├─100 补丁包文件夹 - ├─101 补丁包文件夹 - └─102 补丁包文件夹 + ├─100 + ├─101 + └─102 +```` + +**按照游戏版本目录部署** + +```` +CDN +└─android + ├─v1.0 + ├─v1.1 + └─v2.0 ```` diff --git a/Docs/AssetGrouper.md b/Docs/AssetGrouper.md new file mode 100644 index 0000000..54c0d91 --- /dev/null +++ b/Docs/AssetGrouper.md @@ -0,0 +1,93 @@ +# 资源收集 + +![image](https://github.com/tuyoogame/YooAsset/raw/main/Docs/Image/AssetGrouper-img1.png) + +左侧为分组列表，右侧为该分组的配置界面。 + +导出按钮可以将配置数据导出为XML文件，导入按钮可以导入保存的XML文件。 + +#### 着色器收集 + +- Auto Collect Shaders + + 自动收集所有依赖的材质球使用的着色器，并将这些着色器打进一个资源包里。 + +- Shader Bundle Name + + 收集的着色器资源包名称。 + +#### 资源分组 + +- Grouper Name + + 分组名称 + +- Grouper Desc + + 分组备注信息 + +- Asset Tags + + 资源分类标签列表，该分组下收集的资源会全部被打上该标签。 + + 注意：多个标签用分号隔开，例如 level1;level2;level3 + +#### 资源搜集器 + +- **Collect Path** + + 收集路径，可以指定文件夹或单个资源文件。 + +- **PackRule** + + 打包规则，规则可以自定义扩展。下面是内置的打包规则： + + - PackSeparately 以文件路径作为资源包名，每个资源文件单独打包。 + - PackDirectory 以父类文件夹路径作为资源包名，打进一个资源包。 + - PackCollector 以收集器路径作为资源包名，打进一个资源包。 + - PackGrouper 以分组名称作为资源包名，打进一个资源包。 + - PackRawFile 目录下的资源文件会被处理为原生资源包。 + +````c# +//自定义扩展范例 +public class PackDirectory : IPackRule +{ + string IPackRule.GetBundleName(PackRuleData data) + { + return Path.GetDirectoryName(data.AssetPath); //"Assets/Config/test.txt" --> "Assets/Config" + } +} +```` + +- **FilterRule** + + 过滤规则，规则可以自定义扩展。下面是内置的过滤规则： + + - CollectAll 收集目录下的所有资源文件 + + - CollectScene 只收集目录下的场景文件 + + - CollectPrefab 只收集目录下的预制体文件 + + - CollectSprite 只收集目录下的精灵类型的文件 + +````c# +//自定义扩展范例 +public class CollectScene : IFilterRule +{ + public bool IsCollectAsset(FilterRuleData data) + { + return Path.GetExtension(data.AssetPath) == ".unity"; + } +} +```` + +- **NotWriteToAssetList** + + 资源对象不写入资源列表 + +- **AssetTags** + + 资源分类标签列表，该收集器下收集的资源会全部被打上该标签。 + + diff --git a/Docs/AssetReporter.md b/Docs/AssetReporter.md index 22c7628..12403d4 100644 --- a/Docs/AssetReporter.md +++ b/Docs/AssetReporter.md @@ -2,11 +2,11 @@ 报告工具，可以查看概览信息（Summary），资源对象列表信息（AssetView），资源包列表信息（BundleView）。 -注意：该工具仅支持Unity2019+ +**注意**：该工具仅支持Unity2019+ ### 概览视图 -![image](https://github.com/tuyoogame/YooAsset/raw/main/Docs/Image/AssetReporter-img1.jpg) +![image](https://github.com/tuyoogame/YooAsset/raw/main/Docs/Image/AssetReporter-img1.png) ### 资源对象列表视图 diff --git a/Docs/Image/AssetGrouper-img1.png b/Docs/Image/AssetGrouper-img1.png index 805097e..bc248d0 100644 Binary files a/Docs/Image/AssetGrouper-img1.png and b/Docs/Image/AssetGrouper-img1.png differ