Merge branch 'release/v0.2.0' into main

Author: HarrisonHough

.github/CODEOWNERS

@@ -0,0 +1,6 @@
+# These owners will be the default owners for everything in
+# the repo. Unless a later match takes precedence,
+# @HarrisonHough, @rYuuk and @srcnalt will be requested for
+# review when someone opens a pull request.
+*       @HarrisonHough @rYuuk @srcnalt
+

.github/latest.md

@@ -0,0 +1,14 @@
+This update fixes a number of bugs and adds support for optional SDK logging.
+
+## Changelog
+
+### Added
+- optional sdk logging
+- don't ask again option for update check
+
+### Updated
+- PartnerSubdomainSettings refactored to a CoreSettings scriptable object
+
+### Fixed
+- core settings asset now automatically created if it is missing.
+- Various bug fixes and improvements

.github/workflows/auto-release-action.yml

@@ -0,0 +1,19 @@
+name: Automatic Release
+
+on: 
+  push:
+    tags:
+    - 'v*'
+
+jobs:
+
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ncipollo/release-action@v1
+      with:
+        name: "Ready Player Me Unity SDK: Core ${{github.ref_name}}"
+        bodyFile: ".github/latest.md"

CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [0.2.0] - 2023.02.08
+
+### Added
+- optional sdk logging
+
+### Updated
+- PartnerSubdomainSettings refactored to a CoreSettings scriptable object
+
+### Fixed
+- Various bug fixes and improvements
+
 ## [0.1.0] - 2023.01.22
 
 ### Updated

Editor/Module Management/ModuleList.cs

@@ -14,7 +14,7 @@ public static class ModuleList
             name = "com.readyplayerme.core",
             gitUrl = "https://github.com/readyplayerme/rpm-unity-sdk-core.git",
             branch = "",
-            version = "0.1.1"
+            version = "0.2.0"
         };
 
         /// <summary>
@@ -34,14 +34,14 @@ public static class ModuleList
                 name = "com.readyplayerme.avatarloader",
                 gitUrl = "https://github.com/readyplayerme/rpm-unity-sdk-avatar-loader.git",
                 branch = "",
-                version = "0.1.1"
+                version = "0.2.0"
             },
             new ModuleInfo
             {
                 name = "com.readyplayerme.webview",
                 gitUrl = "https://github.com/readyplayerme/rpm-unity-sdk-webview.git",
                 branch = "",
-                version = "0.1.0"
+                version = "0.2.0"
             }
         };
 

Editor/Module Management/ModuleUpdater.cs

@@ -1,56 +1,86 @@
 using System;
 using System.Linq;
-using UnityEditor;
-using UnityEngine;
-using Newtonsoft.Json;
 using System.Threading;
-using UnityEngine.Networking;
 using System.Threading.Tasks;
+using Newtonsoft.Json;
+using UnityEditor;
 using UnityEditor.PackageManager;
