Merge branch 'master' into 2022.1-urp

Author: JohannesDeml

.github/workflows/release.yml

@@ -15,7 +15,7 @@ jobs:
       TAG: ${{ steps.set_tag.outputs.VERSION }}
       BUILD_NAME: ${{ steps.set_build_name.outputs.VERSION }}
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
           lfs: true
@@ -55,7 +55,7 @@ jobs:
 
       - name: Version missmatch ❌
         if: ${{ !startsWith(needs.variables.outputs.TAG, needs.variables.outputs.UNITY_VERSION) }}
-        uses: actions/github-script@v3
+        uses: actions/github-script@v4
         with:
           script: |
               core.setFailed('Unity version does not match tag version')
@@ -69,7 +69,7 @@ jobs:
     strategy:
       fail-fast: false
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
           lfs: true
@@ -92,9 +92,11 @@ jobs:
           restore-keys: Library-201x-
 
       - name: Build project
-        uses: game-ci/unity-builder@v2
+        uses: game-ci/unity-builder@v4
         env:
           UNITY_LICENSE: ${{ secrets.UNITY_LICENSE }}
+          UNITY_EMAIL: ${{ secrets.UNITY_EMAIL }}
+          UNITY_PASSWORD: ${{ secrets.UNITY_PASSWORD }}
         with:
           buildMethod: UnityBuilderAction.BuildScript.BuildWithCommandlineArgs
           customParameters: -tag ${{ needs.variables.outputs.TAG }}
@@ -136,7 +138,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - uses: actions/download-artifact@v3
         with:

.github/workflows/upgrade-unity.yml

@@ -6,24 +6,24 @@ on:
   workflow_dispatch:
     inputs:
       unityVersion:
-        description: 'Unity Version'
+        description: 'Unity version'
         required: true
         type: string
       createTags:
         description: 'Create Tags'
         required: false
         type: boolean
         default: true
-      urp:
-        description: 'URP branch'
-        required: true
-        type: boolean
-        default: false
       tagsOnly:
         description: 'Only create tags'
         required: true
         type: boolean
         default: false
+      mergeMaster:
+        description: 'Merge master into branch'
+        required: true
+        type: boolean
+        default: true
       customParameters:
         description: 'Custom cli arguments'
         required: false
@@ -39,24 +39,51 @@ jobs:
     steps:
       - name: Log input parameter
         run: |
