Package Update 1.5.0

Author: game-workstore-bot

CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog for com.google.android.appbundle
 
+## [1.5.0] - 2021-06-14
+### New Features
+ - Added a new Bundletool method for building AABs (requires 2018.4+ and .NET 4+)
+ - Added API and UI options to replace OBB files with an install-time asset pack
+ - Added API options for customizing file compression within generated APKs
+ - Changes to support minSdkVersion of 22 in Unity 2021.2
+ - Updated bundletool-all.jar from 1.5.0 to 1.6.1
+### Bug Fixes
+ - Fixed issue #80: prevent building on Unity 2020.2 and early versions of 2020.3 and 2021.1
+ - Fixed issue #106: bundletool build-bundle crashed when output file was specified without a parent directory
+### Other
+ - Removed ability to compile plugin with Unity 5.6, 2017.1, 2017.2, 2017.3, 2018.1, and 2018.2
+ - Require Gradle for all Unity builds
+ - Update minimum Target SDK version to 29
+
 ## [1.4.0] - 2021-03-08
 ### New Features
  - Updated bundletool-all.jar from 1.2.0 to 1.5.0

Editor/Scripts/AndroidAppBundle.cs

@@ -12,18 +12,10 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-// In the Unity 2017 series the EditorUserBuildSettings.buildAppBundle field was introduced in 2017.4.17.
-// It might seem preferable to modify buildAppBundle using reflection, but the field is extern.
-// Instead check for quite a few versions in the 2017.4.17+ series.
-// NOTE: this supports up to UNITY_2017_4_50 and will have to be extended if additional versions are released.
-
-#if UNITY_2018_3_OR_NEWER || UNITY_2017_4_17 || UNITY_2017_4_18 || UNITY_2017_4_19 || UNITY_2017_4_20 || UNITY_2017_4_21 || UNITY_2017_4_22 || UNITY_2017_4_23 || UNITY_2017_4_24 || UNITY_2017_4_25 || UNITY_2017_4_26 || UNITY_2017_4_27 || UNITY_2017_4_28 || UNITY_2017_4_29 || UNITY_2017_4_30 || UNITY_2017_4_31 || UNITY_2017_4_32 || UNITY_2017_4_33 || UNITY_2017_4_34 || UNITY_2017_4_35 || UNITY_2017_4_36 || UNITY_2017_4_37 || UNITY_2017_4_38 || UNITY_2017_4_39 || UNITY_2017_4_40 || UNITY_2017_4_41 || UNITY_2017_4_42 || UNITY_2017_4_43 || UNITY_2017_4_44 || UNITY_2017_4_45 || UNITY_2017_4_46 || UNITY_2017_4_47 || UNITY_2017_4_48 || UNITY_2017_4_49 || UNITY_2017_4_50
-#define GOOGLE_ANDROID_APP_BUNDLE_HAS_NATIVE_SUPPORT
-using UnityEditor;
-#endif
 using System;
 using System.Text.RegularExpressions;
 using Google.Android.AppBundle.Editor.Internal.Utils;
