net.dreditor.core 0.1.4 → 0.1.6

package/Scripts/Editor/Dependencies/FMODInitializer.cs

@@ -0,0 +1,260 @@
+//Author: Benjamin "Sweden" Jillson : Discord: sweden_gaming For Project Eden's Garden
+using System;
+using System.Collections.Generic;
+using System.IO;
+using UnityEditor;
+using UnityEngine;
+
+namespace DREditor.Editor.Dependencies
+{
+    /// <summary>
+    ///
+    /// </summary>
+    [Serializable]
+    public class FMODInitializer : DependencyInitializerBase
+    {
+        /// <inheritdoc/>
+        public override float Priority => 1;
+
+        /// <inheritdoc/>
+        public override bool Required => false;
+
+        /// <inheritdoc/>
+        protected override string AssemblyName => "FMODUnity";
+
+        /// <inheritdoc/>
+        protected override string DefineSymbol => "FMOD_UNITY";
+
+        /// <inheritdoc/>
+        public override string DisplayName => "FMOD";
+
+        /// <inheritdoc/>
+        protected override string DependencyInstallURL => "https://www.fmod.com/download#fmodforunity";
+
+        /// <summary>
+        ///
+        /// </summary>
+        protected readonly string FMODTemplateURL = "https://drive.google.com/file/d/1KQDVa-Xp4iXRqj4sRqivytXUYP8xyf8S/view?usp=sharing";
+
+        /// <summary>
+        ///
+        /// </summary>
+        protected readonly string ProjectRootPath = Path.GetFullPath(Path.Combine(Application.dataPath, ".."));
+
+        /// <summary>
+        ///
+        /// </summary>
+        protected readonly string FMODFolderName = "dre_audio";
+
+        /// <summary>
+        ///
+        /// </summary>
+        protected readonly string FMODGitIgnore =
+            "\r\n# Never ignore DLLs in the FMOD subfolder." +
+            "\r\n!/[Aa]ssets/Plugins/FMOD/**/lib/*" +
+            "\r\n                    " +
+            "\r\n# Don't ignore images and gizmos used by FMOD in the Unity Editor." +
+            "\r\n!/[Aa]ssets/Gizmos/FMOD/*" +
+            "\r\n!/[Aa]ssets/Editor Default Resources/FMOD/*" +
+            "\r\n                    " +
+            "\r\n# Ignore the Cache folder since it is updated locally." +
+            "\r\n/[Aa]ssets/Plugins/FMOD/Cache/*" +
+            "\r\n                    " +
+            "\r\n# Ignore bank files in the StreamingAssets folder." +
+            "\r\n/[Aa]ssets/StreamingAssets/**/*.bank" +
+            "\r\n/[Aa]ssets/StreamingAssets/**/*.bank.meta" +
+            "\r\n                    " +
+            "\r\n# If the source bank files are kept outside of the StreamingAssets folder then these can be ignored." +
+            "\r\n# Log files can be ignored." +
+            "\r\nfmod_editor.log";
+
+        /// <summary>
+        ///
+        /// </summary>
+        protected readonly List<Func<bool>> Instructions;
+
+
+        public FMODInitializer()
+        {
+            Instructions = new()
+            {
+                PromptWebsite,
+                InstallerInstructions,
+                OpenFMODTemplateDownload,
+                ImportFMODTemplate,
+                PromptPackageDownload,
+                FMODLinking,
+            };
+        }
+
+
+        /// <inheritdoc/>
+        protected override void PostDownloadInstructions()
+        {
+            if (AllInstructionsFollowed())
+                ImportPackage();
+            else
+                InstallDependency();
+        }
+
+        /// <summary>
+        ///
+        /// </summary>
+        /// <returns></returns>
+        protected bool AllInstructionsFollowed()
+        {
+            foreach (var instruction in Instructions)
+                if (instruction == null || !instruction.Invoke())
+                    return false;
+
+            return true;
+        }
+
+        /// <summary>
+        ///
+        /// </summary>
+        /// <returns></returns>
+        protected bool PromptWebsite() =>
+            EditorUtility.DisplayDialog("Import Instructions",
+                "PROPOSAL: Follow these steps:" +
+                "\n- A Website should've appeared, Click sign in so you can sign in or register." +
+                "\n- Once Registered, return back to the download site." +
+                "\n- At the very top, the drop down for \"FMOD Studio\" should have download links when you click it." +
+                "\n- Click \"Unity Verified\" then click \"Older\" there should be version 2.01.11. Click download." +
+                "\nIF THE DOWNLOAD DOESNT START USE AN INCOGNITO WINDOW." +
+                "\n- Once you've downloaded the .exe, return back here and click the next step button.",
+                "Next Step", "Restart");
+
+        /// <summary>
+        ///
+        /// </summary>
+        /// <returns></returns>
+        protected bool InstallerInstructions() =>
+            EditorUtility.DisplayDialog("Import Instructions",
+                "PROPOSAL: Follow these steps:" +
+                "\n- Click on the installer, make sure that during the installation, uncheck \"Reboot\". " +
+                "\nOther than that, follow the install instructions." +
+                "\n- Once done, return back here and click the next step button.",
+                "Next Step", "Restart");
+
+        /// <summary>
+        ///
+        /// </summary>
+        /// <returns></returns>
+        protected bool OpenFMODTemplateDownload()
+        {
+            bool result = EditorUtility.DisplayDialog("Import Instructions",
+                "PROPOSAL: Follow this step:" +
+                "\nNext, we're going to download an FMOD template for the system. " +
+                "\nThere's one available in google drive, I'll open it now.",
+                "Ready", "Restart");
+
+            if (result)
+                OpenInstallURL(FMODTemplateURL);
+
+            return result;
+        }
+
+        /// <summary>
+        ///
+        /// </summary>
+        /// <returns></returns>
+        protected bool ImportFMODTemplate()
+        {
+            string fullPath = GetFMODPath();
+
+            if (!Directory.Exists(fullPath))
+                Directory.CreateDirectory(fullPath);
+
+            if (EditorUtility.DisplayDialog("Import Instructions",
+                "REPORT: The directory for where to place the downloaded template has been created." +
+                "\nPROPOSAL: When I open the explorer, place the zip into the folder opened, right click, and extract it." +
+                "\nPROPOSAL: Copy the components inside the extracted folder and move them into the dre_audio folder." +
+                "\nQUERY: Open Explorer now?",
+                "Yes", "Skip"))
+                EditorUtility.RevealInFinder(fullPath);
+
+            return true;
+        }
+
+        /// <summary>
+        ///
+        /// </summary>
+        /// <returns></returns>
+        protected string GetFMODPath() => Path.Combine(ProjectRootPath, FMODFolderName);
+
+        /// <summary>
+        ///
+        /// </summary>
+        /// <returns></returns>
+        protected bool PromptPackageDownload() =>
+            EditorUtility.DisplayDialog("Import Instructions",
+                "PROPOSAL: Follow these steps:" +
+                "\n- Go back to the FMOD Download page and under the drop down \"FMOD for Unity\" will have download links when you click it." +
+                "\n- Click \"Unity Verified\" then click \"Older\" there should be version 2.01.11. Click download." +
+                "\nIF THE DOWNLOAD DOESNT START USE AN INCOGNITO WINDOW." +
+                "\n- This should download a unity package, when the download is completed, return here to import the package.",
+                "I've Downloaded the package.", "Restart");
+
+        /// <summary>
+        ///
+        /// </summary>
+        /// <returns></returns>
+        protected bool FMODLinking() => 
+            EditorUtility.DisplayDialog("Import Instructions",
+                "PROPOSAL: Follow these steps:" +
+                "\n- After pressing the \"Import Package\" button below, select the unity package you just downloaded." +
+                "\n- After you click \"Import\", You'll be asked to replace something, just hit yes. " +
+                "\n- Afterwards, an FMOD window will appear." +
+                "\n- You are ONLY going to click on \"Linking\"." +
+                $"\n- Then, press the top most button, and paste {GetFMODPath()} into the explorer bar " +
+                $"to move to the folder and select the FMOD project." +
+                $"\n- When you finish linking, just press the refresh button on the dependency manager.",
+                "Import Package", "Restart");
+
+        protected override void OnPostImport()
+        {
+            if (EditorUtility.DisplayDialog("Import Instructions",
+                $"Have you finished linking {GetFMODPath()} to your FMOD project?",
+                "Yes", "No"))
+                OnCompleted();
+        }
+
+        /// <summary>
+        ///
+        /// </summary>
+        protected void OnCompleted()
+        {
+            base.OnPostImport();
+
+            UpdateGitIgnore();
+
+            EditorUtility.DisplayDialog("Import Instructions",
+                "REPORT: FMOD Dependency Installation should now be complete.",
+                "Acknowledged");
+        }
+
+        /// <summary>
+        ///
+        /// </summary>
+        /// <returns></returns>
+        protected void UpdateGitIgnore()
+        {
+            string filePath = Path.Combine(ProjectRootPath, ".gitignore.txt");
+
+            try
+            {
+                if (!File.ReadAllText(filePath).Contains(FMODGitIgnore))
+                    File.AppendAllText(filePath, FMODGitIgnore + System.Environment.NewLine);
+            }
+            catch
+            {
+                UnityEngine.Debug.LogWarning("ALERT: The Git Ignore file for FMOD could not be updated.");
+
+                UnityEngine.Debug.LogWarning("HYPOTHESIS: It is likely that the user did not set up a github project before the system was installed.");
+
+                UnityEngine.Debug.LogWarning("PROPOSAL: Remove DREditor from the system, make a github project first, then import DREditor.");
+            }
+        }
+    }
+}

