diff --git a/NewHorizons/External/Configs/AddonConfig.cs b/NewHorizons/External/Configs/AddonConfig.cs
index 54d8cf0e..cfcc731b 100644
--- a/NewHorizons/External/Configs/AddonConfig.cs
+++ b/NewHorizons/External/Configs/AddonConfig.cs
@@ -31,5 +31,17 @@ namespace NewHorizons.External.Configs
/// If popupMessage is set, should it repeat every time the game starts or only once
///
public bool repeatPopup;
+
+ ///
+ /// These asset bundles will be loaded on the title screen and stay loaded. Will improve initial load time at the cost of increased memory use.
+ /// The path is the relative directory of the asset bundle in the mod folder.
+ ///
+ public string[] preloadAssetBundles;
+
+ ///
+ /// The path to the addons subtitle for the main menu.
+ /// Defaults to "subtitle.png".
+ ///
+ public string subtitlePath = "subtitle.png";
}
}
diff --git a/NewHorizons/Handlers/SubtitlesHandler.cs b/NewHorizons/Handlers/SubtitlesHandler.cs
index fc4bfe94..de283b54 100644
--- a/NewHorizons/Handlers/SubtitlesHandler.cs
+++ b/NewHorizons/Handlers/SubtitlesHandler.cs
@@ -61,9 +61,17 @@ namespace NewHorizons.Handlers
private void AddSubtitles()
{
- foreach (var mod in Main.MountedAddons.Where(mod => File.Exists($"{mod.ModHelper.Manifest.ModFolderPath}subtitle.png")))
+ foreach (var mod in Main.MountedAddons)
{
- AddSubtitle(mod, "subtitle.png");
+ if (Main.AddonConfigs.TryGetValue(mod, out var addonConfig) && File.Exists(Path.Combine(mod.ModHelper.Manifest.ModFolderPath, addonConfig.subtitlePath)))
+ {
+ AddSubtitle(mod, addonConfig.subtitlePath);
+ }
+ // Else default to subtitle.png
+ else if (File.Exists(Path.Combine(mod.ModHelper.Manifest.ModFolderPath, "subtitle.png")))
+ {
+ AddSubtitle(mod, "subtitle.png");
+ }
}
}
diff --git a/NewHorizons/Main.cs b/NewHorizons/Main.cs
index 92509469..ee07514f 100644
--- a/NewHorizons/Main.cs
+++ b/NewHorizons/Main.cs
@@ -50,9 +50,10 @@ namespace NewHorizons
private static bool _wasConfigured = false;
private static string _defaultSystemOverride;
- public static Dictionary SystemDict = new Dictionary();
- public static Dictionary> BodyDict = new Dictionary>();
- public static List MountedAddons = new List();
+ public static Dictionary SystemDict = new();
+ public static Dictionary> BodyDict = new();
+ public static List MountedAddons = new();
+ public static Dictionary AddonConfigs = new();
public static float SecondsElapsedInLoop = -1;
@@ -747,6 +748,15 @@ namespace NewHorizons
{
MenuHandler.RegisterOneTimePopup(mod, TranslationHandler.GetTranslation(addonConfig.popupMessage, TranslationHandler.TextType.UI), addonConfig.repeatPopup);
}
+ if (addonConfig.preloadAssetBundles != null)
+ {
+ foreach (var bundle in addonConfig.preloadAssetBundles)
+ {
+ AssetBundleUtilities.PreloadBundle(bundle, mod);
+ }
+ }
+
+ AddonConfigs[mod] = addonConfig;
}
private void LoadTranslations(string folder, IModBehaviour mod)
diff --git a/NewHorizons/NewHorizonsApi.cs b/NewHorizons/NewHorizonsApi.cs
index e5507abc..a96673d5 100644
--- a/NewHorizons/NewHorizonsApi.cs
+++ b/NewHorizons/NewHorizonsApi.cs
@@ -28,7 +28,6 @@ using static NewHorizons.External.Modules.ShipLogModule;
namespace NewHorizons
{
-
public class NewHorizonsApi : INewHorizons
{
[Obsolete("Create(Dictionary config) is deprecated, please use LoadConfigs(IModBehaviour mod) instead")]
diff --git a/NewHorizons/Patches/EyeScenePatches/SubmitActionLoadScenePatches.cs b/NewHorizons/Patches/EyeScenePatches/SubmitActionLoadScenePatches.cs
index 9feba169..891f439c 100644
--- a/NewHorizons/Patches/EyeScenePatches/SubmitActionLoadScenePatches.cs
+++ b/NewHorizons/Patches/EyeScenePatches/SubmitActionLoadScenePatches.cs
@@ -1,4 +1,5 @@
using HarmonyLib;
+using NewHorizons.Utility.Files;
using NewHorizons.Utility.OWML;
namespace NewHorizons.Patches.EyeScenePatches
@@ -6,10 +7,18 @@ namespace NewHorizons.Patches.EyeScenePatches
[HarmonyPatch(typeof(SubmitActionLoadScene))]
public static class SubmitActionLoadScenePatches
{
+ // To call the base method
+ [HarmonyReversePatch]
+ [HarmonyPatch(typeof(SubmitActionConfirm), nameof(SubmitActionConfirm.ConfirmSubmit))]
+ public static void SubmitActionConfirm_ConfirmSubmit(SubmitActionConfirm instance) { }
+
+
[HarmonyPrefix]
[HarmonyPatch(nameof(SubmitActionLoadScene.ConfirmSubmit))]
- public static void SubmitActionLoadScene_ConfirmSubmit(SubmitActionLoadScene __instance)
+ public static bool SubmitActionLoadScene_ConfirmSubmit(SubmitActionLoadScene __instance)
{
+ if (__instance._receivedSubmitAction) return false;
+
// Title screen can warp you to eye and cause problems.
if (__instance._sceneToLoad == SubmitActionLoadScene.LoadableScenes.EYE)
{
@@ -17,6 +26,44 @@ namespace NewHorizons.Patches.EyeScenePatches
Main.Instance.IsWarpingBackToEye = true;
__instance._sceneToLoad = SubmitActionLoadScene.LoadableScenes.GAME;
}
+
+ // modified from patched function
+ SubmitActionConfirm_ConfirmSubmit(__instance);
+ __instance._receivedSubmitAction = true;
+ Locator.GetMenuInputModule().DisableInputs();
+
+ Delay.RunWhen(() =>
+ {
+ // update text. just use 0%
+ __instance.ResetStringBuilder();
+ __instance._nowLoadingSB.Append(UITextLibrary.GetString(UITextType.LoadingMessage));
+ __instance._nowLoadingSB.Append(0.ToString("P0"));
+ __instance._loadingText.text = __instance._nowLoadingSB.ToString();
+
+ return AssetBundleUtilities.AreRequiredAssetsLoaded();
+ }, () =>
+ {
+ switch (__instance._sceneToLoad)
+ {
+ case SubmitActionLoadScene.LoadableScenes.GAME:
+ LoadManager.LoadSceneAsync(OWScene.SolarSystem, false, LoadManager.FadeType.ToBlack, 1f, false);
+ __instance.ResetStringBuilder();
+ __instance._waitingOnStreaming = true;
+ break;
+ case SubmitActionLoadScene.LoadableScenes.EYE:
+ LoadManager.LoadSceneAsync(OWScene.EyeOfTheUniverse, true, LoadManager.FadeType.ToBlack, 1f, false);
+ __instance.ResetStringBuilder();
+ break;
+ case SubmitActionLoadScene.LoadableScenes.TITLE:
+ LoadManager.LoadScene(OWScene.TitleScreen, LoadManager.FadeType.ToBlack, 2f, true);
+ break;
+ case SubmitActionLoadScene.LoadableScenes.CREDITS:
+ LoadManager.LoadScene(OWScene.Credits_Fast, LoadManager.FadeType.ToBlack, 1f, false);
+ break;
+ }
+ });
+
+ return false;
}
}
}
diff --git a/NewHorizons/Schemas/addon_manifest_schema.json b/NewHorizons/Schemas/addon_manifest_schema.json
index aada816a..dec9022f 100644
--- a/NewHorizons/Schemas/addon_manifest_schema.json
+++ b/NewHorizons/Schemas/addon_manifest_schema.json
@@ -27,6 +27,17 @@
"type": "boolean",
"description": "If popupMessage is set, should it repeat every time the game starts or only once"
},
+ "preloadAssetBundles": {
+ "type": "array",
+ "description": "These asset bundles will be loaded on the title screen and stay loaded. Will improve initial load time at the cost of increased memory use.\nThe path is the relative directory of the asset bundle in the mod folder.",
+ "items": {
+ "type": "string"
+ }
+ },
+ "subtitlePath": {
+ "type": "string",
+ "description": "The path to the addons subtitle for the main menu.\nDefaults to \"subtitle.png\"."
+ },
"$schema": {
"type": "string",
"description": "The schema to validate with"
diff --git a/NewHorizons/Utility/Files/AssetBundleUtilities.cs b/NewHorizons/Utility/Files/AssetBundleUtilities.cs
index 182826ba..104d7393 100644
--- a/NewHorizons/Utility/Files/AssetBundleUtilities.cs
+++ b/NewHorizons/Utility/Files/AssetBundleUtilities.cs
@@ -3,24 +3,57 @@ using OWML.Common;
using System;
using System.Collections.Generic;
using System.IO;
+using System.Linq;
using UnityEngine;
namespace NewHorizons.Utility.Files
{
public static class AssetBundleUtilities
{
- public static Dictionary AssetBundles = new Dictionary();
+ public static Dictionary AssetBundles = new();
+
+ private static readonly List _loadingBundles = new();
public static void ClearCache()
{
foreach (var pair in AssetBundles)
{
- if (pair.Value == null) NHLogger.LogError($"The asset bundle for {pair.Key} was null when trying to unload");
- else pair.Value.Unload(true);
+ if (!pair.Value.keepLoaded)
+ {
+ if (pair.Value.bundle == null)
+ {
+ NHLogger.LogError($"The asset bundle for {pair.Key} was null when trying to unload");
+ }
+ else
+ {
+ pair.Value.bundle.Unload(true);
+ }
+ }
+
}
- AssetBundles.Clear();
+ AssetBundles = AssetBundles.Where(x => x.Value.keepLoaded).ToDictionary(x => x.Key, x => x.Value);
}
+ public static void PreloadBundle(string assetBundleRelativeDir, IModBehaviour mod)
+ {
+ string key = Path.GetFileName(assetBundleRelativeDir);
+ var completePath = Path.Combine(mod.ModHelper.Manifest.ModFolderPath, assetBundleRelativeDir);
+ var request = AssetBundle.LoadFromFileAsync(completePath);
+ _loadingBundles.Add(request);
+ NHLogger.Log($"Preloading bundle {assetBundleRelativeDir} - {_loadingBundles.Count} left");
+ request.completed += _ =>
+ {
+ _loadingBundles.Remove(request);
+ NHLogger.Log($"Finshed preloading bundle {assetBundleRelativeDir} - {_loadingBundles.Count} left");
+ AssetBundles[key] = (request.assetBundle, true);
+ };
+ }
+
+ ///
+ /// are preloaded bundles done loading?
+ ///
+ public static bool AreRequiredAssetsLoaded() => _loadingBundles.Count == 0;
+
public static T Load(string assetBundleRelativeDir, string pathInBundle, IModBehaviour mod) where T : UnityEngine.Object
{
string key = Path.GetFileName(assetBundleRelativeDir);
@@ -32,7 +65,7 @@ namespace NewHorizons.Utility.Files
if (AssetBundles.ContainsKey(key))
{
- bundle = AssetBundles[key];
+ bundle = AssetBundles[key].bundle;
}
else
{
@@ -44,7 +77,7 @@ namespace NewHorizons.Utility.Files
return null;
}
- AssetBundles[key] = bundle;
+ AssetBundles[key] = (bundle, false);
}
obj = bundle.LoadAsset(pathInBundle);
@@ -124,4 +157,4 @@ namespace NewHorizons.Utility.Files
}
}
}
-}
+}
\ No newline at end of file