Steam Rivals experimental feature (v1.2.0.0)

Changes:
* Min/MaxLevelOfDetail config properties now have cached accessors (since LOD is intended to help improve performance). Because of this change, assigning the properties through the dictionary (instead of the getters/setters) must be avoided.
* CreatePlayerDataReplay is now patched with a transpiler instead, to introduce the compound data setup before the final Init.

New Feature:
* Steam Rivals is a feature where other players can be marked as a *sort-of-friend* (rival). These players will be highlighted differently in the level select leaderboards menu, and will have different car visual styles, as chosen in the submenu options. This way you can spot your *true* rivals in a flock a ghosts from far away.
* The submenu for Steam Rival options is available on page two of the Replay Intensifies settings menu.
* The Steam Rivals mode setting as a whole is disabled by default, due to its experimental nature, and how it's mostly a tangent from the original goal of this mod. But it *needs* to exist in this mod to take advantage of the changes/additions to ghosts and rendering.

New Options:
* All options below are under the Steam Rivals submenu:
    * Option to enable Steam Rivals (disabled by default).
    * Option to enable/disable highlighting Steam Rivals in leaderboards.
    * Option to use Steam Replay car visual styles when racing ghosts.
    * Option to use Steam Replay car visual styles when in Replay Mode.
    * Option to always treat your own ghosts/replays as Steam Rivals.
    * Option to change the car visual style for Steam Rivals (just like for ghosts and Replay Mode cars).
    * Option to change the brightness level for Steam Rival cars (up to a max of 100000, capped just before black splotches would start appearing from extreme intensity).

Author: trigger-segfault

Distance.ReplayIntensifies/ConfigurationLogic.cs

@@ -1,7 +1,7 @@
 using Reactor.API.Configuration;
 using System;
-using System.Collections;
 using System.Collections.Generic;
+using System.Linq;
 using UnityEngine;
 
 namespace Distance.ReplayIntensifies
@@ -72,14 +72,22 @@ public CarLevelOfDetail.Type ReplayDetailType
 		public CarLevelOfDetail.Level MaxLevelOfDetail
 		{
 			get => Get<CarLevelOfDetail.Level>(MaxDetailLevel_ID);
-			set => Set(MaxDetailLevel_ID, value);
+			set
+			{
+				Set(MaxDetailLevel_ID, value);
+				this.MaxLevelOfDetailCached = value;
+			}
 		}
 
 		private const string MinDetailLevel_ID = "visual.min_level_of_detail";
 		public CarLevelOfDetail.Level MinLevelOfDetail
 		{
 			get => Get<CarLevelOfDetail.Level>(MinDetailLevel_ID);
-			set => Set(MinDetailLevel_ID, value);
+			set
+			{
+				Set(MinDetailLevel_ID, value);
+				this.MinLevelOfDetailCached = value;
+			}
 		}
 
 		private const string EnableUnrestrictedOpponentColors_ID = "visual.unrestricted_colors";
@@ -89,16 +97,93 @@ public bool EnableUnrestrictedOpponentColors
 			set => Set(EnableUnrestrictedOpponentColors_ID, value);
 		}
 
