Package Update 1.9.0

Author: game-workstore-bot

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog for com.google.android.appbundle
 
+## [1.9.0] - 2023-03-10
+### New Features
+- Added support for device tier targeting of assets
+- Updated bundletool-all.jar from 1.8.2 to 1.14.0
+
 ## [1.8.0] - 2022-07-06
 ### Bug Fixes
 - Fixed issue #172: Unity Cloud Build failure if Android SDK 30+ is not installed

Editor/Scripts/AssetBundleBuilder.cs

@@ -117,6 +117,115 @@ public static Dictionary<string, Dictionary<TextureCompressionFormat, string>> B
                 outputPath, builds, assetBundleOptions, baseTextureFormat, textureSubtargets);
         }
 
+        /// <summary>
+        /// Run one or more AssetBundle builds for the specified device tiers.
+        /// Notes about the <see cref="outputPath"/> parameter:
+        /// - If a relative path is provided, the file paths in the returned AssetPackConfig will be relative paths.
+        /// - If an absolute path is provided, the file paths in the returned object will be absolute paths.
+        /// - AssetBundle builds for device tiers will be created in siblings of this directory. For
+        ///   example, for outputDirectory "a/b/c" and device tier HIGH, there will be a directory "a/b/c#tier_high".
+        /// - If allowClearDirectory is false, this directory and any sibling directories must be empty or not exist,
+        ///   otherwise an exception is thrown.
+        /// </summary>
+        /// <param name="outputPath">The output directory for AssetBundles. See other notes above.</param>
+        /// <param name="deliveryMode">A delivery mode to apply to every asset pack in the generated config.</param>
+        /// <param name="deviceTierToBuilds">A dictionary from Device Tier to asset bundle builds. All device tiers
+        /// should contains the same asset bundle names.</param>
+        /// <param name="defaultDeviceTier">
+        /// Default device tier to be used for standalone APKs. Set to zero if not specified.</param>
+        /// <param name="assetBundleOptions">Options to pass to <see cref="BuildPipeline"/>.</param>
+        /// <param name="allowClearDirectory">Allows this method to clear the contents of the output directory.</param>
+        /// <returns>An <see cref="AssetPackConfig"/> containing file paths to all generated AssetBundles.</returns>
+        public static AssetPackConfig BuildAssetBundlesDeviceTier(
+            string outputPath,
+            AssetPackDeliveryMode deliveryMode,
+            Dictionary<DeviceTier, AssetBundleBuild[]> deviceTierToBuilds,
+            DeviceTier defaultDeviceTier = null,
+            BuildAssetBundleOptions assetBundleOptions = BuildAssetBundleOptions.UncompressedAssetBundle,
+            bool allowClearDirectory = false)
+        {
+            if (defaultDeviceTier == null)
+            {
+                defaultDeviceTier = DeviceTier.From(0);
+            }
+
+            if (!deviceTierToBuilds.Keys.Contains(defaultDeviceTier))
+            {
+                throw new ArgumentException("Default device tier not present in deviceTierToBuilds.");
+            }
+
+            var nameToDeviceTierToPath = BuildAssetBundlesDeviceTier(outputPath, deviceTierToBuilds,
+                assetBundleOptions, allowClearDirectory);
+            var assetPackConfig = new AssetPackConfig();
+            foreach (var deviceTierToPath in nameToDeviceTierToPath.Values)
+            {
+                assetPackConfig.AddAssetBundles(deviceTierToPath, deliveryMode);
+            }
+
+            assetPackConfig.DefaultDeviceTier = defaultDeviceTier;
+            return assetPackConfig;
+        }
+
+        /// <summary>
+        /// Run one or more AssetBundle builds for each device tier.
+        /// </summary>
+        /// <param name="outputPath">The output directory for base AssetBundles. See the other method for notes.</param>
+        /// <param name="deviceTierToBuilds">A dictionary from Device Tier to asset bundle builds. All device tiers
+        /// should contains the same asset bundle names.</param>
+        /// <param name="assetBundleOptions">Options to pass to <see cref="BuildPipeline"/>.</param>
+        /// <param name="allowClearDirectory">Allows this method to clear the contents of the output directory.</param>
+        /// <returns>A dictionary from AssetBundle name to DeviceTier to file outputPath.</returns>
+        public static Dictionary<string, Dictionary<DeviceTier, string>> BuildAssetBundlesDeviceTier(
+            string outputPath, Dictionary<DeviceTier, AssetBundleBuild[]> deviceTierToBuilds,
+            BuildAssetBundleOptions assetBundleOptions,
+            bool allowClearDirectory)
+        {
+            if (deviceTierToBuilds == null || deviceTierToBuilds.Count == 0)
+            {
+                throw new ArgumentException("DeviceTierToBuild parameter cannot be null or empty");
+            }
+
+            if (deviceTierToBuilds.Values.Any(builds => builds == null || builds.Length == 0))
+            {
+                throw new ArgumentException("AssetBundleBuilds value cannot be null or empty");
+            }
+
+            var assetBundleNames = deviceTierToBuilds.Values.First().Select(build => build.assetBundleName).ToList();
+
+            if (deviceTierToBuilds.Values.Any(builds =>
+                    !(builds.Length == assetBundleNames.Count() &&
+                      builds.Select(build => build.assetBundleName).Except(assetBundleNames).ToList().Count == 0)))
+            {
+                throw new ArgumentException("AssetBundleBuild names cannot differ across device tiers.");
+            }
+
+            foreach (var assetBundleName in assetBundleNames)
+            {
+                if (!AndroidAppBundle.IsValidModuleName(assetBundleName))
+                {
+                    throw new ArgumentException("Invalid AssetBundle name: " + assetBundleName);
+                }
+            }
+
+            if (string.IsNullOrEmpty(outputPath))
+            {
+                throw new ArgumentNullException("outputPath");
+            }
+
+            CheckDirectory(outputPath, allowClearDirectory);
+
+            var tiers = new HashSet<DeviceTier>(deviceTierToBuilds.Keys);
+            var paths = tiers.Select(tier => outputPath + DeviceTierTargetingTools.GetTargetingSuffix(tier));
+            foreach (var path in paths)
+            {
+                CheckDirectory(path, allowClearDirectory);
+            }
+
+            return BuildAssetBundlesDeviceTierInternal(
+                outputPath, assetBundleOptions, deviceTierToBuilds, assetBundleNames);
+        }
+
+
         // The internal method assumes all parameter preconditions have already been checked.
         private static Dictionary<string, Dictionary<TextureCompressionFormat, string>> BuildAssetBundlesInternal(
             string outputPath, AssetBundleBuild[] builds, BuildAssetBundleOptions assetBundleOptions,
@@ -157,6 +266,45 @@ private static Dictionary<string, Dictionary<TextureCompressionFormat, string>>
             }
         }
 