-using UnityEditor.PackageManager.Requests;
+using UnityEngine;
+using UnityEngine.Networking;
 using PackageInfo = UnityEditor.PackageManager.PackageInfo;
 
 namespace ReadyPlayerMe.Core.Editor
 {
     /// <summary>
-    ///     Class <c>ModuleUpdater</c> is responsible for checking and updating the Ready Player Me SDK modules.
+    /// It is responsible for checking and updating the Ready Player Me SDK modules.
     /// </summary>
-    public static class ModuleUpdater
+    [InitializeOnLoad]
+    public class ModuleUpdater
     {
+        private class Release
+        {
+            [JsonProperty("tag_name")]
+            public string Tag;
+        }
+
         private const string PACKAGE_JSON = "package.json";
         private const string PACKAGE_DOMAIN = "com.readyplayerme";
 
         private const string GITHUB_WEBSITE = "https://github.com";
         private const string GITHUB_API_URL = "https://api.github.com/repos";
 
-        private const string WARNING_PACKAGES_NOT_FOUND = "No Ready Player Me packages found.";
-        private const string WARNING_UPDATE_SKIPPED = "No Ready Player Me packages found.";
         private const int MILLISECONDS_TIMEOUT = 20;
         private const string ASSET_FILTER = "package";
 
+        private const string DONT_ASK = "Dont Ask";
+
+        static ModuleUpdater()
+        {
+            EntryPoint.Startup += () => Check(true);
+        }
+
         /// <summary>
-        ///     Check for Ready Player Me package updates.
+        /// Check for Ready Player Me package updates.
         /// </summary>
         [MenuItem("Ready Player Me/Check For Updates")]
         public static void CheckForUpdates()
+        {
+            Check();
+        }
+
+        private static void Check(bool isStartup = false)
         {
             // Get PackageInfo array from RPM Module package.json files
-            PackageInfo[] packages = AssetDatabase.FindAssets(ASSET_FILTER)
+            var packages = AssetDatabase.FindAssets(ASSET_FILTER)
                 .Select(AssetDatabase.GUIDToAssetPath)
                 .Where(x => x.Contains(PACKAGE_JSON) && x.Contains(PACKAGE_DOMAIN))
                 .Select(PackageInfo.FindForAssetPath)
                 .ToArray();
 
+            if (packages.Length == 0)
+            {
+                Debug.Log("No rpm package found");
+            }
+
             // Turn package_name@repo_url#branch_name into https://api.github.com/repos/readyplayerme/repo_name/releases 
-            foreach (PackageInfo package in packages)
+            foreach (var package in packages)
             {
                 var repoUrl = package.packageId.Split('@')[1];
-                var releasesUrl = repoUrl.Replace(GITHUB_WEBSITE, GITHUB_API_URL)
-                    .Split(new[] { ".git#" }, StringSplitOptions.None)[0] + "/releases";
+                var releasesUrl = repoUrl
+                    .Split(new[] { ".git" }, StringSplitOptions.None)[0] 
+                    .Replace(GITHUB_WEBSITE, GITHUB_API_URL) + "/releases";
+                
+                
                 var packageUrl = repoUrl.Split('#')[0];
 
                 // Experimental or prerelease packages might look like 0.1.0-exp.1, remove after dash to parse with Version
                 var version = package.version.Split('-')[0];
+
+                if (isStartup && EditorPrefs.GetBool(DONT_ASK + "-" + package.name))
+                {
+                    continue;
+                }
+
                 FetchReleases(package.name, packageUrl, releasesUrl, new Version(version));
             }
         }
@@ -65,18 +95,17 @@ public static void CheckForUpdates()
         private static async void FetchReleases(string packageName, string packageUrl, string releasesUrl,
             Version currentVersion)
         {
-            UnityWebRequest request = UnityWebRequest.Get(releasesUrl);
-            UnityWebRequestAsyncOperation op = request.SendWebRequest();
+            var request = UnityWebRequest.Get(releasesUrl);
+            var op = request.SendWebRequest();
             while (!op.isDone) await Task.Yield();
 
             if (request.result == UnityWebRequest.Result.Success)
             {
                 var response = request.downloadHandler.text;
-                Release[] releases = JsonConvert.DeserializeObject<Release[]>(response);
-
-                Version[] versions = releases.Select(r => new Version(r.Tag.Substring(1).Split('-')[0])).ToArray();
+                var releases = JsonConvert.DeserializeObject<Release[]>(response);
+                var versions = releases!.Select(r => new Version(r.Tag.Substring(1).Split('-')[0])).ToArray();
 
-                Version latestVersion = versions.Max();
+                var latestVersion = versions.Max();
 
                 if (latestVersion > currentVersion)
                 {
@@ -99,20 +128,27 @@ private static async void FetchReleases(string packageName, string packageUrl, s
         private static void DisplayUpdateDialog(string packageName, Version currentVersion, Version latestVersion,
             string packageUrl)
         {
-            var shouldUpdate = EditorUtility.DisplayDialog("Update Packages",
+            var shouldUpdate = EditorUtility.DisplayDialogComplex("Update Packages",
                 $"New update available for {packageName}\nCurrent version: {currentVersion}\nLatest version: {latestVersion}",
                 "Update",
-                "Skip");
+                "Cancel",
+                "Don't ask");
 
-            if (shouldUpdate)
-            {
-                packageUrl += "#v" + latestVersion;
-                UpdateModule(packageName, packageUrl, currentVersion, latestVersion);
-            }
-            else
+            switch (shouldUpdate)
             {
-                // TODO: Bring analytics here
-                Debug.LogWarning(WARNING_UPDATE_SKIPPED);
+                // Update
+                case 0:
+                    packageUrl += "#v" + latestVersion;
+                    UpdateModule(packageName, packageUrl, currentVersion, latestVersion);
+                    break;
+                // Cancel
+                case 1:
+                    // Do nothing
+                    break;
+                // Don't ask
+                case 2:
+                    EditorPrefs.SetBool(DONT_ASK + "-" + packageName, true);
+                    break;
             }
         }
 
@@ -125,19 +161,13 @@ private static void DisplayUpdateDialog(string packageName, Version currentVersi
         /// <param name="latest">The new version of the package.</param>
         private static void UpdateModule(string name, string url, Version current, Version latest)
         {
-            RemoveRequest removeRequest = Client.Remove(name);
+            var removeRequest = Client.Remove(name);
             while (!removeRequest.IsCompleted) Thread.Sleep(MILLISECONDS_TIMEOUT);
 
-            AddRequest addRequest = Client.Add(url);
+            var addRequest = Client.Add(url);
             while (!addRequest.IsCompleted) Thread.Sleep(MILLISECONDS_TIMEOUT);
 
             Debug.Log($"Updated {name} from v{current} to v{latest}");
         }
     }
-
-    internal class Release
-    {
-        [JsonProperty("tag_name")] 
-        public string Tag;
-    }
 }

Editor/Utils/EditorAssetGenerator.cs

@@ -7,21 +7,21 @@ namespace ReadyPlayerMe.Core.Editor
     public static class EditorAssetGenerator
     {
         private const string SETTINGS_SAVE_FOLDER = "Ready Player Me/Resources/Settings";
-        private const string PARTNER_SUB_DOMAIN_ASSET_NAME = "PartnerSubdomainSettings.asset";
+        private const string CORE_SETTINGS_ASSET_NAME = "CoreSettings.asset";
 
         public static void CreateSettingsAssets()
         {
             DirectoryUtility.ValidateDirectory($"{Application.dataPath}/{SETTINGS_SAVE_FOLDER}");
             AssetDatabase.Refresh();
-            CreatePartnerSubdomainSetting();
+            CreateCoreSettings();
         }
 
-        private static void CreatePartnerSubdomainSetting()
+        private static void CreateCoreSettings()
         {
-            var partnerSubdomainSettings = ScriptableObject.CreateInstance<PartnerSubdomainSettings>();
-            partnerSubdomainSettings.Subdomain = "demo";
+            var coreSettings = ScriptableObject.CreateInstance<CoreSettings>();
+            coreSettings.Subdomain = "demo";
 
-            AssetDatabase.CreateAsset(partnerSubdomainSettings, $"Assets/{SETTINGS_SAVE_FOLDER}/{PARTNER_SUB_DOMAIN_ASSET_NAME}");
+            AssetDatabase.CreateAsset(coreSettings, $"Assets/{SETTINGS_SAVE_FOLDER}/{CORE_SETTINGS_ASSET_NAME}");
             AssetDatabase.SaveAssets();
             AssetDatabase.Refresh();
         }

LICENSE.md

@@ -1,21 +1,25 @@
-MIT License
+The MIT License (MIT)
+=====================
 
-Copyright (c) 2022 Ready Player Me
+Copyright © 2022 Ready Player Me
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the “Software”), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

Runtime/ApplicationData.cs

@@ -14,7 +14,7 @@ public static class ApplicationData
         static ApplicationData()
         {
             Data.SDKVersion = SDK_VERSION;
-            Data.PartnerName = CoreSettings.PartnerSubdomainSettings.Subdomain;
+            Data.PartnerName = CoreSettingsHandler.CoreSettings.Subdomain;
             Data.UnityVersion = Application.unityVersion;
             Data.UnityPlatform = Application.platform.ToString();
             Data.RenderPipeline = GetRenderPipeline();