Main Menu level sets (v1.1.4.0)

New Options:
* Main Menu playlists (and level sets) can be selected as the main menu (from the Playlist/Level Set Options menu). Levels are randomly chosen based on the setting below.
* Decide Main Menu on Startup - Level set main menus will only choose a random level during each startup. Otherwise, random levels will be decided every time the main menu loads.

Fixes:
* The Playlist Options button had some faulty logic that prevented it from showing up in the Choose Main Menu level grid.
* Mod state settings are now properly changed after renaming/deleting a playlist file.

Refactors:
* Apparently LevelSetOptionsMenu wasn't modular enough. So pain has been added to the equation (Controls are initialized once, but after that you can't pick and choose controls. You need a separate menu for each setup.)

Author: trigger-segfault

Distance.LevelSelectAdditions/ConfigurationLogic.cs

@@ -1,4 +1,5 @@
 using Distance.LevelSelectAdditions.Events;
+using Distance.LevelSelectAdditions.Extensions;
 using Distance.LevelSelectAdditions.Sorting;
 using Reactor.API.Configuration;
 using System;
@@ -164,6 +165,28 @@ public bool FixLevelSelectScrollBug
 			set => Set(State_LastLevelSets_ID, value);
 		}
 
+
+		private const string ProfileMainMenuLevelSets_ID = "profile.mainmenu_levelsets";
+		public Dictionary<string, string> ProfileMainMenuLevelSets
+		{
+			get => Convert(ProfileMainMenuLevelSets_ID, new Dictionary<string, string>(), overwriteNull: true);
+			set => Set(ProfileMainMenuLevelSets_ID, value);
+		}
+
+		private const string State_LastProfileMainMenuLevels_ID = "state.last_mainmenu_levels";
+		public Dictionary<string, string> State_LastProfileMainMenuLevels
+		{
+			get => Convert(State_LastProfileMainMenuLevels_ID, new Dictionary<string, string>(), overwriteNull: true);
+			set => Set(State_LastProfileMainMenuLevels_ID, value);
+		}
+
+		private const string RandomStartupMainMenu_ID = "profile.random_startup_mainmenu";
+		public bool RandomStartupMainMenu
+		{
+			get => Get<bool>(RandomStartupMainMenu_ID);
+			set => Set(RandomStartupMainMenu_ID, value);
+		}
+
 		#endregion
 
 		#region Helpers
@@ -192,23 +215,65 @@ public string GetStateLastLevelSetID(LevelSelectMenuAbstract.DisplayType display
 		{
 			if (State_LastLevelSetIDs.TryGetValue(displayType, out var lastPlaylists_mode))
 			{
-				if (lastPlaylists_mode.TryGetValue(modeID, out string pathName))
+				if (lastPlaylists_mode.TryGetValue(modeID, out string levelSetID))
 				{
-					return pathName;
+					return levelSetID;
 				}
 			}
 			return null;
 		}
 
-		public void SetStateLastLevelSetID(LevelSelectMenuAbstract.DisplayType displayType, GameModeID modeID, string pathName)
+		public void SetStateLastLevelSetID(LevelSelectMenuAbstract.DisplayType displayType, GameModeID modeID, string levelSetID)
 		{
 			var lastPlaylists_display = State_LastLevelSetIDs;
 			if (!lastPlaylists_display.TryGetValue(displayType, out Dictionary<GameModeID, string> lastPlaylists_mode))
 			{
 				lastPlaylists_mode = new Dictionary<GameModeID, string>();
 				lastPlaylists_display[displayType] = lastPlaylists_mode;
 			}
-			lastPlaylists_mode[modeID] = pathName;
+			lastPlaylists_mode[modeID] = levelSetID;
+			this.Save(); // auto save
+		}
+
+		public string GetProfileMainMenuRelativePathID(string profileName)
+		{
+			if (this.ProfileMainMenuLevelSets.TryGetValue(profileName, out string relativePathID))
+			{
+				return relativePathID;
+			}
+			return null;
+		}
+
+		// Returns true if the level set was changed.
+		public bool SetProfileMainMenuRelativePathID(string profileName, string relativePathID)
+		{
+			var profileMainMenuLevelSets = this.ProfileMainMenuLevelSets;
+			if (profileMainMenuLevelSets.TryGetValue(profileName, out string oldRelativePathID))
+			{
+				if (relativePathID == oldRelativePathID)
+				{
+					return false;
+				}
+			}
+			// Clear state for last level used.
+			this.SetStateLastMainMenuLevelRelativePath(profileName, null);
+			profileMainMenuLevelSets[profileName] = relativePathID;
+			this.Save(); // auto save
+			return true;
+		}
+
+		public string GetStateLastMainMenuLevelRelativePath(string profileName)
+		{
+			if (this.State_LastProfileMainMenuLevels.TryGetValue(profileName, out string relativeLevelPath))
+			{
+				return relativeLevelPath;
+			}
+			return null;
+		}
+
+		public void SetStateLastMainMenuLevelRelativePath(string profileName, string relativeLevelPath)
+		{
+			this.State_LastProfileMainMenuLevels[profileName] = relativeLevelPath;
 			this.Save(); // auto save
 		}
 
@@ -238,7 +303,19 @@ private void OnPlaylistFileRenamed(PlaylistFileRenamed.Data data)
 				}
 			}
 