-          echo "Upgrading to Unity Version: $UNITY_VERSION"
+          BRANCH_NAME=${GITHUB_REF#refs/heads/}
+
+          echo "Branch: $BRANCH_NAME"
+          echo "Unity version: $UNITY_VERSION"
           echo "Create tags: $CREATE_TAGS"
-          echo "URP branch: $URP_BRANCH"
+          echo "Only create tags: $TAGS_ONLY"
+          echo "Merge master into branch: $MERGE_MASTER"
           echo "Custom cli arguments: $CUSTOM_PARAMETERS"
+          if [[ "$BRANCH_NAME" == *"urp"* ]]
+          then
+            echo "urp: true"
+          else
+            echo "urp: false"
+          fi
         env:
           UNITY_VERSION: ${{ inputs.unityVersion }}
           CREATE_TAGS: ${{ inputs.createTags }}
-          URP_BRANCH: ${{ inputs.urp }}
           TAGS_ONLY: ${{ inputs.tagsOnly }}
+          MERGE_MASTER: ${{ inputs.mergeMaster }}
           CUSTOM_PARAMETERS: ${{ inputs.customParameters }}
 
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
           lfs: true
           # Makes sure, that pushing new tags will trigger workflows
           token: ${{ secrets.PR_GITHUB_TOKEN }}
 
+      - name: Set git user
+        run: |
+          git status
+          git config --global user.email "$GIT_USER@users.noreply.github.com"
+          git config --global user.name "$GIT_USER"
+        env:
+          GIT_USER: ${{ github.actor }}
+
+      # Make sure the branch has the latest master changes in
+      - name: Merge master into current branch
+        if: ${{ inputs.mergeMaster }}
+        run: |
+          git fetch origin master
+          git merge FETCH_HEAD
+          git push
+          git log -1
+
       # Unity 2020 cache is not compatible with older versions
       - name: Unity Library Cache 2020 or higher
         if: ${{ !startsWith(inputs.unityVersion, '201') }}
@@ -83,15 +110,15 @@ jobs:
       - name: Set upgrade name
         id: upgrade_name
         run: |
-          if [[ "$URP_BRANCH" == "true" ]]
+          BRANCH_NAME=${GITHUB_REF#refs/heads/}
+          if [[ "$BRANCH_NAME" == *"urp"* ]]
           then
             echo "NAME=$UNITY_VERSION-urp" >> $GITHUB_OUTPUT
           else
             echo "NAME=$UNITY_VERSION" >> $GITHUB_OUTPUT
           fi
         env:
           UNITY_VERSION: ${{ inputs.unityVersion }}
-          URP_BRANCH: ${{ inputs.urp }}
 
       - name: Log variables
         run: |
@@ -100,29 +127,24 @@ jobs:
 
       - name: Build project
         if: ${{ !inputs.tagsOnly }}
-        uses: JohannesDeml/unity-builder@no-quit-parameter
+        uses: game-ci/unity-builder@v4
         env:
           UNITY_LICENSE: ${{ secrets.UNITY_LICENSE }}
+          UNITY_EMAIL: ${{ secrets.UNITY_EMAIL }}
+          UNITY_PASSWORD: ${{ secrets.UNITY_PASSWORD }}
         with:
           buildMethod: UnityBuilderAction.UnityPackageScripts.UpgradeAllPackagesToVerifiedVersion
           customParameters: ${{ inputs.customParameters }}
           unityVersion: ${{ inputs.unityVersion }}
           targetPlatform: WebGL
           buildName: ${{ needs.variables.outputs.BUILD_NAME }}
           allowDirtyBuild: true
+          manualExit: true
 
       - name: Delete build folder with elevated rights
         if: ${{ !inputs.tagsOnly }}
         run: sudo rm -rf ./build
 
-      - name: Set git user
-        run: |
-          git status
-          git config --global user.email "$GIT_USER@users.noreply.github.com"
-          git config --global user.name "$GIT_USER"
-        env:
-          GIT_USER: ${{ github.actor }}
-
       - name: Render template
         if: ${{ !inputs.tagsOnly }}
         id: template
@@ -146,22 +168,30 @@ jobs:
       - name: Add tags
         if: ${{ inputs.createTags || inputs.tagsOnly }}
         run: |
-          if [[ "$URP_BRANCH" == "true" ]]
+          # Extract the first four characters of UNITY_VERSION
+          UNITY_YEAR=${UNITY_VERSION:0:4}
+          BRANCH_NAME=${GITHUB_REF#refs/heads/}
+
+          TAG_PREFIX=$UNITY_VERSION
+          if [[ "$BRANCH_NAME" == *"urp"* ]]
+          then
+            TAG_PREFIX=$UNITY_VERSION-urp
+          fi
+
+          if [[ "$UNITY_YEAR" < "2023" ]]
           then
-            git tag -a -f $UNITY_VERSION-urp-webgl1 -m "[Automated workflow] Created by upgrade-unity"
-            git tag -a -f $UNITY_VERSION-urp-webgl2 -m "[Automated workflow] Created by upgrade-unity"
-            git tag -a -f $UNITY_VERSION-urp-webgl2-debug -m "[Automated workflow] Created by upgrade-unity"
+            git tag -a -f $TAG_PREFIX-minsize-webgl1 -m "[Automated workflow] Created by upgrade-unity"
+            git tag -a -f $TAG_PREFIX-webgl1 -m "[Automated workflow] Created by upgrade-unity"
           else
-            git tag -a -f $UNITY_VERSION-minsize-webgl1 -m "[Automated workflow] Created by upgrade-unity"
-            git tag -a -f $UNITY_VERSION-webgl1 -m "[Automated workflow] Created by upgrade-unity"
-            git tag -a -f $UNITY_VERSION-webgl2 -m "[Automated workflow] Created by upgrade-unity"
-            # Push tags in between - pushing more than 3 tags won't trigger tag workflows
-            git push origin -f --tags
-            git tag -a -f $UNITY_VERSION-webgl2-debug -m "[Automated workflow] Created by upgrade-unity"
+            git tag -a -f $TAG_PREFIX-minsize-webgl2 -m "[Automated workflow] Created by upgrade-unity"
           fi
+          # Push tags in between - pushing more than 3 tags won't trigger tag workflows
+          git push origin -f --tags
+
+          git tag -a -f $TAG_PREFIX-webgl2 -m "[Automated workflow] Created by upgrade-unity"
+          git tag -a -f $TAG_PREFIX-webgl2-debug -m "[Automated workflow] Created by upgrade-unity"
 
           git push origin -f --tags
         env:
           UNITY_VERSION: ${{ inputs.unityVersion }}
-          URP_BRANCH: ${{ inputs.urp }}
 

Assets/Plugins/WebGL/WebGLTools/WebGlBridge.Commands.cs

@@ -123,15 +123,27 @@ public void ToggleInfoPanel()
 		}
 
 		/// <summary>
-		/// Log example messages to see if they are rendered and colored correctly
+		/// Log the user agent of the browser and if this agent is classified as mobile
+		/// Browser Usage: <code>unityGame.SendMessage("WebGL", "LogUserAgent");</code>
+		/// </summary>
+		[WebGlCommand(Description = "Log User Agent and isMobileDevice")]
+		public void LogUserAgent()
+		{
+			string userAgent = WebGlPlugins.GetUserAgent();
+			bool isMobileDevice = WebGlPlugins.IsMobileDevice();
+			Debug.Log($"<color=#4D65A4>User Agent:</color> '{userAgent}', <color=#4D65A4>IsMobileDevice:</color> '{isMobileDevice}'");
+		}
+
+		/// <summary>
+		/// Log example messages to show off unity rich text parsing to html & console styling
 		/// </summary>
 		[WebGlCommand(Description = "Log example messages for Log, warning and error")]
 		[ContextMenu(nameof(LogExampleMessages))]
 		public void LogExampleMessages()
 		{
-			Debug.Log("This is an example <color=#2596be>log</color> message, showing off <color=#ff00ff>rich text support with <color=#ff0000>[nesting (I should be red - not supported yet)]</color></color>!");
-			Debug.LogWarning("This is an example <color=#e28743>warning</color> message!");
-			Debug.LogError("This is an example <color=#d36a33>error</color> message!");
+			Debug.Log("Example unity rich text example with <color=red>red and <color=blue>nested blue</color> color tags</color> and <b>bold</b> + <i>italic</i> tags, and <size=20>custom size with <b><i>bold italic nesting</i></b></size> tag.");
+			Debug.LogWarning("This is an <b>example <color=#e28743>warning</color></b> message!");
+			Debug.LogError("This is an <b>example <color=#b50808>error</color></b> message!");
 		}
 
 		/// <summary>

Assets/Plugins/WebGL/WebGLTools/WebGlPlugins.cs

@@ -29,6 +29,8 @@ public static class WebGlPlugins
 		[DllImport("__Internal")]
 		private static extern void _HideInfoPanel();
 		[DllImport("__Internal")]
+		private static extern string _GetUserAgent();
+		[DllImport("__Internal")]
 		private static extern uint _GetTotalMemorySize();
 		[DllImport("__Internal")]
 		private static extern uint _GetStaticMemorySize();
@@ -51,7 +53,7 @@ public static void SetVariable(string variableName, string value)
 			#endif
 			Debug.Log($"<color=#00CCCC>{nameof(WebGlPlugins)}.{nameof(SetVariable)} set {variableName}: {value}</color>");
 		}
-		
+
 		/// <summary>
 		/// Adds a time marker at the call time to the javascript map "unityTimeTrackers"
 		/// The mapped value is performance.now() at the time of the call
@@ -65,7 +67,7 @@ public static void AddTimeTrackingEvent(string eventName)
 			Debug.Log($"{nameof(WebGlPlugins)}.{nameof(AddTimeTrackingEvent)} called with {eventName}");
 			#endif
 		}
