Merge pull request #214 from amazingalek/dev

master < dev
ow-mods · Jul 26, 2020 · a6f88d3 · a6f88d3
2 parents e0f76eb + 0c9678f
commit a6f88d3
Show file tree

Hide file tree

Showing 82 changed files with 1,262 additions and 480 deletions.
diff --git a/OWML.Common/Constants.cs b/OWML.Common/Constants.cs
@@ -2,10 +2,13 @@
 {
     public class Constants
     {
-        public const string QuitKeyPhrase = "{RageAgainstTheDyingOfTheLight}";
         public const string ConsolePortArgument = "consolePort";
         public const string OwmlConfigFileName = "OWML.Config.json";
         public const string OwmlDefaultConfigFileName = "OWML.DefaultConfig.json";
         public const string OwmlManifestFileName = "OWML.Manifest.json";
+        public const string LocalAddress = "127.0.0.1";
+        public const string ModConfigFileName = "config.json";
+        public const string ModDefaultConfigFileName = "default-config.json";
+        public const string ModManifestFileName = "manifest.json";
     }
 }
diff --git a/OWML.Common/IModConfig.cs b/OWML.Common/IModConfig.cs
@@ -6,6 +6,7 @@ namespace OWML.Common
     public interface IModConfig
     {
         bool Enabled { get; set; }
+        [Obsolete("Use ModManifest.RequireVR instead")]
         bool RequireVR { get; set; }
         Dictionary<string, object> Settings { get; set; }
 

diff --git a/OWML.Common/IModConsole.cs b/OWML.Common/IModConsole.cs
@@ -1,8 +1,13 @@
-namespace OWML.Common
+using System;
+
+namespace OWML.Common
 {
     public interface IModConsole
     {
-        void WriteLine(string s);
-        void WriteLine(params object[] s);
+        [Obsolete("Use WriteLine(string) or WriteLine(string, MessageType) instead.")]
+        void WriteLine(params object[] objects);
+
+        void WriteLine(string line);
+        void WriteLine(string line, MessageType type);
     }
 }
diff --git a/OWML.Common/IModData.cs b/OWML.Common/IModData.cs
@@ -5,5 +5,10 @@ public interface IModData
         IModManifest Manifest { get; }
         IModConfig Config { get; }
         IModConfig DefaultConfig { get; }
+        bool Enabled { get; }
+        bool RequireVR { get; }
+
+        void ResetConfigToDefaults();
+        bool FixConfigs();
     }
 }
diff --git a/OWML.Common/IModEvents.cs b/OWML.Common/IModEvents.cs
@@ -5,6 +5,9 @@ namespace OWML.Common
 {
     public interface IModEvents
     {
+        IModPlayerEvents Player { get; }
+        IModSceneEvents Scenes { get; }
+
         Action<MonoBehaviour, Events> OnEvent { get; set; }
 
         void Subscribe<T>(Events ev) where T : MonoBehaviour;

diff --git a/OWML.Common/IModFinder.cs b/OWML.Common/IModFinder.cs
@@ -4,6 +4,6 @@ namespace OWML.Common
 {
     public interface IModFinder
     {
-        IList<IModData> GetMods();
+        List<IModData> GetMods();
     }
 }
diff --git a/OWML.Common/IModManifest.cs b/OWML.Common/IModManifest.cs
@@ -15,5 +15,6 @@ public interface IModManifest
         Dictionary<string, string> AppIds { get; }
         string[] Dependencies { get; }
         bool PriorityLoad { get; }
+        bool RequireVR { get; }
     }
 }
diff --git a/OWML.Common/IModPlayerEvents.cs b/OWML.Common/IModPlayerEvents.cs
@@ -0,0 +1,9 @@
+using System;
+
+namespace OWML.Common
+{
+    public interface IModPlayerEvents
+    {
+        event Action<PlayerBody> OnPlayerAwake;
+    }
+}
diff --git a/OWML.Common/IModSceneEvents.cs b/OWML.Common/IModSceneEvents.cs
@@ -0,0 +1,10 @@
+using System;
+
+namespace OWML.Common
+{
+    public interface IModSceneEvents
+    {
+        event Action<OWScene, OWScene> OnStartSceneChange;
+        event Action<OWScene, OWScene> OnCompleteSceneChange;
+    }
+}
diff --git a/OWML.Common/IOwmlConfig.cs b/OWML.Common/IOwmlConfig.cs
@@ -8,9 +8,7 @@ public interface IOwmlConfig
         string DataPath { get; }
         string OWMLPath { get; set; }
         string ModsPath { get; }
