Merge pull request #14 from modio/v2048.1.0

Syncing v2048.1.0

Author: johnw-modio

.github/workflows/push-modio-docs.yml

@@ -1,5 +1,4 @@
-#if UNITY_ANDROID || UNITY_IOS
-#if MODIO_IN_APP_PURCHASING
+#if (UNITY_IOS || UNITY_ANDROID) && MODIO_MOBILE_IAP
 using System;
 using System.Collections.Generic;
 using System.Linq;
@@ -111,4 +110,3 @@ public static void QueuePurchase(Product product, Action completeValidation)
     }
 }
 #endif
-#endif

Experimental/modio-ui.unitypackage

@@ -1,6 +1,4 @@
-#if (UNITY_IOS || UNITY_ANDROID)
-#if MODIO_IN_APP_PURCHASING
-
+#if (UNITY_IOS || UNITY_ANDROID) && MODIO_MOBILE_IAP
 using System;
 using System.Collections.Generic;
 using ModIO;
@@ -185,4 +183,3 @@ public void OnPurchaseFailed(Product product, PurchaseFailureDescription failure
     }
 }
 #endif
-#endif

Platform/Mobile/MobilePurchaseHelper.cs

@@ -1,6 +1,4 @@
-#if UNITY_IOS || UNITY_ANDROID
-#if MODIO_IN_APP_PURCHASING
-
+#if (UNITY_IOS || UNITY_ANDROID) && MODIO_MOBILE_IAP
 using System;
 using UnityEngine.Purchasing;
 
@@ -16,4 +14,3 @@ public class PurchaseData
     }
 }
 #endif
-#endif

Platform/Mobile/MobilePurchasingExample.cs

@@ -15,7 +15,7 @@ public static void SetAsPlatform()
             ActivePlatform = new ModioPlatformFacepunch();
         }
 
-        public async void PerformSso(TermsHash? displayedTerms, Action<bool> onComplete, string optionalThirdPartyEmailAddressUsedForAuthentication = null)
+        public async void PerformSso(TermsHash? displayedTerms, Action<Result> onComplete, string optionalThirdPartyEmailAddressUsedForAuthentication = null)
         {
 #if UNITY_FACEPUNCH
 
@@ -25,10 +25,7 @@ public async void PerformSso(TermsHash? displayedTerms, Action<bool> onComplete,
             ModIOUnity.AuthenticateUserViaSteam(base64Ticket,
                 optionalThirdPartyEmailAddressUsedForAuthentication,
                 displayedTerms,
-                result =>
-                {
-                    onComplete(result.Succeeded());
-                });
+                onComplete);
 #endif
         }
 

Platform/Mobile/PurchaseData.cs

@@ -7,7 +7,7 @@ sidebar_position: 0
 ---
 
 <a href="https://mod.io"><img src="https://mod.io/images/branding/modio-logo-bluewhite.svg" alt="mod.io" width="360" align="right"/></a>
