From Unity-CrypticCabinet (41a0e75eb099f02eb1a538f942464b7347c9971f)

Author: jasonmeisel

com.meta.tutorial.framework/Editor.meta

@@ -0,0 +1,20 @@
+{
+    "name": "Meta.Tutorial.Framework.Editor",
+    "rootNamespace": "",
+    "references": [
+        "Meta.Tutorial.Framework.Runtime",
+        "Meta.XR.Guides.Editor",
+        "Oculus.VR"
+    ],
+    "includePlatforms": [
+        "Editor"
+    ],
+    "excludePlatforms": [],
+    "allowUnsafeCode": false,
+    "overrideReferences": false,
+    "precompiledReferences": [],
+    "autoReferenced": true,
+    "defineConstraints": [],
+    "versionDefines": [],
+    "noEngineReferences": false
+}

com.meta.tutorial.framework/Editor/Meta.Tutorial.Framework.Editor.asmdef

@@ -0,0 +1,124 @@
+// Copyright (c) Meta Platforms, Inc. and affiliates.
+
+using System.IO;
+using Meta.Tutorial.Framework.Hub.Attributes;
+using Meta.Tutorial.Framework.Hub.Pages;
+using Meta.Tutorial.Framework.Hub.Utilities;
+using Meta.Tutorial.Framework.Hub.Windows;
+using Meta.Tutorial.Framework.Windows;
+using UnityEditor;
+using UnityEngine;
+
+namespace Meta.Tutorial.Framework.Hub.Contexts
+{
+    [MetaHubContext(TutorialFrameworkHub.CONTEXT)]
+    public abstract class BaseTutorialHubContext : MetaHubContext
+    {
+        [SerializeField] private TutorialConfig m_tutorialConfig; // The name of the tutorial this context falls under
+        [SerializeField] private bool m_showBanner;
+
+        private bool m_isInstance;
+
+        public TutorialConfig TutorialConfig => m_tutorialConfig;
+        public string TutorialName => m_tutorialConfig?.Name;
+
+        public override string ProjectName => TutorialName;
+
+        public override string TelemetryContext => Telemetry.TUTORIAL_HUB_CONTEXT;
+
+        protected TutorialConfig.Banner Banner => m_tutorialConfig.BannerConfig;
+
+        protected bool ShowBanner => m_showBanner;
+
+        protected string GetCurrentDirectory()
+            => Path.GetDirectoryName(AssetDatabase.GetAssetPath(this));
+
+        protected string GetRootPageAssetPath()
+            => Path.Combine(GetCurrentDirectory(), "pages", $"{Title}.asset");
+
+        protected string GetChildPageAssetPath(string childName)
+            => Path.Combine(GetCurrentDirectory(), "pages", $"{Title}_{childName}.asset");
+
+        protected void EnsureDirectoryExists(string path)
+        {
+            if (string.IsNullOrEmpty(path))
+            {
+                return;
+            }
+
+            var directory = Path.GetDirectoryName(path);
+            if (!Directory.Exists(directory))
+            {
+                _ = Directory.CreateDirectory(directory);
+            }
+        }
+
+        /// <inheritdoc cref="MetaHubContext.ShowDefaultWindow"/>
+        public override MetaHubBase ShowDefaultWindow() => TutorialFrameworkHub.ShowWindow();
+
+        /// <summary>
+        /// Create or load an instance of a ScriptableObject. When in edit mode, it will create a new instance
+        /// </summary>
+        /// <param name="assetPath">The path to the asset. When in edit mode, it will create the asset at this path.</param>
+        /// <param name="result">Loaded or instantiated object.</param>
+        /// <param name="forceCreate">Pass true to force the creation of an instance.</param>
+        /// <returns>True if the instance was created, false if it was loaded.
+        /// </returns>
+        protected bool CreateOrLoadInstance<T>(string assetPath, out T result, bool forceCreate = false) where T : ScriptableObject
+        {
+#if META_EDIT_TUTORIALS
+            if (!forceCreate && File.Exists(assetPath))
+            {
+                result = AssetDatabase.LoadAssetAtPath<T>(assetPath);
+                m_isInstance = false;
+                return m_isInstance;
+            }
+            else
+            {
+                result = CreateInstance<T>();
+                m_isInstance = true;
+            }
+            return m_isInstance;
+#else
+            // when not in edit mode, we shouldn't create assets, just load them.
+            result = AssetDatabase.LoadAssetAtPath<T>(assetPath);
+            m_isInstance = false;
+            return m_isInstance;
+#endif
+        }
+
+        protected T InstanceToAsset<T>(T instance, string assetPath) where T : ScriptableObject
+        {
+#if META_EDIT_TUTORIALS
+            if (m_isInstance)
+            {
+                EditorUtility.SetDirty(instance);
+                EnsureDirectoryExists(assetPath);
+                AssetDatabase.CreateAsset(instance, assetPath);
+                m_isInstance = false;
+                return AssetDatabase.LoadAssetAtPath<T>(assetPath);
+            }
+#endif
+            // this already is an asset when not in edit mode
+            return instance;
+        }
+
+        /// <summary>
+        /// Create the page references for the tutorial hub
+        /// </summary>
+        /// <param name="forceCreate">Force the regeneration of the pages.</param>
+        /// <returns>An array with the created page references. When more than one page is returned,
+        /// the first page should be considered as the parent, although its foldout path will not reflect that.</returns>
+        public abstract PageReference[] CreatePageReferences(bool forceCreate = false);
+
+        public override int CompareTo(MetaHubContext other)
+        {
+            if (other is BaseTutorialHubContext)
+            {
+                return base.CompareTo(other);
+            }
+
+            return 1; // TutorialHubContexts are always greater than other contexts
+        }
+    }
+}

