Simplify configuration and commands

Remove enabled property in favor of checking for 'never'. Autosave on console command use. Remove save/load commands

.editorconfig

@@ -0,0 +1,8 @@
+# https://editorconfig.org/
+
+root = true
+
+[*.cs]
+insert_final_newline = true
+indent_style = tab
+tab_width = 4

Config.cs

@@ -2,7 +2,6 @@
 using System;
 using System.IO;
 using System.Reflection;
-using System.Web;
 using UnityEngine;
 
 namespace DiamondTimeViewer
@@ -19,8 +18,8 @@ namespace DiamondTimeViewer
 	{
 		private const string CONFIG_FILE_NAME = "config.json";
 
-		public static bool Enabled = true;
 		public static DisplayMode Mode = DisplayMode.Diamond;
+		public static bool HideSilver = false;
 
 		public static void Init()
 		{
@@ -46,9 +45,6 @@ namespace DiamondTimeViewer
 				return;
 			}
 
-			if (data["enabled"] != null)
-				Enabled = data["enabled"].AsBool;
-
 			if (data["mode"] != null)
 			{
 				string mode = data["mode"].Value.ToLower();
@@ -69,12 +65,14 @@ namespace DiamondTimeViewer
 						break;
 				}
 			}
+
+			if (data["hideSilver"] != null)
+				HideSilver = data["hideSilver"].AsBool;
 		}
 
 		public static void SaveConfig()
 		{
 			JSONNode node = new JSONClass();
-			node.Add("enabled", Enabled ? "true" : "false");
 			switch(Mode)
 			{
 				case DisplayMode.Never:
@@ -90,7 +88,8 @@ namespace DiamondTimeViewer
 					node.Add("mode", "always");
 					break;
 			}
-			File.WriteAllText(GetConfigPath(), node.ToString());
+			node.Add("hideSilver", HideSilver ? "true" : "false");
+			File.WriteAllText(GetConfigPath(), JsonHelper.FormatJson(node.ToString(), "\t"));
 		}
 
 		public static string GetConfigPath()

ConsoleCommands.cs

@@ -1,5 +1,4 @@
 using MIU;
-using System;
 
 namespace DiamondTimeViewer
 {
@@ -9,16 +8,13 @@ namespace DiamondTimeViewer
 		{
 			MIU.Console.Instance.Write("Usage: dtv [value]");
 			MIU.Console.Instance.Write("Possible values:");
-			MIU.Console.Instance.Write("  never     Never show diamond times");
-			MIU.Console.Instance.Write("  diamond   Show once you've achieved diamond time");
-			MIU.Console.Instance.Write("  gold      Show once you've achieved gold time");
-			MIU.Console.Instance.Write("  always    Always show diamond time");
+			MIU.Console.Instance.Write("  never       Never show diamond times");
+			MIU.Console.Instance.Write("  diamond     Show once you've achieved diamond time");
+			MIU.Console.Instance.Write("  gold        Show once you've achieved gold time");
+			MIU.Console.Instance.Write("  always      Always show diamond time");
 			MIU.Console.Instance.Write("");
-			MIU.Console.Instance.Write("  enabled   Enable the mod");
-			MIU.Console.Instance.Write("  disabled  Disable the mod entirely");
-			MIU.Console.Instance.Write("");
-			MIU.Console.Instance.Write("  save      Saves the current config");
-			MIU.Console.Instance.Write("  load      Loads the config file");
+			MIU.Console.Instance.Write("  hideSilver  Hide silver when showing diamond");
+			MIU.Console.Instance.Write("  showSilver  Show silver always");
 		}
 
 		[ConsoleCommand(description = "Configures the Diamond Time Viewer", paramsDescription = "[value]")]
@@ -32,36 +28,42 @@ namespace DiamondTimeViewer
 
 			string value = args[0];
 
+			string message;
+
 			switch (value)
 			{
 				case "never":
 					Config.Mode = DisplayMode.Never;
-					return "mode set to: never";
+					message = "mode set to: never";
+					break;
 				case "diamond":
 					Config.Mode = DisplayMode.Diamond;
-					return "mode set to: diamond";
+					message = "mode set to: diamond";
+					break;
 				case "gold":
 					Config.Mode = DisplayMode.Gold;
-					return "mode set to: gold";
+					message = "mode set to: gold";
+					break;
 				case "always":
 					Config.Mode = DisplayMode.Always;
-					return "mode set to: always";
-				case "enabled":
-					Config.Enabled = true;
-					return "Mod enabled";
-				case "disabled":
-					Config.Enabled = false;
-					return "Mod disabled";
-				case "save":
-					Config.SaveConfig();
-					return "Config file saved";
-				case "load":
-					Config.ReadConfig();
-					return "Config file loaded";
+					message = "mode set to: always";
+					break;
+				case "hideSilver":
+					Config.HideSilver = true;
+					message = "Hiding silver time";
+					break;
+				case "showSilver":
+					Config.HideSilver = false;
+					message = "Showing silver time";
+					break;
 				default:
 					printUsage();
+					// Return early (no auto save)
 					return "";
 			}
+
+			Config.SaveConfig();
+			return message;
 		}
 	}
 }