+			var profileMainMenuLevelSets = this.ProfileMainMenuLevelSets;
+			// Use ToArray to enumerate with foreach and allow updating values.
+			foreach (var profilePair in profileMainMenuLevelSets.ToArray())
+			{
+				if (string.Equals(profilePair.Value, data.oldLevelSetID, StringComparison.InvariantCultureIgnoreCase))
+				{
+					profileMainMenuLevelSets[profilePair.Key] = data.playlist.GetRelativePathID();
+				}
+			}
+
 			//TODO: When LevelSetOptions dictionary gets added, enumerate over and rename here too.
+
+			this.Save(); // auto save
 		}
 
 		private void OnPlaylistFileDeleted(PlaylistFileDeleted.Data data)
@@ -256,7 +333,19 @@ private void OnPlaylistFileDeleted(PlaylistFileDeleted.Data data)
 				}
 			}
 
+			var profileMainMenuLevelSets = this.ProfileMainMenuLevelSets;
+			// Use ToArray to enumerate with foreach and allow updating values.
+			foreach (var profilePair in profileMainMenuLevelSets.ToArray())
+			{
+				if (string.Equals(profilePair.Value, data.levelSetID, StringComparison.InvariantCultureIgnoreCase))
+				{
+					profileMainMenuLevelSets[profilePair.Key] = null;
+				}
+			}
+
 			//TODO: When LevelSetOptions dictionary gets added, enumerate over and delete here too.
+
+			this.Save(); // auto save
 		}
 
 		public void Awake()
@@ -283,6 +372,7 @@ public void Awake()
 			Get(EnableRateWorkshopLevelButton_ID, true);
 			Get(HideChooseMainMenuUnusedButtons_ID, true);
 			//Get(FixLevelSelectScrollBug_ID, true); // Always enable this fix
+			Get(RandomStartupMainMenu_ID, false);
 
 			// Save settings, and any defaults that may have been added.
 			Save();

Distance.LevelSelectAdditions/Distance.LevelSelectAdditions.csproj

@@ -99,6 +99,7 @@
     <Compile Include="Harmony\Assembly-CSharp\LevelGridMenu\CreateAndAddLevelSet.cs" />
     <Compile Include="Harmony\Assembly-CSharp\LevelGridMenu\CreateEntries.cs" />
     <Compile Include="Harmony\Assembly-CSharp\LevelGridMenu\Display.cs" />
+    <Compile Include="Harmony\Assembly-CSharp\LevelGridMenu\OnGridCellClicked.cs" />
     <Compile Include="Harmony\Assembly-CSharp\LevelGridMenu\OnLevelEntrySelected.cs" />
     <Compile Include="Harmony\Assembly-CSharp\LevelGridMenu\PlaylistEntry\ctor.cs" />
     <Compile Include="Harmony\Assembly-CSharp\LevelGridMenu\PlaylistEntry\get_Color_.cs" />
@@ -117,7 +118,9 @@
     <Compile Include="Harmony\Assembly-CSharp\LevelSelectMenuLogic\Start.cs" />
     <Compile Include="Harmony\Assembly-CSharp\LevelSelectMenuLogic\StartPlaylist.cs" />
     <Compile Include="Harmony\Assembly-CSharp\LevelSelectMenuLogic\UpdateInput.cs" />
+    <Compile Include="Harmony\Assembly-CSharp\MainMenuLogic\Start.cs" />
     <Compile Include="Harmony\Assembly-CSharp\OptionsMenuLogic\GetSubmenus.cs" />
+    <Compile Include="Helpers\MainMenuLevelSetHelper.cs" />
     <Compile Include="Helpers\Sanitizer.cs" />
     <Compile Include="Mod.cs" />
     <Compile Include="Scripts\LevelPlaylistEntryUpdateLogic.cs" />

Distance.LevelSelectAdditions/Extensions/Assembly-CSharp/LevelPlaylist.cs

@@ -75,32 +75,76 @@ public static bool IsPersonalLevelSet(this LevelPlaylist playlist)
 		public const string IDPrefixName      = "name" + IDPrefixSeparator;
 
 