+        private static Dictionary<string, Dictionary<DeviceTier, string>> BuildAssetBundlesDeviceTierInternal(
+            string outputPath, BuildAssetBundleOptions assetBundleOptions,
+            Dictionary<DeviceTier, AssetBundleBuild[]> deviceTierToBuilds, IEnumerable<string> assetBundleNames)
+        {
+            // Use a dictionary to capture the generated AssetBundles' file names.
+            var nameToDeviceTierToPath = assetBundleNames.ToDictionary(
+                bundleName => bundleName, _ => new Dictionary<DeviceTier, string>());
+            foreach (var deviceTier in deviceTierToBuilds.Keys)
+            {
+                var tierBuilds = deviceTierToBuilds[deviceTier];
+                // Build AssetBundles in the the base format's directory.
+                BuildAssetBundles(outputPath, tierBuilds, assetBundleOptions);
+
+                // Then move the files to a new directory with the device tier suffix.
+                var outputPathWithSuffix = outputPath + DeviceTierTargetingTools.GetTargetingSuffix(deviceTier);
+                Directory.Move(outputPath, outputPathWithSuffix);
+
+                UpdateDictionaryDeviceTier(nameToDeviceTierToPath, outputPathWithSuffix, deviceTier);
+            }
+
+            return nameToDeviceTierToPath;
+        }
+
+        private static void UpdateDictionaryDeviceTier(
+            Dictionary<string, Dictionary<DeviceTier, string>> nameToDeviceTierToPath,
+            string outputPath, DeviceTier deviceTier)
+        {
+            foreach (var entry in nameToDeviceTierToPath)
+            {
+                var filePath = Path.Combine(outputPath, entry.Key);
+                entry.Value[deviceTier] = filePath;
+                if (!File.Exists(filePath))
+                {
+                    throw new InvalidOperationException(string.Format("Missing AssetBundle file: " + filePath));
+                }
+            }
+        }
+
+
         private static void BuildAssetBundles(
             string outputPath, AssetBundleBuild[] builds, BuildAssetBundleOptions assetBundleOptions)
         {
@@ -226,4 +374,4 @@ private static void CheckDirectory(string path, bool allowClearDirectory)
             directoryInfo.Delete( /* recursive= */ true);
         }
     }
-}
+}

Editor/Scripts/AssetOnlyBuildOptions.cs

@@ -0,0 +1,71 @@
+// Copyright 2021 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     https://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+using System;
+using System.Collections.Generic;
+
+namespace Google.Android.AppBundle.Editor
+{
+    /// <summary>
+    /// Options that configure the behavior of an asset-only app bundle build.
+    /// </summary>
+    public class AssetOnlyBuildOptions
+    {
+        /// <summary>
+        /// Constructor.
+        /// </summary>
+        /// <param name="assetPackConfig">AssetPackConfig specifying which asset packs to include in the build.</param>>
+        /// <exception cref="ArgumentException">Thrown if the AssetPackConfig contains install-time packs.</exception>
+        public AssetOnlyBuildOptions(AssetPackConfig assetPackConfig)
+        {
+            foreach (var keyValue in assetPackConfig.AssetPacks)
+            {
+                var deliveryMode = keyValue.Value.DeliveryMode;
+                if (deliveryMode == AssetPackDeliveryMode.InstallTime)
+                {
+                    throw new ArgumentException(
+                        "AssetPackConfig contains install-time asset packs which are not supported in asset-only app bundles.");
+                }
+            }
+
+            AssetPackConfig = assetPackConfig;
+        }
+
+        /// <summary>
+        /// Returns the AssetPackConfig to use for the build, or null.
+        /// </summary>
+        public AssetPackConfig AssetPackConfig { get; private set; }
+
+        /// <summary>
+        /// The version codes identifying which app versions should be served these asset packs.
+        /// </summary>
+        public IList<long> AppVersions { get; set; }
+
+        /// <summary>
+        /// A string that uniquely identifies this asset-only bundle.
+        /// </summary>
+        public string AssetVersionTag { get; set; }
+
+        /// <summary>
+        /// The path where the asset only bundle will be built. 
+        /// </summary>
+        public string LocationPathName { get; set; }
+
+        /// <summary>
+        /// If true, forces the entire build to run on the main thread, potentially freezing the Editor UI during some
+        /// build steps. This setting doesn't affect batch mode builds, which always run on the main thread.
+        /// </summary>
+        public bool ForceSingleThreadedBuild { get; set; }
+    }
+}