JsonHelper.cs

@@ -0,0 +1,34 @@
+using System;
+using System.Linq;
+
+namespace DiamondTimeViewer
+{
+	public class JsonHelper
+	{
+		/*
+		 * Code taken from: https://stackoverflow.com/a/57100143
+		 */
+		public static string FormatJson(string json, string indent = "  ")
+		{
+			var indentation = 0;
+			var quoteCount = 0;
+			var escapeCount = 0;
+
+			var result =
+				from ch in json ?? string.Empty
+				let escaped = (ch == '\\' ? escapeCount++ : escapeCount > 0 ? escapeCount-- : escapeCount) > 0
+				let quotes = ch == '"' && !escaped ? quoteCount++ : quoteCount
+				let unquoted = quotes % 2 == 0
+				let colon = ch == ':' && unquoted ? ": " : null
+				let nospace = char.IsWhiteSpace(ch) && unquoted ? string.Empty : null
+				let lineBreak = ch == ',' && unquoted ? ch + Environment.NewLine + string.Concat(Enumerable.Repeat(indent, indentation)) : null
+				let openChar = (ch == '{' || ch == '[') && unquoted ? ch + Environment.NewLine + string.Concat(Enumerable.Repeat(indent, ++indentation)) : ch.ToString()
+				let closeChar = (ch == '}' || ch == ']') && unquoted ? Environment.NewLine + string.Concat(Enumerable.Repeat(indent, --indentation)) + ch : ch.ToString()
+				select colon ?? nospace ?? lineBreak ?? (
+					openChar.Length > 1 ? openChar : closeChar
+				);
+
+			return string.Concat(result);
+		}
+	}
+}

LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2023-present Terry Hearst
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

PatchEntryPoint.cs

@@ -1,5 +1,4 @@
 using HarmonyLib;
-using System;
 using UnityEngine.SceneManagement;
 
 namespace DiamondTimeViewer

Patches/GamePlayManagerPatches.cs