+
+		private const string UseRivalStyleForGhosts_ID = "visual.use_rival_style_for_ghosts";
+		public bool UseRivalStyleForGhosts
+		{
+			get => Get<bool>(UseRivalStyleForGhosts_ID);
+			set => Set(UseRivalStyleForGhosts_ID, value);
+		}
+
+		private const string UseRivalStyleForReplays_ID = "visual.use_rival_style_for_replays";
+		public bool UseRivalStyleForReplays
+		{
+			get => Get<bool>(UseRivalStyleForReplays_ID);
+			set => Set(UseRivalStyleForReplays_ID, value);
+		}
+
+		private const string UseRivalStyleForSelf_ID = "visual.use_rival_style_for_self";
+		public bool UseRivalStyleForSelf
+		{
+			get => Get<bool>(UseRivalStyleForSelf_ID);
+			set => Set(UseRivalStyleForSelf_ID, value);
+		}
+
+		private const string RivalBrightness_ID = "visual.rival_brightness";
+		public float RivalBrightness
+		{
+			get => Get<float>(RivalBrightness_ID);
+			set => Set(RivalBrightness_ID, value);
+		}
+
+		private const string RivalOutline_ID = "visual.rival_outline";
+		public bool RivalOutline
+		{
+			get => Get<bool>(RivalOutline_ID, true);
+			set => Set(RivalOutline_ID, value);
+		}
+
+		private const string RivalDetailType_ID = "visual.rival_detail_type";
+		public CarLevelOfDetail.Type RivalDetailType
+		{
+			get => Get<CarLevelOfDetail.Type>(RivalDetailType_ID);
+			set => Set(RivalDetailType_ID, value);
+		}
+
+		private const string EnableSteamRivals_ID = "rivals.enabled";
+		public bool EnableSteamRivals
+		{
+			// We can't be having this feature enabled for non-steam builds
+			get => SteamworksManager.IsSteamBuild_ && Get<bool>(EnableSteamRivals_ID);
+			set => Set(EnableSteamRivals_ID, value);
+		}
+
+		private const string HighlightRivalsInLeaderboards_ID = "rivals.highlight_in_leaderboards";
+		public bool HighlightRivalsInLeaderboards
+		{
+			get => Get<bool>(HighlightRivalsInLeaderboards_ID);
+			set => Set(HighlightRivalsInLeaderboards_ID, value);
+		}
+
+		private const string SteamRivals_ID = "rivals.steam_ids";
+		public Dictionary<ulong, string> SteamRivals
+		{
+			get => Convert<Dictionary<ulong, string>>(SteamRivals_ID, new Dictionary<ulong, string>(), overwriteNull: true);
+			private set => Set(SteamRivals_ID, value);
+		}
+
+		#endregion
+
+		#region Cached
+
+		// Cached property values for faster accessing.
+		public CarLevelOfDetail.Level MaxLevelOfDetailCached { get; private set; }
+		public CarLevelOfDetail.Level MinLevelOfDetailCached { get; private set; }
+
 		#endregion
 
 		#region Helpers
 
-		public CarLevelOfDetail.Type GetCarDetailType(bool isGhost)
+		public CarLevelOfDetail.Type GetCarDetailType(bool isGhost, bool isCarRival)
 		{
+			if (isCarRival)
+			{
+				return this.RivalDetailType;
+			}
 			return (isGhost) ? this.GhostDetailType : this.ReplayDetailType;
 		}
 
-		public void SetCarDetailType(bool isGhost, CarLevelOfDetail.Type value)
+		/*public void SetCarDetailType(bool isGhost, CarLevelOfDetail.Type value)
 		{
 			if (isGhost)
 			{
@@ -108,14 +193,18 @@ public void SetCarDetailType(bool isGhost, CarLevelOfDetail.Type value)
 			{
 				this.ReplayDetailType = value;
 			}
-		}
+		}*/
 
-		public bool GetCarOutline(bool isGhost)
+		public bool GetCarOutline(bool isGhost, bool isCarRival)
 		{
+			if (isCarRival)
+			{
+				return this.RivalOutline;
+			}
 			return (isGhost) ? this.GhostOutline : this.ReplayOutline;
 		}
 