-		
+
 		/// <summary>
 		/// Show the info panel in the top right corner
 		/// By default triggered by <see cref="WebGlTimeTracker"/> in Awake
@@ -80,7 +82,7 @@ public static void ShowInfoPanel()
 			Debug.Log($"{nameof(WebGlPlugins)}.{nameof(ShowInfoPanel)} called");
 			#endif
 		}
-		
+
 		/// <summary>
 		/// Hide the info panel in the top right corner
 		/// By default triggered by <see cref="WebGlTimeTracker"/> in Awake
@@ -111,6 +113,33 @@ public static void ToggleInfoPanel()
 			}
 		}
 
+		/// <summary>
+		/// Get navigator.userAgent from the browser
+		/// </summary>
+		/// <returns>navigator.userAgent</returns>
+		public static string GetUserAgent()
+		{
+			#if UNITY_WEBGL && !UNITY_EDITOR
+			return _GetUserAgent();
+			#else
+			Debug.Log($"{nameof(WebGlPlugins)}.{nameof(GetUserAgent)} called");
+			return "undefined";
+			#endif
+		}
+
+		/// <summary>
+		/// Check user agent to determine if the game runs on a mobile device
+		/// </summary>
+		/// <returns>true if on phone or tablet</returns>
+		public static bool IsMobileDevice()
+		{
+			string userAgent = GetUserAgent();
+			return userAgent.Contains("iPhone") ||
+				userAgent.Contains("iPad") ||
+				userAgent.Contains("iPod") ||
+				userAgent.Contains("Android");
+		}
+
 		/// <summary>
 		/// Get the total memory size used by the application in MB
 		/// </summary>
@@ -194,7 +223,7 @@ public static float GetManagedMemorySize()
 			var bytes = (uint) GC.GetTotalMemory(false);
 			return GetMegaBytes(bytes);
 		}
-		
+
 		/// <summary>
 		/// Converts bytes (B) to mega bytes (MB)
 		/// </summary>

Assets/Plugins/WebGL/WebGLTools/WebGlPlugins.jslib

@@ -60,7 +60,26 @@ var WebGlPlugins =
             setInfoPanelVisible(false);
         }
     },
-    
+
+    _GetUserAgent: function () {
+        var userAgent = navigator.userAgent;
+
+        //Get size of the string
+        var bufferSize = lengthBytesUTF8(userAgent) + 1;
+        //Allocate memory space
+        var buffer = _malloc(bufferSize);
+
+        //Copy old data to the new one then return it
+        if(typeof stringToUTF8 !== 'undefined') {
+            stringToUTF8(userAgent, buffer, bufferSize);
+        }
+        else if(typeof writeStringToMemory !== 'undefined') {
+            writeStringToMemory(userAgent, buffer);
+        }
+
+        return buffer;
+    },
+
     _GetTotalMemorySize: function()
     {
         if(typeof TOTAL_MEMORY !== 'undefined') {