package/Scripts/Editor/Dependencies/FMODInitializer.cs.meta

@@ -0,0 +1,11 @@
+fileFormatVersion: 2
+guid: 6b9b8c7c239377a4686bd697e5194c13
+MonoImporter:
+  externalObjects: {}
+  serializedVersion: 2
+  defaultReferences: []
+  executionOrder: 0
+  icon: {instanceID: 0}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

package/Scripts/Editor/Dependencies/InstallationState.cs

@@ -0,0 +1,45 @@
+//Author: Benjamin "Sweden" Jillson : Discord: sweden_gaming For Project Eden's Garden
+using System.Collections.Generic;
+using UnityEditor.PackageManager;
+using UnityEditor.PackageManager.Requests;
+
+namespace DREditor.Editor.Dependencies
+{
+    /// <summary>
+    ///
+    /// </summary>
+    public class InstallationState
+    {
+        /// <summary>
+        ///
+        /// </summary>
+        public readonly Queue<string> PackagesToInstall = null;
+
+        /// <summary>
+        ///
+        /// </summary>
+        public AddRequest CurrentAddRequest { get; set; }
+
+
+        public InstallationState(Queue<string> PackagesToInstall) => this.PackagesToInstall = PackagesToInstall;
+
+        
+        /// <summary>
+        ///
+        /// </summary>
+        /// <returns></returns>
+        public bool PackageQueueInvalid() => PackagesToInstall == null || PackagesToInstall.Count == 0;
+
+        /// <summary>
+        ///
+        /// </summary>
+        /// <returns></returns>
+        public bool AddRequestInvalid() => CurrentAddRequest == null || !CurrentAddRequest.IsCompleted;
+
+        /// <summary>
+        ///
+        /// </summary>
+        /// <returns></returns>
+        public bool CurrentRequestSucceded() => CurrentAddRequest.Status == StatusCode.Success;
+    }
+}