com.meta.tutorial.framework/Editor/Meta.Tutorial.Framework.Editor.asmdef.meta

@@ -0,0 +1,101 @@
+// Copyright (c) Meta Platforms, Inc. and affiliates.
+
+using System;
+using Meta.Tutorial.Framework.Hub.Utilities;
+using Meta.Tutorial.Framework.Hub.Windows;
+using UnityEditor;
+using UnityEngine;
+
+namespace Meta.Tutorial.Framework.Hub.Contexts
+{
+    /// <summary>
+    /// A documentation context that contains pages.
+    /// </summary>
+    public abstract class MetaHubContext : ScriptableObject, IComparable<MetaHubContext>
+    {
+        private const string GLOBAL_SHOW_ON_STARTUP_KEY = "Meta_Hub_Show_On_Startup_";
+
+        /// <summary>
+        /// A page that is part of a context.
+        /// </summary>
+        [Serializable]
+        public class ScriptableObjectReflectionPage
+        {
+            [Tooltip("The type of scriptable object to reflect.")]
+            public string ScriptableObjectType;
+
+            [Tooltip("The foldout hierarchy name for this object.")]
+            public string HierarchyName;
+
+            [Tooltip("A modifier the priority of all pages of this type.")]
+            public int PriorityModifier;
+        }
+
+
+        [Header("Context Configuration")]
+
+
+        [SerializeField, Tooltip("The title of the context")]
+        private string m_title;
+
+        [SerializeField, Tooltip("The priority of this context. Lower number means higher probability that this will be the primary context.")]
+        private int m_priority = 1000;
+
+        /// <summary>
+        /// Whether to show any context on startup.
+        /// </summary>
+        public static bool GlobalShowOnStartup
+        {
+            get => EditorPrefs.GetBool(GLOBAL_SHOW_ON_STARTUP_KEY + Application.productName, true);
+            set => EditorPrefs.SetBool(GLOBAL_SHOW_ON_STARTUP_KEY + Application.productName, value);
+        }
+
+        /// <summary>
+        /// The name of the context.
+        /// </summary>
+        public virtual string Name => name;
+
+        /// <summary>
+        /// The priority of the context. Lower number means higher probability that this will be the primary context.
+        /// </summary>
+        public virtual int Priority => m_priority;
+
+        /// <summary>
+        /// The title of the window if this is the primary context.
+        /// </summary>
+        public virtual string Title => m_title;
+
+        /// <summary>
+        /// The name of the project if this is the primary context.
+        /// </summary>
+        public virtual string ProjectName => m_title;
+
+        public virtual string TelemetryContext => Telemetry.META_HUB_CONTEXT;
+
+        /// <summary>
+        /// Whether the user has chosen to show this context on startup.
+        /// </summary>
+        public virtual bool ShowOnStartup
+        {
+            get => GlobalShowOnStartup;// && EditorPrefs.GetBool(StartupKey, true);
+            set => EditorPrefs.SetBool(StartupKey, value);
+        }
+
+        /// <summary>
+        /// The key to use for startup preference.
+        /// </summary>
+        private string StartupKey => $"{Name}_Startup";
+
+        /// <inheritdoc cref="IComparable{T}.CompareTo"/>
+        public virtual int CompareTo(MetaHubContext other)
+        {
+            return ReferenceEquals(this, other) ? 0 : other is null ? 1 : m_priority.CompareTo(other.m_priority);
+        }
+
+        /// <summary>
+        /// Show the default window for this context.
+        /// </summary>
+        public virtual MetaHubBase ShowDefaultWindow()
+            => MetaHubBase.ShowWindow<MetaHubBase>(Name);
+    }
+}