@@ -3,13 +3,12 @@ using MIU;
 
 namespace DiamondTimeViewer.Patches
 {
-	[HarmonyPatch(typeof(GamePlayManager))]
-	[HarmonyPatch("FinishPlay")]
+	[HarmonyPatch(typeof(GamePlayManager), nameof(GamePlayManager.FinishPlay))]
 	internal class GamePlayManagerFinishPlayPatch
 	{
 		static void Postfix(GamePlayManager __instance, MarbleController marble)
 		{
-			if (!Config.Enabled)
+			if (Config.Mode == DisplayMode.Never)
 				return;
 
 			if ((__instance.PlayType == PlayType.Normal || __instance.PlayType == PlayType.Ghost) && !MarbleManager.usedRewind && LevelSelect.instance != null)

Patches/MedalsDisplayPatches.cs

@@ -1,47 +1,52 @@
 using HarmonyLib;
 using System.Collections.Generic;
-using System.Runtime.CompilerServices;
-using UnityEngine;
 
 namespace DiamondTimeViewer.Patches
 {
-	[HarmonyPatch(typeof(MedalsDisplay))]
-	[HarmonyPatch("Setup")]
+	[HarmonyPatch(typeof(MedalsDisplay), nameof(MedalsDisplay.Setup))]
 	internal class MedalsDisplaySetupPatch
 	{
 		static bool Prefix(MedalsDisplay __instance, float silver, float gold, List<string> eggUnlock)
 		{
-			if (!Config.Enabled)
+			if (Config.Mode == DisplayMode.Never)
 				return true;
 
 			// Get diamond time (since it is not passed in as a parameter)
 			float diamond = LevelSelect.instance.level.DiamondTime;
 
 			bool showDiamondTime = false;
-			switch (Config.Mode)
+			if (diamond > 0.0f)
 			{
-				case DisplayMode.Always:
-					showDiamondTime = true;
-					break;
-				case DisplayMode.Diamond:
-					showDiamondTime = LevelSelect.instance.bestScore > 0f && LevelSelect.instance.bestScore <= diamond;
-					break;
-				case DisplayMode.Gold:
-					showDiamondTime = LevelSelect.instance.bestScore > 0f && LevelSelect.instance.bestScore <= gold;
-					break;
-				case DisplayMode.Never:
-					showDiamondTime = false;
-					break;
+				switch (Config.Mode)
+				{
+					case DisplayMode.Always:
+						showDiamondTime = true;
+						break;
+					case DisplayMode.Diamond:
+						showDiamondTime = LevelSelect.instance.bestScore > 0f && LevelSelect.instance.bestScore <= diamond;
+						break;
+					case DisplayMode.Gold:
+						showDiamondTime = LevelSelect.instance.bestScore > 0f && LevelSelect.instance.bestScore <= gold;
+						break;
+				}
 			}
 
+			string silverText = "<sprite=1> " + SegmentedTime.SPTimeText(silver);
+
 			string spacingText = "<space=0.5em> ";
 			string diamondText = "";
 			if (showDiamondTime)
 			{
-				spacingText = "<space=0.25em> ";
-				diamondText = spacingText + "<sprite=3> " + SegmentedTime.SPTimeText(diamond);
+				if (Config.HideSilver)
+					silverText = "";
+				else
+					spacingText = "<space=0.25em> ";
+				diamondText = spacingText + "<sprite=3> " + SegmentedTime.SPTimeText(diamond, true);
 			}
 
+			if (silverText != "")
+				silverText += spacingText;
+
 			bool hasEgg = eggUnlock != null && eggUnlock.Count > 0;
 			bool gotEgg = hasEgg && UnlockManager.Get().IsUnlocked(eggUnlock[0]) && !CosmeticValues.WasPurchased(eggUnlock[0]);
 
@@ -51,9 +56,7 @@ namespace DiamondTimeViewer.Patches
 
 			__instance.MedalTimes.text = string.Concat(new string[]
 			{
-				"<sprite=1> ",
-				SegmentedTime.SPTimeText(silver),
-				spacingText,
+				silverText,
 				"<sprite=2> ",
 				SegmentedTime.SPTimeText(gold),
 				diamondText,

README.md

@@ -0,0 +1,38 @@
+# Marble It Up! Ultra Diamond Time Viewer
+
+This is a mod of [Marble It Up! Ultra](https://marbleitup.com/) which allows you to view the hidden diamond times in-game. It is comically over configurable for the simple task it sets out to achieve.
+
+## Usage
+
+1. Install the MIUU Mod Loader.
+2. Download the mod from the Releases page.
+3. Extract the zip into your `Mods` folder.
+4. **Optional**: Install the Console Unlocker.
+	* With the console unlocked, you can run the command `dtv` to configure the mod at runtime.
+5. Run the game, and you should be able to see the diamond times in-game!
+
+### Configuration Modes
+
+All of these options can be configured by editing `config.json` or using the `dtv` console command.
+
+There are a few modes which I felt made sense as a way to show diamond times. They are as follows, in order of most to least restrictive:
+* `never`: Never show diamond times. This option disables the mod and lets the original code run.
+* `diamond`: Only show the diamond time after you have achieved it. **This is the default mode.**
+* `gold`: Show the diamond time after you have achieved the gold time. This is to help players who can achieve gold times, but might not want to commit to grinding a diamond time unless they think they can achieve it.
+* `always`: Always show diamond times no matter what.
+
+When showing the diamond time, it will show three times instead of two, making things slightly more cluttered. If this is bothersome, I added some additonal options:
+* Show silver time no matter what. **This is the default mode.**
+* Hide the silver time when showing the diamond time. This means that no matter what, you will always see exactly two times in the menu. When the diamond time is being displayed, it will not display the silver time, so it will only show the gold and diamond time and retain a similar layout to the vanilla game.
+
+## Build
+
+If you just want to use the mod, refer to the Usage section above. These instructions are if you want to compile the mod itself.
+
+1. Clone the git repository.
+2. Install the MIUU Mod Loader, so the Harmony dll is present.
+3. Edit `UserProperties.xml` to remove the `UserPropertiesNotSetUp` property (or set it to false) and point `GameDir` to your MIUU installation directory.
+	* **Optional but recommended**: To prevent this file from showing as changed in git, run the git command `git update-index --skip-worktree UserProperties.xml`
+4. Open `DiamondTimeViewer.sln` in Visual Studio.
+5. Click Build -> Build Solution, and it will build directly into your MIUU installation directory.
+6. You should now be able to launch the game with the mod built!

UserProperties.xml

@@ -4,7 +4,7 @@
 		<UserPropertiesNotSetUp>True</UserPropertiesNotSetUp>
 		<!-- Insert path to MIUU game directory here -->
 		<GameDir></GameDir>
-		<!-- Insert path to where your mod should build to -->
+		<!-- Change path if you want to change to where the mod should build -->
 		<ModOutputDir>$(GameDir)\Mods\DiamondTimeViewer</ModOutputDir>
 	</PropertyGroup>
 </Project>