-		public static string GetLevelSetID(this LevelPlaylist playlist)
+		public static string GetLevelSetID(this LevelPlaylist playlist, bool relativePath = false)
 		{
+			string result;
+
 			var playlistData = playlist.GetComponent<LevelPlaylistCompoundData>();
 			if (playlistData && playlistData.FilePath != null)
 			{
 				string path = new FileInfo(playlistData.FilePath).FullName.UniformPathSeparators();
 				string resourcesPath = new DirectoryInfo(Path.Combine(Application.dataPath, "Resources")).FullName.UniformPathSeparatorsTrimmed() + "/";
+				string personalPath = new DirectoryInfo(Resource.personalDistanceDirPath_).FullName.UniformPathSeparatorsTrimmed() + "/";
 
 				// Only assign if we have a FilePath to determine with,
 				//  otherwise assume its a resource playlist until a FileName may be assigned.
 				if (path.StartsWith(resourcesPath, StringComparison.InvariantCultureIgnoreCase))
 				{
-					return IDPrefixResources + path.Substring(resourcesPath.Length/* + 1*/).ToLowerInvariant();
+					result = IDPrefixResources + path.Substring(resourcesPath.Length/* + 1*/);
+				}
+				else if (path.StartsWith(personalPath, StringComparison.InvariantCultureIgnoreCase))
+				{
+					result = IDPrefixPersonal + path.Substring(personalPath.Length/* + 1*/);
+				}
+				else
+				{
+					result = IDPrefixPath + path;
 				}
+			}
+			else
+			{
+				result = IDPrefixName + playlist.Name_;
+			}
 
-				string personalPath = new DirectoryInfo(Resource.personalDistanceDirPath_).FullName.UniformPathSeparatorsTrimmed() + "/";
+			if (!relativePath)
+			{
+				result = result.ToLowerInvariant();
+			}
+			return result;
+		}
+
+		public static string GetRelativePathID(this LevelPlaylist playlist) => playlist.GetLevelSetID(true);
+
+		public static string RelativePathIDToAbsolutePath(this string relativePathID, out bool isName)
+		{
+			string[] parts = relativePathID.Split(new string[] { IDPrefixSeparator }, 2, StringSplitOptions.None);
+			if (parts.Length == 2)
+			{
+				string prefix = parts[0] + IDPrefixSeparator;
+				string relativePath = parts[parts.Length - 1];
 
-				if (path.StartsWith(personalPath, StringComparison.InvariantCultureIgnoreCase))
+				switch (prefix)
 				{
-					return IDPrefixPersonal + path.Substring(personalPath.Length/* + 1*/).ToLowerInvariant();
-				}
+				case IDPrefixResources:
+					isName = false;
+					return Path.Combine(new DirectoryInfo(Path.Combine(Application.dataPath, "Resources")).FullName, relativePath);
 
-				return IDPrefixPath + path.ToLowerInvariant();
+				case IDPrefixPersonal:
+					isName = false;
+					return Path.Combine(new DirectoryInfo(Resource.personalDistanceDirPath_).FullName, relativePath);
+
+				case IDPrefixPath:
+					isName = false;
+					return relativePath;
+
+				case IDPrefixName:
+					isName = true;
+					return relativePath;
+				}
 			}
 