package/Scripts/Editor/Dependencies/InstallationState.cs.meta

@@ -0,0 +1,2 @@
+fileFormatVersion: 2
+guid: 98aff62e2e4b7e1408b00e7f34785b2c

package/Scripts/Editor/Dependencies.meta

@@ -0,0 +1,8 @@
+fileFormatVersion: 2
+guid: 26e9b5a2e9f892b4a95b56abbee8cb77
+folderAsset: yes
+DefaultImporter:
+  externalObjects: {}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

package/Scripts/Editor/Dialogues/CustomCallEndEventEditor.cs

@@ -0,0 +1,57 @@
+//Author: Benjamin "Sweden" Jillson : Discord: sweden_gaming For DREditor
+#if UNITY_EDITOR
+using DREditor.Dialogues;
+using DREditor.Editor.Utility;
+using UnityEditor;
+using UnityEngine;
+
+namespace DREditor.Editor.Dialogues
+{
+    public class CustomCallEndEventEditor
+    {
+        protected EndEvent endEvent;
+
+        public virtual EndEvent Display(EndEvent endEvent)
+        {
+            this.endEvent = endEvent;
+
+            if (endEvent.Enabled)
+            {
+                using (new EditorGUILayout.VerticalScope("Box", GUILayout.Width(400)))
+                {
+                    CustomLayoutUtility.DisplayHorizontal(DisplayCustomCall, DisplayCallBreak);
+
+                    RemoveEndEventButton();
+                }
+            }
+
+            return this.endEvent;
+        }
+
+        public virtual void DisplayAddButton()
+        {
+            if (endEvent != null && !endEvent.Enabled && GUILayout.Button("End Event", GUILayout.Width(100)))
+                endEvent.SetEnabled(true);
+        }
+
+
+        protected virtual void DisplayCustomCall() =>
+            endEvent.CustomCall = HandyFields.StringField("Custom Call: ", endEvent.CustomCall);
+
+        protected virtual void DisplayCallBreak() =>
+            endEvent.CallBreak = HandyFields.Option(endEvent.CallBreak, "Call Break: ", 70);
+
+        protected virtual void RemoveEndEventButton()
+        {
+            if (GUILayout.Button("Remove", GUILayout.Width(80)))
+            {
+                endEvent.CustomCall = "";
+
+                endEvent.CallBreak = false;
+
+                endEvent.SetEnabled(false);
+            }
+        }
+    }
+}
+#endif