-		public void SetCarOutline(bool isGhost, bool value)
+		/*public void SetCarOutline(bool isGhost, bool value)
 		{
 			if (isGhost)
 			{
@@ -125,6 +214,95 @@ public void SetCarOutline(bool isGhost, bool value)
 			{
 				this.ReplayOutline = value;
 			}
+		}*/
+
+		// Determines if this car should be displayed as a Steam Rival (which accounts for settings like 'Use rival style for ghosts/replays', etc.).
+		public bool IsCarSteamRival(bool isGhost, long userID) => IsCarSteamRival(isGhost, unchecked((ulong)userID));
+
+		public bool IsCarSteamRival(bool isGhost, ulong userID)
+		{
+			if (this.EnableSteamRivals &&
+				((isGhost && this.UseRivalStyleForGhosts) || (!isGhost && this.UseRivalStyleForReplays)))
+			{
+				return IsSteamRival(userID, false);
+			}
+			return false;
+		}
+
+		#endregion
+
+		#region Steam Rivals
+
+		// The `excludeSelf` parameter exists in-case there are situations where we want to identify rivals for non-ghost/replay reasons.
+		public bool IsSteamRival(long userID, bool excludeSelf = false) => IsSteamRival(unchecked((ulong)userID), excludeSelf);
+
+		public bool IsSteamRival(ulong userID, bool excludeSelf = false)
+		{
+			if (SteamworksManager.GetSteamID() == userID)
+			{
+				return !excludeSelf && this.UseRivalStyleForSelf; // SteamRivals ignores your own user ID in the list.
+			}
+			return this.SteamRivals.ContainsKey(userID);
+		}
+
+		// For getting the name comment attached to a rival. These currently aren't used by the mod though.
+		public bool TryGetSteamRival(long userID, out string nameComment) => TryGetSteamRival(unchecked((ulong)userID), out nameComment);
+
+		public bool TryGetSteamRival(ulong userID, out string nameComment)
+		{
+			return this.SteamRivals.TryGetValue(userID, out nameComment);
+		}
+
+		public bool AddSteamRival(long userID, string nameComment, bool autoSave = true) => AddSteamRival(unchecked((ulong)userID), nameComment, autoSave);
+
+		public bool AddSteamRival(ulong userID, string nameComment, bool autoSave = true)
+		{
+			if (nameComment == null)
+			{
+				nameComment = string.Empty; // Default to empty string I guess? It doesn't really matter either way, but would be more user friendly.
+			}
+
+			var steamRivals = this.SteamRivals;
+			if (!steamRivals.ContainsKey(userID))
+			{
+				steamRivals[userID] = nameComment; // Name comment to make identifying users in Config.json easier.
+				if (autoSave)
+				{
+					Save();
+				}
+				return true;
+			}
+			return false;
+		}
+
+		public bool RemoveSteamRival(long userID, bool autoSave = true) => RemoveSteamRival(unchecked((ulong)userID), autoSave);
+
+		public bool RemoveSteamRival(ulong userID, bool autoSave = true)
+		{
+			if (this.SteamRivals.Remove(userID))
+			{
+				if (autoSave)
+				{
+					Save();
+				}
+				return true;
+			}
+			return false;
+		}
+
+		// Shorthand function to reduce the time spent on lookup when a large number of userIDs are in a single collection.
+		public int CountSteamRivals(IEnumerable<long> userIDs, bool countSelf = true)
+		{
+			return CountSteamRivals(userIDs.Select((userID) => unchecked((ulong)userID)), countSelf);
+		}
+
+		public int CountSteamRivals(IEnumerable<ulong> userIDs, bool countSelf = true)
+		{
+			//var useRivalStyleForSelf = this.UseRivalStyleForSelf;
+			ulong selfID = SteamworksManager.GetSteamID();
+			var steamRivals = this.SteamRivals;
+
+			return userIDs.Count((userID) => (userID == selfID ? countSelf : steamRivals.ContainsKey(userID)));
 		}
 
 		#endregion
@@ -153,10 +331,21 @@ public void Awake()
 			Get(GhostDetailType_ID, CarLevelOfDetail.Type.Ghost);
 			Get(ReplayOutline_ID, false);
 			Get(ReplayDetailType_ID, CarLevelOfDetail.Type.Replay);
-			Get(MaxDetailLevel_ID, CarLevelOfDetail.Level.InFocusFP);
-			Get(MinDetailLevel_ID, CarLevelOfDetail.Level.Speck);
+			this.MaxLevelOfDetailCached = Get(MaxDetailLevel_ID, CarLevelOfDetail.Level.InFocusFP);
+			this.MinLevelOfDetailCached = Get(MinDetailLevel_ID, CarLevelOfDetail.Level.Speck);
 			Get(EnableUnrestrictedOpponentColors_ID, false);
 
+			// Experimental (disabled by default)
+			Get(EnableSteamRivals_ID, false);
+			Convert(SteamRivals_ID, new Dictionary<ulong, string>(), overwriteNull: true);
+			Get(HighlightRivalsInLeaderboards_ID, true);
+			Get(UseRivalStyleForGhosts_ID, true);
+			Get(UseRivalStyleForReplays_ID, false);
+			Get(UseRivalStyleForSelf_ID, false);
+			Get(RivalBrightness_ID, 1.0f);
+			Get(RivalOutline_ID, true);
+			Get(RivalDetailType_ID, CarLevelOfDetail.Type.Networked);
+
 			// Save settings, and any defaults that may have been added.
 			Save();
 		}
@@ -172,6 +361,19 @@ public void Set<T>(string key, T value)
 			Save();
 		}
 