-			return IDPrefixName + playlist.Name_.ToLowerInvariant();
+			isName = false;
+			return null;
 		}
 
 		/*public static bool IsLevelSetID(this LevelPlaylist playlist, string otherLevelSetID)

Distance.LevelSelectAdditions/Harmony/Assembly-CSharp/LevelGridGrid/PushGrid.cs

@@ -45,11 +45,15 @@ internal static IEnumerable<CodeInstruction> Transpiler(IEnumerable<CodeInstruct
 					// Before:  ldloc. (menuPanel)
 					// Before:  callvirt MenuPanel.Push
 					// NOTE: (i - 3) to insert before the ldloc used to call the MenuPanel.Push instance method.
+					// MOVE LABELS FROM ldloc. TO ldarg.0
+					var labels = new List<Label>(codes[i - 3].labels);
+					codes[i - 3].labels.Clear();
 					codes.InsertRange(i - 3, new CodeInstruction[]
 					{
 						new CodeInstruction(OpCodes.Ldarg_0, null),
 						new CodeInstruction(OpCodes.Call, typeof(LevelGridGrid__PushGrid).GetMethod(nameof(AddMenuPanelButtons_))),
 					});
+					codes[i - 3].labels.AddRange(labels);
 
 					break;
 				}
@@ -66,13 +70,14 @@ public static void AddMenuPanelButtons_(LevelGridGrid levelGridGrid)
 			if (Mod.Instance.Config.EnableLevelSetOptionsMenu)
 			{
 				MenuPanel menuPanel = levelGridGrid.gridPanel_.GetComponent<MenuPanel>();
-				if (menuPanel && !levelGridGrid.levelGridMenu_.IsSimpleMenu_)
+				bool isMainMenu = levelGridGrid.levelGridMenu_.displayType_ == LevelSelectMenuAbstract.DisplayType.ChooseMainMenuLevel;
+				if (menuPanel && (!levelGridGrid.levelGridMenu_.IsSimpleMenu_ || isMainMenu))
 				{
 					if (!levelGridGrid.playlist_.IsResourcesPlaylist())
 					{
 						menuPanel.SetBottomLeftButton(InputAction.MenuStart, "PLAYLIST\nOPTIONS");
 					}
-					else if (Mod.BasicLevelSetOptionsSupported)
+					else if (Mod.BasicLevelSetOptionsSupported || isMainMenu)
 					{
 						menuPanel.SetBottomLeftButton(InputAction.MenuStart, "LEVEL SET\nOPTIONS");
 					}

Distance.LevelSelectAdditions/Harmony/Assembly-CSharp/LevelGridMenu/OnGridCellClicked.cs

@@ -0,0 +1,26 @@
+using Distance.LevelSelectAdditions.Helpers;
+using HarmonyLib;
+
+namespace Distance.LevelSelectAdditions.Harmony
+{
+	/// <summary>
+	/// Patch to handle resetting the selected main menu (to remove level set selections).
+	/// </summary>
+	[HarmonyPatch(typeof(LevelGridMenu), nameof(LevelGridMenu.OnGridCellClicked))]
+	internal static class LevelGridMenu__OnGridCellClicked
+	{
+		[HarmonyPrefix]
+		internal static void Prefix(LevelGridMenu __instance)
+		{
+			if (__instance.levelSelectFinished_)
+			{
+				return;
+			}
+			if (__instance.displayType_ == LevelSelectMenuAbstract.DisplayType.ChooseMainMenuLevel)
+			{
+				// Clear level set used as main menu. The user has selected an individual level as their main menu.
+				MainMenuLevelSetHelper.SetMainMenuLevelSet(null);
+			}
+		}
+	}
+}

Distance.LevelSelectAdditions/Harmony/Assembly-CSharp/LevelSelectMenuLogic/OnLevelButtonClicked.cs

@@ -1,4 +1,5 @@
-using HarmonyLib;
+using Distance.LevelSelectAdditions.Helpers;
+using HarmonyLib;
 using System.Collections.Generic;
 using System.Linq;
 using System.Reflection;
@@ -8,10 +9,25 @@ namespace Distance.LevelSelectAdditions.Harmony
 {
 	/// <summary>
 	/// Patch to enable adding a selected level in Playlist Mode while in the Choose Main Menu level display type.
+	/// <para/>
+	/// Also includes patch to handle resetting the selected main menu (to remove level set selections).
 	/// </summary>
 	[HarmonyPatch(typeof(LevelSelectMenuLogic), nameof(LevelSelectMenuLogic.OnLevelButtonClicked))]
 	internal static class LevelSelectMenuLogic__OnLevelButtonClicked
 	{
+		[HarmonyPrefix]
+		internal static void Prefix(LevelSelectMenuLogic __instance)
+		{
+			if (__instance.CurrentLevelLocked_)
+			{
+				return;
+			}
+			if (__instance.displayType_ == LevelSelectMenuAbstract.DisplayType.ChooseMainMenuLevel)
+			{
+				MainMenuLevelSetHelper.SetMainMenuLevelSet(null);
+			}
+		}
+
 		[HarmonyTranspiler]
 		internal static IEnumerable<CodeInstruction> Transpiler(IEnumerable<CodeInstruction> instructions)
 		{

Distance.LevelSelectAdditions/Harmony/Assembly-CSharp/MainMenuLogic/Start.cs

@@ -0,0 +1,18 @@
+using Distance.LevelSelectAdditions.Helpers;
+using HarmonyLib;
+
+namespace Distance.LevelSelectAdditions.Harmony
+{
+	/// <summary>
+	/// Patch to trigger changing the level set main menu level.
+	/// </summary>
+	[HarmonyPatch(typeof(MainMenuLogic), nameof(MainMenuLogic.Start))]
+	internal static class MainMenuLogic__Start
+	{
+		[HarmonyPrefix]
+		internal static void Prefix(MainMenuLogic __instance)
+		{
+			MainMenuLevelSetHelper.ChooseNextMainMenu();
+		}
+	}
+}