package/Scripts/Editor/Dialogues/CustomCallEndEventEditor.cs.meta

@@ -0,0 +1,2 @@
+fileFormatVersion: 2
+guid: 8b850b5704767c844862999d280f5716

package/Scripts/Editor/Dialogues/DialogueDebugToolEditor.cs

@@ -0,0 +1,153 @@
+//Author: Benjamin "Sweden" Jillson : Discord: sweden_gaming For Project Eden's Garden
+#if UNITY_EDITOR
+using DREditor.Characters;
+using DREditor.Dialogues;
+using System;
+using UnityEditor;
+using UnityEngine;
+
+namespace DREditor.Editor.Dialogues
+{
+    /// <summary>
+    /// 
+    /// </summary>
+    /// <typeparam name="T"></typeparam>
+    [Serializable]
+    public class DialogueDebugToolEditor<T> : DialogueDebugToolEditorBase where T : Line, new()
+    {
+        /// <summary>
+        /// 
+        /// </summary>
+		protected DialogueCore dia;
+
+        /// <summary>
+        /// 
+        /// </summary>
+		protected bool exitDebugMode = false;
+
+
+        /// <summary>
+        /// 
+        /// </summary>
+        protected virtual void EnterDebugMode() => exitDebugMode = false;
+
+        /// <summary>
+        /// 
+        /// </summary>
+        protected virtual void ExitDebugMode() => exitDebugMode = true;
+
+
+        public override bool DebugMode(DialogueCore dia)
+        {
+            EnterDebugMode();
+
+            this.dia = dia;
+
+            if (GUILayout.Button("Test First Line Characters Sprites", GUILayout.Width(250)))
+                ReplaceWithFirstLineCharactersSprites();
+
+            if (GUILayout.Button("Remove top half of Lines"))
+                SplitDialogue(true);
+
+            if (GUILayout.Button("Remove bottom half of Lines"))
+                SplitDialogue(false);
+
+            return exitDebugMode;
+        }
+
+        /// <summary>
+        /// 
+        /// </summary>
+        /// <param name="dia"></param>
+        /// <param name="autoAccept"></param>
+        public virtual void ReplaceWithFirstLineCharactersSprites(DialogueCore dia = null, bool autoAccept = false)
+        {
+            if (dia == null)
+                dia = this.dia;
+
+            if (HasValidSpeakerOnFirstLine(dia) &&
+                        (autoAccept || EditorUtility.DisplayDialog("Make dialogue have line of every sprite?",
+                        "WARNING!: This will rewrite all lines of the dialogue asset! " +
+                        "Are you sure you want to continue?", "Yes", "No")))
+            {
+                ReplaceLinesWithSprites(dia);
+
+                ExitDebugMode();
+            }
+        }
+
+        /// <summary>
+        /// 
+        /// </summary>
+        /// <param name="dia"></param>
+        /// <returns></returns>
+        protected virtual bool HasValidSpeakerOnFirstLine(DialogueCore dia)
+        {
+            bool result = dia.LineCount > 0 && dia.GetLine(0).Speaker != null && dia.GetLine(0).Speaker.Expressions.Count > 0;
+
+            if (!result)
+                Debug.LogWarning("ALERT: Please Add a line, add a Speaker to the first line, " +
+                        "or add expressions the the character.");
+
+            return result;
+        }
+
+        /// <summary>
+        /// 
+        /// </summary>
+        /// <param name="dia"></param>
+        protected virtual void ReplaceLinesWithSprites(DialogueCore dia)
+        {
+            Character character = dia.GetLine(0).Speaker;
+
+            int speakerNum = dia.GetLine(0).SpeakerNumber;
+
+            for (int i = dia.LineCount - 1; i > 0; i--) // Make it just one line
+            {
+                if (dia.LineCount == 1)
+                    break;
+
+                dia.GetLines<T>().Remove((T)dia.GetLine(i));
+            }
+
+            for (int i = 0; i < character.Expressions.Count; i++)
+            {
+                if (i == 0)
+                {
+                    dia.GetLine(i).SetExpressionNum(i + 1);
+
+                    dia.GetLine(i).SetExpression(character.Expressions[i]);
+
+                    dia.GetLine(i).SetText(dia.GetLine(i).Expression.Name);
+
+                    continue;
+                }
+
+                dia.GetLines<T>().Add(new T());
+
+                dia.GetLine(i).SetSpeakerNum(speakerNum);
+
+                dia.GetLine(i).SetExpressionNum(i + 1);
+
+                dia.GetLine(i).SetExpression(character.Expressions[i]);
+
+                dia.GetLine(i).SetText(dia.GetLine(i).Expression.Name);
+            }
+        }
+
+        /// <summary>
+        /// 
+        /// </summary>
+        /// <param name="top"></param>
+        protected virtual void SplitDialogue(bool top)
+        {
+            if (top)
+                dia.GetLines<T>().RemoveRange(0, dia.LineCount / 2);
+            else
+                dia.GetLines<T>().RemoveRange(dia.LineCount / 2, dia.LineCount - dia.LineCount / 2);
+
+            ExitDebugMode();
+        }
+    }
+}
+#endif