-        string OutputFilePath { get; }
-        string LogFilePath { get; }
-        bool Verbose { get; set; }
         bool BlockInput { get; set; }
+        int SocketPort { get; set; }
     }
 }
diff --git a/OWML.Common/Menus/IModConfigMenuBase.cs b/OWML.Common/Menus/IModConfigMenuBase.cs
@@ -5,6 +5,7 @@ public interface IModConfigMenuBase : IModPopupMenu
         IModManifest Manifest { get; }
 
         void Initialize(Menu modMenuCopy, IModToggleInput toggleTemplate, IModSliderInput sliderTemplate, 
-            IModTextInput textInputTemplate, IModNumberInput numberInputTemplate, IModComboInput comboInputTemplate);
+            IModTextInput textInputTemplate, IModNumberInput numberInputTemplate,
+            IModComboInput comboInputTemplate, IModSelectorInput selectorTemplate);
     }
 }
diff --git a/OWML.Common/Menus/IModMenu.cs b/OWML.Common/Menus/IModMenu.cs
@@ -35,6 +35,11 @@ public interface IModMenu
         IModSliderInput AddSliderInput(IModSliderInput input);
         IModSliderInput AddSliderInput(IModSliderInput input, int index);
 
+        List<IModSelectorInput> SelectorInputs { get; }
+        IModSelectorInput GetSelectorInput(string title);
+        IModSelectorInput AddSelectorInput(IModSelectorInput input);
+        IModSelectorInput AddSelectorInput(IModSelectorInput input, int index);
+
         List<IModTextInput> TextInputs { get; }
         IModTextInput GetTextInput(string title);
         IModTextInput AddTextInput(IModTextInput input);
@@ -45,6 +50,11 @@ public interface IModMenu
         IModNumberInput AddNumberInput(IModNumberInput input);
         IModNumberInput AddNumberInput(IModNumberInput input, int index);
 
+        List<IModSeparator> Separators { get; }
+        IModSeparator AddSeparator(IModSeparator separator);
+        IModSeparator AddSeparator(IModSeparator separator, int index);
+        IModSeparator GetSeparator(string title);
+
         object GetInputValue(string key);
         void SetInputValue(string key, object value);
 

diff --git a/OWML.Common/Menus/IModSelectorInput.cs b/OWML.Common/Menus/IModSelectorInput.cs
@@ -0,0 +1,10 @@
+namespace OWML.Common.Menus
+{
+    public interface IModSelectorInput : IModInput<string>
+    {
+        int SelectedIndex { get; set; }
+        void Initialize(string option, string[] options);
+        IModSelectorInput Copy();
+        IModSelectorInput Copy(string title);
+    }
+}
diff --git a/OWML.Common/Menus/IModSeparator.cs b/OWML.Common/Menus/IModSeparator.cs
@@ -0,0 +1,12 @@
+using UnityEngine.UI;
+
+namespace OWML.Common.Menus
+{
+    public interface IModSeparator : IModInputBase
+    {
+        LayoutElement LayoutElement { get; }
+
+        IModSeparator Copy();
+        IModSeparator Copy(string title);
+    }
+}
diff --git a/OWML.Common/Menus/IModSliderInput.cs b/OWML.Common/Menus/IModSliderInput.cs
@@ -4,6 +4,7 @@ public interface IModSliderInput : IModInput<float>
     {
         float Min { get; set; }
         float Max { get; set; }
+        bool HasValueText { get; }
 
         IModSliderInput Copy();
         IModSliderInput Copy(string title);

diff --git a/OWML.Common/MessageType.cs b/OWML.Common/MessageType.cs
@@ -0,0 +1,12 @@
+namespace OWML.Common
+{
+    public enum MessageType
+    {
+        Message = 0,
+        Error = 1,
+        Warning = 2,
+        Info = 3,
+        Success = 4,
+        Quit = 5
+    }
+}
diff --git a/OWML.Common/OWML.Common.csproj b/OWML.Common/OWML.Common.csproj
@@ -41,6 +41,9 @@
     <Compile Include="IModInputTextures.cs" />
     <Compile Include="IModInputHandler.cs" />
     <Compile Include="IModInteraction.cs" />
+    <Compile Include="IModPlayerEvents.cs" />
+    <Compile Include="IModSceneEvents.cs" />
+    <Compile Include="Menus\IModSeparator.cs" />
     <Compile Include="Menus\IModInputBase.cs" />
     <Compile Include="Menus\IModFieldInput.cs" />
     <Compile Include="Menus\IModMenuWithSelectables.cs" />
@@ -54,6 +57,7 @@
     <Compile Include="Menus\IModComboInput.cs" />
     <Compile Include="Menus\IModOWMenu.cs" />
     <Compile Include="Menus\IModPromptButton.cs" />
+    <Compile Include="Menus\IModSelectorInput.cs" />
     <Compile Include="Menus\InputType.cs" />
     <Compile Include="Menus\IModButton.cs" />
     <Compile Include="IModConfig.cs" />
@@ -82,6 +86,7 @@
     <Compile Include="Menus\IModNumberInput.cs" />
     <Compile Include="Menus\IModTextInput.cs" />
     <Compile Include="Menus\IModToggleInput.cs" />
+    <Compile Include="MessageType.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />
   </ItemGroup>
   <ItemGroup>

diff --git a/OWML.GameFinder/CurrentPathFinder.cs b/OWML.GameFinder/CurrentPathFinder.cs
@@ -14,7 +14,7 @@ public override string FindGamePath()
             {
                 return Config.GamePath;
             }
-            Writer.WriteLine($"Current game path is not valid: {Config.GamePath}");
+            Writer.WriteLine($"Current game path is not valid: {Config.GamePath}", MessageType.Error);
             return null;
         }
 