-# mod.io Unity Plugin v2024.7.1
+# mod.io Unity Plugin v2024.8
 [![License](https://img.shields.io/badge/license-MIT-brightgreen.svg)](https://github.com/modio/modio-unity/blob/master/LICENSE)
 [![Discord](https://img.shields.io/discord/389039439487434752.svg?label=Discord&logo=discord&color=7289DA&labelColor=2C2F33)](https://discord.mod.io)
 [![Master docs](https://img.shields.io/badge/docs-master-green.svg)](https://docs.mod.io/unity/)
@@ -26,10 +26,17 @@ mod.io enables game developers of all sizes to integrate user-generated content
 The mod.io Unity Engine plugin is the simplest and fastest way to integrate UGC into your Unity **2020.3+** game. It handles all of the common tasks, allowing game developers to quickly and easily implement a solution that enables players to access and discover user-generated content for their games.
 
 A custom built [ready-made UI](#browser-ui) for mod discovery is included, along with installation and collection management, and a full-featured [C# interface](#getting-started) which connects to the [mod.io REST API](https://docs.mod.io).
+> [!WARNING]
+> The Browser UI is scheduled for deprecation, and may not receive updates.
+> This is to be replaced with the [Component UI / Template UI](#component-ui)
 
 ## Platform Support
 To access console platforms and documentation, see [Supporting Console Platforms](https://docs.mod.io/platforms/).
 
+> [!WARNING]
+> To enable Mobile In-App Purchasing you need to define the `MODIO_MOBILE_IAP` in Project Settings > Player > Script Compilation > Scripting Define Symbols
+> This will also require the Unity.Purchasing package to be installed.
+
 | Platform        | Support |
 |-----------------|:-------:|
 | Windows         |    ✓    |
@@ -91,6 +98,9 @@ If you have any questions or need some help join our [Discord](https://discord.m
 The mod.io Unity Engine plugin comes with a prebuilt UI, a drop-in, instant solution for browsing and installing your game's mods.
 
 If you want to skip implementing your own UI, head to the [Browser UI](#browser-ui) section for setup and usage instructions. However, we recommend following the guide below to better understand how the plugin works.
+> [!WARNING]
+> The Browser UI is scheduled for deprecation, and may not receive updates.
+> This is to be replaced with the [Component UI / Template UI](#component-ui)
 
 ## Getting Started
 
@@ -1240,6 +1250,10 @@ namespace ModIO
 
 ## Browser UI
 
+> [!WARNING]
+> The Browser UI is scheduled for deprecation, and may not receive updates.
+> This is to be replaced with the [Component UI / Template UI](#component-ui)
+
 > [!IMPORTANT]  
 > The Browser UI relies on the *config file* that is configured during the [setup instructions](#setup) above. Ensure you have completed all of those steps before proceeding.
 
@@ -1261,6 +1275,13 @@ When a user authenticates, the Browser UI will localize mod.io's terms of use ba
 
 To avoid the plugin conflicting with an existing solution, in the case of right-to-left languages you will need to apply your current implementation for mixed RTL and LTR text to the terms text-elements in the browser. 
 
+## Component UI
+The Component UI is an experimental module that allows for a more easily integrated and customised Mod Browsing UI.
+This can be accessed via the `modio-ui.unitypackage` provided in the plugin in the `experimental` folder.
+A Readme is provided in the package.
+> [!IMPORTANT]
+> This will be replacing the functionality provided by the Browser UI, once the Browser UI is deprecated.
+
 # Marketplace
 The mod.io SDK supports full monetization features, allowing you to sell a per-game virtual currency to your players that they can use to purchase mods, with a share of the revenue split between creators and your studio. Every platform requires specific setup for monetization features to work, with regards to the virtual currency configuration and API calls.
 

Platform/Steam/Facepunch/ModioPlatformFacepunch.cs

@@ -26,6 +26,7 @@ public class SearchFilter
         internal List<string> tags = new List<string>();
         internal List<long> users = new List<long>();
         internal bool showMatureContent = false;
+        internal int platformStatus = 0;    // 0 = null
 
         [SerializeField] internal RevenueType revenueType = RevenueType.Free;
         [SerializeField] internal int stock = Mods_DontShowSoldOut;
@@ -216,6 +217,16 @@ public IReadOnlyList<long> GetUserIds()
             return users;
         }
 
+        /// <summary>
+        /// Adds a specific platform status to the filter to show mods that are either pending
+        /// or both pending and live. This is primarily to be used in QA of mods.
+        /// </summary>
+        /// <param name="status">Platform verified status to show mods of</param>
+        public void AddPlatformStatus(SearchFilterPlatformStatus status)
+        {
+            platformStatus = Convert.ToInt32(status);
+        }
+
         /// <summary>
         /// You can use this method to check if a search filter is setup correctly before using it
         /// in a GetMods request.

README.md

@@ -0,0 +1,18 @@
+namespace ModIO
+{
+    public enum SearchFilterPlatformStatus
+    {
+        PendingOnly = 1,
+        LiveAndPending = 2,
+    }
+
+    internal static class SearchFilterPlatformStatusExtension
+    {
+        public static string GetString(this SearchFilterPlatformStatus status) => status switch
+        {
+            SearchFilterPlatformStatus.PendingOnly => "pending_only",
+            SearchFilterPlatformStatus.LiveAndPending => "live_and_pending",
+            _ => string.Empty,
+        };
+    }
+}

Runtime/Classes/SearchFilter.cs

@@ -132,7 +132,7 @@ async Task<Result> ExtractAll()
                     catch(Exception e)
                     {
                         Logger.Log(LogLevel.Error,
-                            $"Unhandled exception extracting file. MODFILE [{modId}_{fileId}. Exception: {e.Message}");
+                            $"Unhandled exception extracting file. MODFILE [{modId}_{fileId}. \n{e}");
                         cancel = true;
                     }
                 }
@@ -154,7 +154,7 @@ async Task<Result> ExtractAll()
                 catch(Exception e)
                 {
                     Logger.Log(LogLevel.Error,
-                        $"Unhandled exception extracting file. MODFILE [{modId}_{fileId}. Exception: {e.Message}");
+                        $"Unhandled exception extracting file. MODFILE [{modId}_{fileId}. \n{e}");
                     cancel = true;
                 }
             }
@@ -233,7 +233,7 @@ internal async Task<Result> IsThereEnoughSpaceForExtracting()
                     catch(Exception e)
                     {
                         Logger.Log(LogLevel.Error,
-                            $"Unhandled exception trying to read archive's extract size. MODFILE [{modId}_{fileId}. Exception: {e.Message}");
+                            $"Unhandled exception trying to read archive's extract size. MODFILE [{modId}_{fileId}. \n{e}");
                         return ResultBuilder.Create(ResultCode.IO_FileCouldNotBeRead);
                     }
                 }

Runtime/Enums/SearchFilterPlatformStatus.cs

@@ -80,8 +80,8 @@ public static async void SaveRegistry()
             if(!result.Succeeded())
             {
                 Logger.Log(LogLevel.Error,
-                           "ModCollectionManager was unable to save the Registry to disk"
-                           + " because DataStorage.SaveSystemRegistry failed");
+                           $"ModCollectionManager was unable to save the Registry to disk"
+                           + $" because DataStorage.SaveSystemRegistry failed: {result.message}");
             }
         }
 

Runtime/Enums/SearchFilterPlatformStatus.cs.meta

@@ -17,12 +17,10 @@
 using UnityEngine;
 using GameObject = ModIO.Implementation.API.Objects.GameObject;
 
-#if UNITY_IOS || UNITY_ANDROID
-#if MODIO_IN_APP_PURCHASING
+#if (UNITY_IOS || UNITY_ANDROID) && MODIO_MOBILE_IAP
 using Plugins.mod.io.Platform.Mobile;
 using Newtonsoft.Json.Linq;
 #endif
-#endif
 
 namespace ModIO.Implementation
 {
@@ -442,7 +440,7 @@ public static async Task Shutdown(Action shutdownComplete)
                 catch (Exception e)
                 {
                     shuttingDown = false;
-                    Logger.Log(LogLevel.Error, $"Exception caught when shutting down plugin: {e.Message} - inner={e.InnerException?.Message} - stacktrace: {e.StackTrace}");
+                    Logger.Log(LogLevel.Error, $"Exception caught when shutting down plugin: \n{e}");
                 }
 
 
@@ -3418,8 +3416,8 @@ public static async Task<ResultAnd<Entitlement[]>> SyncEntitlements()
 #elif UNITY_STANDALONE && !UNITY_EDITOR
             config = API.Requests.SyncEntitlements.SteamRequest();
             requestTask = WebRequestManager.Request<SyncEntitlements.ResponseSchema>(config);
-#elif (UNITY_ANDROID || UNITY_IOS) && !UNITY_EDITOR
-#if MODIO_IN_APP_PURCHASING
+#elif ((UNITY_ANDROID || UNITY_IOS) && !UNITY_EDITOR) && MODIO_MOBILE_IAP
+
             var purchaseData = MobilePurchaseHelper.GetNextPurchase();
             var walletResponse = await ModIOUnityAsync.GetUserWalletBalance();
             if (!walletResponse.result.Succeeded())
@@ -3431,7 +3429,6 @@ public static async Task<ResultAnd<Entitlement[]>> SyncEntitlements()
                 config = API.Requests.SyncEntitlements.AppleRequest(purchaseData.Payload);
 
             requestTask = WebRequestManager.Request<SyncEntitlements.ResponseSchema>(config);
-#endif
 #else
             return ResultAnd.Create<Entitlement[]>(ResultBuilder.Create(ResultCode.User_NotAuthenticated), null);
 #endif
@@ -3455,10 +3452,8 @@ public static async Task<ResultAnd<Entitlement[]>> SyncEntitlements()
                             entitlements = ResponseTranslator.ConvertEntitlementObjectsToEntitlements(task.value.data);
                             ResponseCache.ReplaceEntitlements(entitlements);
                             ResponseCache.ClearWalletFromCache();
-#if (UNITY_ANDROID || UNITY_IOS) && !UNITY_EDITOR
-#if MODIO_IN_APP_PURCHASING
+#if ((UNITY_ANDROID || UNITY_IOS) && !UNITY_EDITOR) && MODIO_MOBILE_IAP
                             MobilePurchaseHelper.CompleteValidation(entitlements);
-#endif
 #endif
 
                             ModIOUnityEvents.OnUserEntitlementsChanged();

Runtime/ModIO.Implementation/Classes/ExtractOperation.cs

@@ -5,7 +5,7 @@ internal struct ModIOVersion : System.IComparable<ModIOVersion>
     {
         // ---------[ Singleton ]---------
         /// <summary>Singleton instance for current version.</summary>
-        public static readonly ModIOVersion Current = new ModIOVersion(2024, 8, 1, "");
+        public static readonly ModIOVersion Current = new ModIOVersion(2024, 8, 0, "");
 
         // ---------[ Fields ]---------
         /// <summary>Main Version number.</summary>

Runtime/ModIO.Implementation/Classes/ModCollectionManager.cs

@@ -63,9 +63,7 @@ async void AutoRun()
                 catch(Exception e)
                 {
                     Logger.Log(LogLevel.Warning, $"[TQR] Unhandled exception "
-                                                 + $" thrown in AutoRun. Exception: "
-                                                 + $"{e.Message} - Inner Exception: "
-                                                 + $"{e.InnerException?.Message}");
+                                                 + $" thrown in AutoRun. \n{e}");
                 }
             }
             isAutoRunning = false;
@@ -102,8 +100,7 @@ public async Task PerformTasks()
             catch(Exception e)
             {
                 Logger.Log(LogLevel.Warning, $"[TQR] Unhandled exception thrown in "
-                                             + $"PerformTasks operation. Exception: {e.Message}"
-                                             + $" - Inner Exception: {e.InnerException?.Message}");
+                                             + $"PerformTasks operation. \n{e}");
             }
         }
 
@@ -217,9 +214,7 @@ static async Task RunTasksAsync(List<TaskQueueItem> items, bool synchronizedJobs
                     catch(Exception e)
                     {
                         Logger.Log(LogLevel.Warning, $"[TQR] Unhandled exception thrown in"
-                                                     + $" synchronized RunTasksAsync() operation."
-                                                     + $" Exception: {e.Message} - Inner Exception:"
-                                                     + $" {e.InnerException?.Message}");
+                                                     + $" synchronized RunTasksAsync() operation. \n{e}");
                     }
                 }
             }
@@ -246,9 +241,7 @@ static async Task RunTasksAsync(List<TaskQueueItem> items, bool synchronizedJobs
                     catch(Exception e)
                     {
                         Logger.Log(LogLevel.Warning, $"[TQR] Unhandled exception thrown in"
-                                                     + $" non-synchronized RunTasksAsync() operation."
-                                                     + $" Exception: {e.Message} - Inner Exception:"
-                                                     + $" {e.InnerException?.Message}");
+                                                     + $" non-synchronized RunTasksAsync() operation.\n{e}");
                     }
                 }
 

Runtime/ModIO.Implementation/Classes/ModIOUnityImplementation.cs

@@ -600,8 +600,14 @@ static async void ClearWalletFromCacheAfterDelay()
                 cancellationTokenSource.Cancel();
 
             cancellationTokenSource = new CancellationTokenSource();
-            await Task.Delay(modLifetimeInCache, cancellationTokenSource.Token); // 60 second cache
-            wallet = null;
+            try
+            {
+                await Task.Delay(modLifetimeInCache, cancellationTokenSource.Token); // 60 second cache
+                wallet = null;
+            }
+            catch (TaskCanceledException)
+            {
+            }
         }
 
         static async void ClearModsFromCacheAfterDelay(List<ModId> modIds)