package/Scripts/Editor/Dialogues/DialogueDebugToolEditor.cs.meta

@@ -0,0 +1,2 @@
+fileFormatVersion: 2
+guid: a0da74e96fd36b947a570784726b2930

package/Scripts/Editor/Dialogues/DialogueDebugToolEditorBase.cs

@@ -0,0 +1,14 @@
+//Author: Benjamin "Sweden" Jillson : Discord: sweden_gaming For Project Eden's Garden
+#if UNITY_EDITOR
+using DREditor.Dialogues;
+using System;
+
+namespace DREditor.Editor.Dialogues
+{
+    [Serializable]
+    public abstract class DialogueDebugToolEditorBase
+    {
+        public abstract bool DebugMode(DialogueCore dia);
+    }
+}
+#endif

package/Scripts/Editor/Dialogues/DialogueDebugToolEditorBase.cs.meta

@@ -0,0 +1,2 @@
+fileFormatVersion: 2
+guid: ac9d7deb2b3a34d4dbbbfb7c43d42c4f

package/Scripts/Editor/Dialogues/DialogueEditor.cs

@@ -0,0 +1,115 @@
+//Original Author: Selenium Soul
+//Completely Reworked by: Benjamin "Sweden" Jillson : Discord: sweden_gaming For DREditor
+#if UNITY_EDITOR
+using DREditor.Dialogues;
+using DREditor.Editor.Utility;
+using UnityEditor;
+using UnityEngine;
+
+namespace DREditor.Editor.Dialogues
+{
+    /// <summary>
+    ///
+    /// </summary>
+    [CustomEditor(typeof(Dialogue))]
+	public class DialogueEditor : DialogueEditorBase<Line>
+    {
+        /// <summary>
+        ///
+        /// </summary>
+        protected Dialogue dialogue;
+
+
+        /// <summary>
+        ///
+        /// </summary>
+        protected readonly DialogueDebugToolEditor<Line> debugTool = new();
+
+        /// <summary>
+        ///
+        /// </summary>
+        protected readonly LineEditor<Line> lineEditor = new();
+
+        /// <summary>
+        ///
+        /// </summary>
+        protected DialogueEndEventEditor endEventEditor = new();
+        
+
+        protected override LineEditorBase LineEditor { get => lineEditor; }
+
+
+        protected override DialogueDebugToolEditorBase DebugTool { get => debugTool; }
+
+
+        public virtual void OnEnable()
+		{
+            SetDialogue(target as Dialogue);
+
+            lineEditor.Initialize(dia, serializedObject, this);
+		}
+
+
+        protected override void SetDialogue(DialogueBase<Line> dia)
+        {
+            base.SetDialogue(dia);
+
+            dialogue = this.dia as Dialogue;
+        }
+
+
+        protected override void DisplayDialogueOptions()
+        {
+            base.DisplayDialogueOptions();
+            
+            CustomLayoutUtility.MassHorizontal(UnlockPauseMenu, UnlockSpecificPauseOption, UpdateAllowedPauseOption);
+        }
+
+        /// <summary>
+        ///
+        /// </summary>
+        protected virtual void UnlockPauseMenu() => 
+            dialogue.UnlockPause = HandyFields.Option(dialogue.UnlockPause, "Unlock Pause: ", 90);
+
+        /// <summary>
+        ///
+        /// </summary>
+        protected virtual void UnlockSpecificPauseOption()
+        {
+            dialogue.UnlockPauseOption = HandyFields.Option(dialogue.UnlockPauseOption, "Unlock Option: ", 95);
+
+            if (dialogue.UnlockPauseOption)
+                dialogue.PauseOptionNum = HandyFields.IntField("Option Number: ", dialogue.PauseOptionNum, 20, 7);
+        }
+
+        /// <summary>
+        ///
+        /// </summary>
+        protected virtual void UpdateAllowedPauseOption()
+        {
+            if (dialogue.UnlockPauseOption)
+                dialogue.PauseOptionTo = HandyFields.Option(dialogue.PauseOptionTo, "To: ", 25);
+        }
+
+
+        protected override void DisplayFooter()
+        {
+            if (dialogue == null)
+                UnityEngine.Debug.LogWarning("DIALOGUE NULL");
+
+            if (endEventEditor == null)
+                UnityEngine.Debug.LogWarning("EDITOR NULL");
+
+            endEventEditor ??= new();
+
+            endEventEditor.DisplayEndEvents(dialogue);
+
+            base.DisplayFooter();
+
+            endEventEditor.DisplayEndEventsButtons();
+
+            GUILayout.Space(30);
+		}
+    }
+}
+#endif