Update to Inkle's Main state

.github/workflows/Update-UPM-Branch.yml

@@ -0,0 +1,26 @@
+name: Update-UPM-Branch
+
+on:
+  push:
+    tags:
+      - '[0-9]+.[0-9]+.[0-9]+'
+
+jobs:
+  update:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+
+      - name: Tag name
+        id: tag
+        run: echo ::set-output name=name::${GITHUB_REF#refs/tags/v}
+
+      - name: Create UPM Branches
+        uses: hecomi/create-upm-branch-action@main
+        with:
+          git-tag: ${{ steps.tag.outputs.name }}
+          pkg-root-dir-path: Packages/Ink
+          samples-dir: Packages/Ink/Demos

.gitignore

@@ -4,7 +4,32 @@
 [Ll]ibrary/
 [Tt]emp/
 [Oo]bj/
-[Uu]nityGenerated/
+[Bb]uild/
+[Bb]uilds/
+[Ll]ogs/
+
+# MemoryCaptures can get excessive in size.
+# They also could contain extremely sensitive data
+/[Mm]emoryCaptures/
+
+# Recordings can get excessive in size
+/[Rr]ecordings/
+
+# Autogenerated Jetbrains Rider plugin
+/[Aa]ssets/Plugins/Editor/JetBrains*
+
+# Visual Studio cache directory
+.vs/
+
+# Gradle cache directory
+.gradle/
+
+# Packed Addressables
+/[Aa]ssets/[Aa]ddressable[Aa]ssets[Dd]ata/*/*.bin*
+
+# Temporary auto-generated Android Assets
+/[Aa]ssets/[Ss]treamingAssets/aa.meta
+/[Aa]ssets/[Ss]treamingAssets/aa/*
 
 # =============================================== #
 # Visual Studio / MonoDevelop / Sublime generated #

Assets/DEV_README.md

@@ -4,11 +4,12 @@ This plugin is now designed to be imported as a UPM Package.
 Our approach is to point [OpenUPM at a Git Repo](https://openupm.com/packages/com.inklestudios.ink-unity-integration/) with the assets in the Packages folder.
 Demos are packaged up as separate .unitypackage files.
 
-## To update the UPM
-- (optional) Increase the version number in InkLibrary.cs
-- Commit any changes and push to Master.
-- Draft a new release. (You may also want to add a .unitypackage to the release)
-
-### Exporting a .unitypackage
-- Run Publishing > Create .unitypackage
-This moves all the files from Packages into Assets, creates a package (also including the Demos folder), and then moves the files back to Packages.
+## To update create a new release
+- Update CHANGELOG.md with a list of changes (these will then autopopulate)
+- Increase the version number in InkLibrary.cs
+- Open the Ink Publishing Tools wizard with the 'Publishing/Show Helper Window' menu item
+- Click 'Prepare for publishing'. This will run a bunch of automated tasks and produce a .UnityPackage which we'll need later.
+- You can click the 'Show Package' button to reveal the packages in Finder
+- Commit any changes and push to Master, tagging with the version in the format (x.x.x)
+- This causes an Action to trigger, which will create a UPM branch automatically. [Check it succeeded on OpenUPM](https://openupm.com/packages/com.inkle.ink-unity-integration/?subPage=pipelines)
+- Click 'Draft GitHub Release'. This will take you to a page with most of the fields auto-populated. Drag the new package into the release and hit Publish.

Assets/Editor/InkCompilerEditor.cs

@@ -0,0 +1,60 @@
+using System.Reflection;
+using UnityEditor;
+using UnityEngine;
+
+namespace Ink.UnityIntegration {
+
+	[CustomEditor(typeof(InkCompiler))]
+	public class InkCompilerEditor : Editor {
+
+		#pragma warning disable
+		protected InkCompiler data;
+
+		public void OnEnable() {
+			data = (InkCompiler) target;
+		}
+
+		public bool RequiresConstantRepaint() {
+			return true;
+		}
+
+		public override void OnInspectorGUI() {
+			serializedObject.Update();
+			var type = typeof(InkCompiler);
+
+			EditorGUILayout.Toggle("Executing Compilation Stack", InkCompiler.executingCompilationStack);
+
+			EditorGUILayout.PropertyField(serializedObject.FindProperty("pendingCompilationStack"));
+			EditorGUILayout.PropertyField(serializedObject.FindProperty("compilationStack"));
+			// this.DrawDefaultInspector();
+
+			var buildBlockedInfo = type.GetField("buildBlocked", BindingFlags.NonPublic | BindingFlags.Static);
+			bool buildBlocked = (bool)buildBlockedInfo.GetValue(null);
+			EditorGUILayout.Toggle("Build Blocked", buildBlocked);
+
+			var playModeBlockedInfo = type.GetField("playModeBlocked", BindingFlags.NonPublic | BindingFlags.Static);
+			bool playModeBlocked = (bool)playModeBlockedInfo.GetValue(null);
+			EditorGUILayout.Toggle("Play Mode Blocked", playModeBlocked);
+
+			var hasLockedUnityCompilationInfo = type.GetField("hasLockedUnityCompilation", BindingFlags.NonPublic | BindingFlags.Static);
+			bool hasLockedUnityCompilation = (bool)hasLockedUnityCompilationInfo.GetValue(null);
+			EditorGUILayout.Toggle("Has Locked Compilation", hasLockedUnityCompilation);
+
+			EditorGUILayout.BeginHorizontal();
+			var disallowedAutoRefreshInfo = type.GetProperty("disallowedAutoRefresh", BindingFlags.NonPublic | BindingFlags.Static);
+			bool disallowedAutoRefresh = (bool)disallowedAutoRefreshInfo.GetValue(null);
+			EditorGUILayout.Toggle("DisallowedAutoRefresh", disallowedAutoRefresh);
+			#if UNITY_2019_4_OR_NEWER
+			if(GUILayout.Button("AllowAutoRefresh")) {
+				AssetDatabase.AllowAutoRefresh();
+			}
+			EditorGUILayout.EndHorizontal();
+			#endif
+
+
+			if(GUI.changed && target != null)         
+				EditorUtility.SetDirty(target);
+			serializedObject.ApplyModifiedProperties();
+	    }
+	}
+}

Assets/Editor/InkCompilerEditorWindow.cs

@@ -0,0 +1,29 @@
+using UnityEditor;
+using UnityEngine;
+
+namespace Ink.UnityIntegration {
+	public class InkCompilerEditorWindow : EditorWindow {
+
+		#pragma warning disable
+		Editor InkCompilerEditor;
+
+		[MenuItem("Window/Ink Compiler Editor Window")]
+		static void Init() {
+			var window = (InkCompilerEditorWindow)GetWindow(typeof(InkCompilerEditorWindow));
+			window.titleContent = new GUIContent("Ink Compiler Window");
+			window.Show();
+		}
+
+		public void OnEnable() {
+			InkCompilerEditor = Editor.CreateEditor(InkCompiler.instance);
+		}
+
+		void OnInspectorUpdate() {
+			Repaint();
+		}
+
+		public void OnGUI() {
+			InkCompilerEditor.OnInspectorGUI();
+	    }
+	}
+}

Assets/Editor/InkLibraryEditor.cs

@@ -1,7 +1,6 @@
-using UnityEngine;
-using UnityEditor;
-using System.Collections.Generic;
 using System.Linq;
+using UnityEditor;
+using UnityEngine;
 
 namespace Ink.UnityIntegration {
 
@@ -26,7 +25,7 @@ protected override void OnHeaderGUI () {
 			GUILayout.FlexibleSpace();
 
 
-            EditorGUI.BeginDisabledGroup(InkCompiler.compiling);
+            EditorGUI.BeginDisabledGroup(InkCompiler.executingCompilationStack);
 			if (GUILayout.Button(new GUIContent("Rebuild Library", "Rebuilds the ink library. Do this if you're getting unusual errors"), EditorStyles.miniButton)) {
 				InkLibrary.Rebuild();
 			}
@@ -54,23 +53,13 @@ protected override void OnHeaderGUI () {
 		public override void OnInspectorGUI() {
 			serializedObject.Update();
 
-			EditorGUI.BeginDisabledGroup(InkCompiler.compiling);
+			EditorGUI.BeginDisabledGroup(InkCompiler.executingCompilationStack);
 			if (GUILayout.Button(new GUIContent("Rebuild Library", "Rebuilds the ink library. Do this if you're getting unusual errors"), EditorStyles.miniButton)) {
 				InkLibrary.Rebuild();
 			}
 			EditorGUI.EndDisabledGroup();
 
-			EditorGUILayout.Toggle("HasLockedUnityCompilation", InkCompiler.hasLockedUnityCompilation);
-			if(GUILayout.Button("Unlock")) {
-				EditorApplication.UnlockReloadAssemblies();
-			}
-			#if UNITY_2019_4_OR_NEWER
-			if(GUILayout.Button("AllowAutoRefresh")) {
-				AssetDatabase.AllowAutoRefresh();
-			}
-			#endif
-
-			if(InkCompiler.compiling) {
+			if(InkCompiler.executingCompilationStack) {
 				Rect r = EditorGUILayout.BeginVertical();
 				EditorGUI.ProgressBar(r, InkCompiler.GetEstimatedCompilationProgress(), "Compiling...");
 				GUILayout.Space(EditorGUIUtility.singleLineHeight);
@@ -89,7 +78,7 @@ public override void OnInspectorGUI() {
 					EditorGUILayout.HelpBox("All Ink files marked to compile automatically are compiled", MessageType.Info);
 				}
 			}
-			EditorGUI.BeginDisabledGroup(InkCompiler.compiling);
+			EditorGUI.BeginDisabledGroup(InkCompiler.executingCompilationStack);
 			if (GUILayout.Button(new GUIContent("Recompile All", "Recompiles all files marked to compile automatically."))) {
 				InkEditorUtils.RecompileAll();
 			}
@@ -108,13 +97,8 @@ public override void OnInspectorGUI() {
 
 			EditorGUI.BeginDisabledGroup(true);
 			EditorGUILayout.PropertyField(serializedObject.FindProperty("inkLibrary"), true);
-			EditorGUILayout.PropertyField(serializedObject.FindProperty("pendingCompilationStack"), true);
-			EditorGUILayout.PropertyField(serializedObject.FindProperty("compilationStack"), true);
 			EditorGUI.EndDisabledGroup();
 
-            if (GUILayout.Button(new GUIContent("Clear Compilation Stacks"))) {
-                InkCompiler.ClearCompilationStacks();
-            }
 			if(GUI.changed && target != null)         
 				EditorUtility.SetDirty(target);
 			serializedObject.ApplyModifiedProperties();

Assets/Editor/InkLibraryEditorWindow.cs

@@ -1,7 +1,5 @@
-using UnityEngine;
 using UnityEditor;
-using System.Collections.Generic;
-using System.Linq;
+using UnityEngine;
 
 namespace Ink.UnityIntegration {
 	public class InkLibraryEditorWindow : EditorWindow {
@@ -11,7 +9,7 @@ public class InkLibraryEditorWindow : EditorWindow {
 
 		[MenuItem("Window/Ink Library Editor Window")]
 		static void Init() {
-			var window = (InkLibraryEditorWindow)EditorWindow.GetWindow(typeof(InkLibraryEditorWindow));
+			var window = (InkLibraryEditorWindow)GetWindow(typeof(InkLibraryEditorWindow));
 			window.titleContent = new GUIContent("Ink Library Window");
 			window.Show();
 		}