+using UnityEditor;
 
 namespace Google.Android.AppBundle.Editor
 {
@@ -34,10 +26,15 @@ namespace Google.Android.AppBundle.Editor
     public static class AndroidAppBundle
     {
         /// <summary>
-        /// The base module contains the Unity game engine.
+        /// Reserved name for the base module that contains the Unity game engine.
         /// </summary>
         public const string BaseModuleName = "base";
 
+        /// <summary>
+        /// Reserved name for the module that separates the base module's assets into an install-time asset pack.
+        /// </summary>
+        public const string BaseAssetsModuleName = "base_assets";
+
         /// <summary>
         /// Regex used to determine whether a module name is valid.
         /// See https://github.com/google/bundletool/blob/master/src/main/java/com/android/tools/build/bundletool/model/BundleModuleName.java#L38
@@ -46,59 +43,61 @@ public static class AndroidAppBundle
 
         /// <summary>
         /// Returns true if the specified name is a valid Android App Bundle module name, false otherwise.
-        /// The name "base" is reserved for the base module, so also return false in that case.
+        /// Certain names like "base" are reserved, so also return false in those cases.
         /// </summary>
         public static bool IsValidModuleName(string name)
         {
             // TODO(b/131241163): enforce a name length limit if we make it much smaller than 65535.
             return name != null
                    && NameRegex.IsMatch(name)
-                   && !name.Equals(BaseModuleName, StringComparison.OrdinalIgnoreCase);
+                   && CheckReservedName(name, BaseModuleName)
+                   && CheckReservedName(name, BaseAssetsModuleName);
         }
 
         /// <summary>
-        /// Returns true if this version of the Unity Editor has native support for building an Android App Bundle,
-        /// and false otherwise.
+        /// Always returns true. Previously indicated if this version of the Unity Editor has native support for
+        /// building an Android App Bundle.
         /// </summary>
+        // TODO(b/189958664): Needed for 1.x API compatibility. Should be removed with 2.x.
+        [Obsolete("This is always true")]
         public static bool HasNativeBuildSupport()
         {
-#if GOOGLE_ANDROID_APP_BUNDLE_HAS_NATIVE_SUPPORT
             return true;
-#else
-            return false;
-#endif
         }
 
         /// <summary>
         /// Returns EditorUserBuildSettings.buildAppBundle if it is defined and false otherwise.
         /// </summary>
+        // TODO(b/189958664): Needed for 1.x API compatibility. Should be removed with 2.x.
+        [Obsolete("Use EditorUserBuildSettings.buildAppBundle directly instead")]
         public static bool IsNativeBuildEnabled()
         {
-#if GOOGLE_ANDROID_APP_BUNDLE_HAS_NATIVE_SUPPORT
             return EditorUserBuildSettings.buildAppBundle;
-#else
-            return false;
-#endif
         }
 
         /// <summary>
         /// Enable the EditorUserBuildSettings.buildAppBundle field if it is defined.
         /// </summary>
+        // TODO(b/189958664): Needed for 1.x API compatibility. Should be removed with 2.x.
+        [Obsolete("Use EditorUserBuildSettings.buildAppBundle directly instead")]
         public static void EnableNativeBuild()
         {
-#if GOOGLE_ANDROID_APP_BUNDLE_HAS_NATIVE_SUPPORT
             EditorUserBuildSettings.buildAppBundle = true;
-#endif
         }
 
         /// <summary>
         /// Disable the EditorUserBuildSettings.buildAppBundle field if it is defined.
         /// </summary>
+        // TODO(b/189958664): Needed for 1.x API compatibility. Should be removed with 2.x.
+        [Obsolete("Use EditorUserBuildSettings.buildAppBundle directly instead")]
         public static void DisableNativeBuild()
         {
-#if GOOGLE_ANDROID_APP_BUNDLE_HAS_NATIVE_SUPPORT
             EditorUserBuildSettings.buildAppBundle = false;
-#endif
+        }
+
+        private static bool CheckReservedName(string name, string reserved)
+        {
+            return !name.Equals(reserved, StringComparison.OrdinalIgnoreCase);
         }
     }
-}
+}

Editor/Scripts/AndroidBuildException.cs

@@ -0,0 +1,44 @@
+// 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.
+
+#if UNITY_2018_4_OR_NEWER && !NET_LEGACY
+using System;
+
+namespace Google.Android.AppBundle.Editor
+{
+    /// <summary>
+    /// Exception thrown in case of certain Android build failures.
+    /// </summary>
+    public class AndroidBuildException : Exception
+    {
+        internal AndroidBuildException(string errorMessage, AndroidBuildReport androidBuildReport) : base(errorMessage)
+        {
+            AndroidBuildReport = androidBuildReport;
+        }
+
+        internal AndroidBuildException(Exception exception, AndroidBuildReport androidBuildReport)
+            : base(exception.Message, exception)
+        {
+            AndroidBuildReport = androidBuildReport;
+        }
+
+        /// <summary>
+        /// An <see cref="AndroidBuildReport"/> associated with this build failure. Note that the build may fail
+        /// after the Android Player is built but before the AAB is ready; in this case the BuildReport will
+        /// likely indicate a BuildResult of Succeeded since it's reporting the result of calling BuildPlayer().
+        /// </summary>
+        public AndroidBuildReport AndroidBuildReport { get; }
+    }
+}
+#endif

Editor/Scripts/AndroidBuildException.cs.meta

@@ -0,0 +1,68 @@
+// 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 UnityEditor;
+
+namespace Google.Android.AppBundle.Editor
+{
+    /// <summary>
+    /// Options that configure the behavior of an Android build.
+    /// </summary>
+    public class AndroidBuildOptions
+    {
+        /// <summary>
+        /// Constructor.
+        /// </summary>
+        /// <param name="buildPlayerOptions">BuildPlayerOptions required for any build.</param>
+        /// <exception cref="ArgumentException">Thrown if the BuildPlayerOptions build target isn't Android.</exception>
+        public AndroidBuildOptions(BuildPlayerOptions buildPlayerOptions)
+        {
+            if (buildPlayerOptions.target != BuildTarget.Android)
+            {
+                throw new ArgumentException("Unexpected non-Android BuildTarget: " + buildPlayerOptions.target);
+            }
+
+            if (buildPlayerOptions.targetGroup != BuildTargetGroup.Android)
+            {
+                throw new ArgumentException(
+                    "Unexpected non-Android BuildTargetGroup: " + buildPlayerOptions.targetGroup);
+            }
+
+            BuildPlayerOptions = buildPlayerOptions;
+            CompressionOptions = new CompressionOptions();
+        }
+
+        /// <summary>
+        /// The build options passed to BuildPipeline.BuildPlayer(), including scenes and output location.
+        /// </summary>
+        public BuildPlayerOptions BuildPlayerOptions { get; private set; }
+
+        /// <summary>
+        /// Returns the AssetPackConfig to use for the build, or null.
+        /// </summary>
+        public AssetPackConfig AssetPackConfig { get; set; }
+
+        /// <summary>
+        /// Options for overriding the default file compression strategy.
+        /// </summary>
+        public CompressionOptions CompressionOptions { 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; }
+    }
+}