diff --git a/OWML.Launcher/App.cs b/OWML.Launcher/App.cs
@@ -16,41 +16,32 @@ public class App
         private readonly IModManifest _owmlManifest;
         private readonly IModConsole _writer;
         private readonly IModFinder _modFinder;
-        private readonly OutputListener _listener;
         private readonly PathFinder _pathFinder;
         private readonly OWPatcher _owPatcher;
         private readonly VRPatcher _vrPatcher;
 
         public App(IOwmlConfig owmlConfig, IModManifest owmlManifest, IModConsole writer, IModFinder modFinder,
-            OutputListener listener, PathFinder pathFinder, OWPatcher owPatcher, VRPatcher vrPatcher)
+            PathFinder pathFinder, OWPatcher owPatcher, VRPatcher vrPatcher)
         {
             _owmlConfig = owmlConfig;
             _owmlManifest = owmlManifest;
             _writer = writer;
             _modFinder = modFinder;
-            _listener = listener;
             _pathFinder = pathFinder;
             _owPatcher = owPatcher;
             _vrPatcher = vrPatcher;
         }
 
         public void Run(string[] args)
         {
-            _writer.WriteLine($"Started OWML v{_owmlManifest.Version}");
-            _writer.WriteLine("For detailed log, see Logs/OWML.Log.txt");
+            _writer.WriteLine($"Started OWML v{_owmlManifest.Version}", MessageType.Info);
 
             LocateGamePath();
 
             CopyGameFiles();
 
             CreateLogsDirectory();
 
-            var hasPortArgument = CommandLineArguments.HasArgument(Constants.ConsolePortArgument);
-            if (!hasPortArgument)
-            {
-                ListenForOutput();
-            }
-
             var mods = _modFinder.GetMods();
 
             ShowModList(mods);
@@ -59,6 +50,7 @@ public void Run(string[] args)
 
             StartGame(args);
 
+            var hasPortArgument = CommandLineArguments.HasArgument(Constants.ConsolePortArgument);
             if (hasPortArgument)
             {
                 ExitConsole();
@@ -88,22 +80,23 @@ private void CopyGameFiles()
             _writer.WriteLine("Game files copied.");
         }
 
-        private void ShowModList(IList<IModData> mods)
+        private void ShowModList(List<IModData> mods)
         {
             if (!mods.Any())
             {
-                _writer.WriteLine("Warning: found no mods.");
+                _writer.WriteLine("Warning - No mods found.", MessageType.Warning);
                 return;
             }
             _writer.WriteLine("Found mods:");
             foreach (var modData in mods)
             {
-                var stateText = modData.Config.Enabled ? "" : "(disabled)";
-                _writer.WriteLine($"* {modData.Manifest.UniqueName} v{modData.Manifest.Version} {stateText}");
+                var stateText = modData.Enabled ? "" : "(disabled)";
+                var type = modData.Enabled ? MessageType.Message : MessageType.Warning;
+                _writer.WriteLine($"* {modData.Manifest.UniqueName} v{modData.Manifest.Version} {stateText}", type);
 
                 if (!string.IsNullOrEmpty(modData.Manifest.OWMLVersion) && !IsMadeForSameOwmlMajorVersion(modData.Manifest))
                 {
-                    _writer.WriteLine($"  Warning: made for old version of OWML: v{modData.Manifest.OWMLVersion}");
+                    _writer.WriteLine($"  Warning - Made for old version of OWML: v{modData.Manifest.OWMLVersion}", MessageType.Warning);
                 }
             }
         }
@@ -117,34 +110,15 @@ private bool IsMadeForSameOwmlMajorVersion(IModManifest manifest)
                    owmlVersionSplit[1] == modVersionSplit[1];
         }
 