+		public T Convert<T>(string key, T @default = default, bool overwriteNull = false)
+		{
+			// Assign the object back after conversion, this allows for deep nested settings
+			//  that can be preserved and updated without reassigning to the root property.
+			var value = Config.GetOrCreate(key, @default);
+			if (overwriteNull && value == null)
+			{
+				value = @default;
+			}
+			Config[key] = value;
+			return value;
+		}
+
 		public void Save()
 		{
 			Config?.Save();

Distance.ReplayIntensifies/Distance.ReplayIntensifies.csproj

@@ -87,7 +87,12 @@
   </ItemGroup>
   <ItemGroup>
     <Compile Include="ConfigurationLogic.cs" />
+    <Compile Include="Harmony\Assembly-CSharp\LevelSelectLeaderboardButton\OnDisplayedVirtual.cs" />
+    <Compile Include="Harmony\Assembly-CSharp\LevelSelectLeaderboardMenu\Display.cs" />
+    <Compile Include="Harmony\Assembly-CSharp\LevelSelectLeaderboardMenu\Update.cs" />
     <Compile Include="Harmony\Assembly-CSharp\PlayerDataReplay\CreatePlayerDataReplay.cs" />
+    <Compile Include="Harmony\Assembly-CSharp\PlayerDataReplay\OnEventReplayOptionsMenuClosed.cs" />
+    <Compile Include="Helpers\SteamworksHelper.cs" />
     <Compile Include="Scripts\PlayerDataReplayCompoundData.cs" />
     <Compile Include="Harmony\Assembly-CSharp\CarLevelOfDetail\SetLevelOfDetail.cs" />
     <Compile Include="Harmony\Assembly-CSharp\FinishMenuLogic\ShowOnlineLeaderboards.cs" />

Distance.ReplayIntensifies/Harmony/Assembly-CSharp/CarLevelOfDetail/SetLevelOfDetail.cs

@@ -18,7 +18,7 @@ internal static bool Prefix(CarLevelOfDetail __instance, CarLevelOfDetail.Level
 		{
 			// Avoid clamping if the max is unchanged (InFocusFP), just in-case other mods mess with this...
 			// NOTE: Highest LOD is lowest-value enum, so compare using less than.
-			CarLevelOfDetail.Level maxLevel = Mod.Instance.Config.MaxLevelOfDetail;
+			CarLevelOfDetail.Level maxLevel = Mod.Instance.Config.MaxLevelOfDetailCached;
 
 			// NOTE: Replay-type cars will NOT RENDER A SOLID BODY at Speck, so force the minimum to VeryFar.
 			//       Interestingly, networked cars WILL render a solid body at Speck.
@@ -34,7 +34,7 @@ internal static bool Prefix(CarLevelOfDetail __instance, CarLevelOfDetail.Level
 			{
 				// Avoid clamping if the min is unchanged (Speck), just in-case other mods mess with this...
 				// MaxLevel has priority over MinLevel (when the range is invalid)
-				CarLevelOfDetail.Level minLevel = Mod.Instance.Config.MinLevelOfDetail;
+				CarLevelOfDetail.Level minLevel = Mod.Instance.Config.MinLevelOfDetailCached;
 				if (newLevel > minLevel && minLevel != CarLevelOfDetail.Level.Speck)
 				{
 					newLevel = minLevel;

Distance.ReplayIntensifies/Harmony/Assembly-CSharp/LevelSelectLeaderboardButton/OnDisplayedVirtual.cs

@@ -0,0 +1,20 @@
+using HarmonyLib;
+
+namespace Distance.ReplayIntensifies.Harmony
+{
+	/// <summary>
+	/// Patch to highlight rivals in the level select leaderboards menu.
+	/// </summary>
+	/// <remarks>
+	/// Required For: Highlight Rivals in Leaderboards
+	/// </remarks>
+	[HarmonyPatch(typeof(LevelSelectLeaderboardButton), nameof(LevelSelectLeaderboardButton.OnDisplayedVirtual))]
+	internal static class LevelSelectLeaderboardButton__OnDisplayedVirtual
+	{
+		[HarmonyPostfix]
+		internal static void Postfix(LevelSelectLeaderboardButton __instance)
+		{
+			Mod.UpdateLeaderboardButtonColor(__instance, false);
+		}
+	}
+}