Editor/Scripts/AndroidBuildOptions.cs

@@ -0,0 +1,44 @@
+// 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.
+
+#if UNITY_2018_4_OR_NEWER && !NET_LEGACY
+using UnityEditor.Build.Reporting;
+
+namespace Google.Android.AppBundle.Editor
+{
+    // Note: this class exists (versus using BuildReport directly) so that additional build info can be added later.
+    /// <summary>
+    /// Report containing the results of an Android build.
+    /// </summary>
+    public class AndroidBuildReport
+    {
+        /// <summary>
+        /// Constructor.
+        /// </summary>
+        /// <param name="buildReport">A BuildPlayer() BuildReport.</param>
+        internal AndroidBuildReport(BuildReport buildReport)
+        {
+            Report = buildReport;
+        }
+
+        /// <summary>
+        /// The <see cref="BuildReport"/> generated during the creation of the Android Player. Note that since
+        /// additional processing occurs after the Player is built, some information in this report may not be useful.
+        /// For example, the BuildSummary.outputPath will contain an intermediate output file path, not the final
+        /// AAB output file path.
+        /// </summary>
+        public BuildReport Report { get; }
+    }
+}
+#endif

Editor/Scripts/AndroidBuildOptions.cs.meta

@@ -20,10 +20,20 @@
 namespace Google.Android.AppBundle.Editor
 {
     /// <summary>
-    /// Configuration for all asset packs that will be packaged in an Android App Bundle.
+    /// Configuration for all asset packs that will be packaged in an Android App Bundle (AAB).
     /// </summary>
     public class AssetPackConfig
     {
+        /// <summary>
+        /// Indicates that the assets in an AAB's base module should be split into a separate install-time asset
+        /// pack. Usually when building a game, some assets are stored in the base module's "assets" directory.
+        /// Games that run into APK size limits may have previously used the "Split Application Binary"
+        /// option to create APK Expansion (*.obb) files, however this is unsupported with AABs.
+        /// If Play Console indicates that the base module exceeds a download size limit, for example 150 MB,
+        /// enabling this option may resolve the issue. See https://developer.android.com/guide/app-bundle.
+        /// </summary>
+        public bool SplitBaseModuleAssets;
+
         /// <summary>
         /// Dictionary from asset pack name to <see cref="AssetPack"/> object containing info such as delivery mode.
         /// Note: asset pack names must start with a letter and can contain only letters, numbers, and underscores.
@@ -34,6 +44,7 @@ public class AssetPackConfig
 
         /// <summary>
         /// A dictionary containing the subset of <see cref="AssetPacks"/> that are marked for delivery.
+        /// Note: the returned Dictionary doesn't indicate whether <see cref="SplitBaseModuleAssets"/> is enabled.
         /// </summary>
         public Dictionary<string, AssetPack> DeliveredAssetPacks
         {
@@ -51,6 +62,15 @@ public Dictionary<string, AssetPack> DeliveredAssetPacks
         /// </summary>
         public TextureCompressionFormat DefaultTextureCompressionFormat = TextureCompressionFormat.Default;
 
+        /// <summary>
+        /// Returns true if this configuration includes at least 1 asset pack that may be packaged in an AAB.
+        /// Return true if <see cref="SplitBaseModuleAssets"/> is enabled, even if there are no other asset packs.
+        /// </summary>
+        public bool HasDeliveredAssetPacks()
+        {
+            return SplitBaseModuleAssets || DeliveredAssetPacks.Any();
+        }
+
         /// <summary>
         /// Package the specified AssetBundle file in its own <see cref="AssetPack"/> with the specified delivery mode.
         /// The name of the created asset pack will match that of the specified AssetBundle file.
@@ -192,4 +212,4 @@ private static void CheckAssetPackName(string assetPackName)
             }
         }
     }
-}
+}