-        private void ListenForOutput()
+        private bool HasVrMod(List<IModData> mods)
         {
-            _listener.OnOutput += OnOutput;
-            _listener.Start();
-        }
-
-        private void OnOutput(string s)
-        {
-            var lines = s.Split(new[] { Environment.NewLine }, StringSplitOptions.RemoveEmptyEntries);
-            foreach (var line in lines)
-            {
-                _writer.WriteLine(line);
-                if (line.EndsWith(Constants.QuitKeyPhrase))
-                {
-                    ExitConsole();
-                }
-            }
-        }
-
-        private bool HasVrMod(IList<IModData> mods)
-        {
-            var vrMod = mods.FirstOrDefault(x => x.Config.RequireVR && x.Config.Enabled);
+            var vrMod = mods.FirstOrDefault(x => x.RequireVR && x.Config.Enabled);
             var hasVrMod = vrMod != null;
             _writer.WriteLine(hasVrMod ? $"{vrMod.Manifest.UniqueName} requires VR." : "No mods require VR.");
             return hasVrMod;
         }
 
-        private void PatchGame(IList<IModData> mods)
+        private void PatchGame(List<IModData> mods)
         {
             _owPatcher.PatchGame();
 
@@ -155,20 +129,29 @@ private void PatchGame(IList<IModData> mods)
             }
             catch (Exception ex)
             {
-                _writer.WriteLine($"Error while applying VR patch: {ex}");
+                _writer.WriteLine($"Error while applying VR patch: {ex}", MessageType.Error);
             }
         }
 
         private void StartGame(string[] args)
         {
             _writer.WriteLine("Starting game...");
+
+            if (args.Contains("-consolePort"))
+            {
+                var index = Array.IndexOf(args, "-consolePort");
+                var list = new List<string>(args);
+                list.RemoveRange(index, 2);
+                args = list.ToArray();
+            }
+
             try
             {
                 Process.Start($"{_owmlConfig.GamePath}/OuterWilds.exe", string.Join(" ", args));
             }
             catch (Exception ex)
             {
-                _writer.WriteLine("Error while starting game: " + ex.Message);
+                _writer.WriteLine($"Error while starting game: {ex.Message}", MessageType.Error);
             }
         }
 

diff --git a/OWML.Launcher/OWML.DefaultConfig.json b/OWML.Launcher/OWML.DefaultConfig.json
@@ -1,5 +1,5 @@
 {
   "gamePath": "C:/Program Files/Epic Games/OuterWilds",
-  "verbose": true,
-  "combinationsBlockInput": false
+  "combinationsBlockInput": false,
+  "socketPort": 0
 }
diff --git a/OWML.Launcher/OWML.Launcher.csproj b/OWML.Launcher/OWML.Launcher.csproj
@@ -50,9 +50,9 @@
   </ItemGroup>
   <ItemGroup>
     <Compile Include="App.cs" />
-    <Compile Include="OutputListener.cs" />
     <Compile Include="Program.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />
+    <Compile Include="SocketListener.cs" />
   </ItemGroup>
   <ItemGroup>
     <None Include="App.config" />