Added HintStatus message part + bumped to v6.5.0

Author: Jarno458

Archipelago.MultiClient.Net.Tests/MessageLogHelperFixture.cs

@@ -46,13 +46,14 @@ public void Should_convert_print_json_packet_into_string()
                     new JsonMessagePart { Type = JsonMessagePartType.LocationName, Text = "Text7" },
                     new JsonMessagePart { Type = JsonMessagePartType.PlayerId, Text = "8" },
                     new JsonMessagePart { Type = JsonMessagePartType.PlayerName, Text = "Text9" },
-                    new JsonMessagePart { Type = JsonMessagePartType.EntranceName, Text = "Text10" }
-                }
+                    new JsonMessagePart { Type = JsonMessagePartType.EntranceName, Text = "Text10" },
+                    new JsonMessagePart { Type = JsonMessagePartType.HintStatus, Text = "Text11", HintStatus = HintStatus.Avoid }
+				}
             };
 
             socket.PacketReceived += Raise.Event<ArchipelagoSocketHelperDelagates.PacketReceivedHandler>(packet);
 
-            Assert.That(toStringResult, Is.EqualTo("Text1Text2Text3Text4Text5Text6Text7Text8Text9Text10"));
+            Assert.That(toStringResult, Is.EqualTo("Text1Text2Text3Text4Text5Text6Text7Text8Text9Text10Text11"));
         }
 
         [Test]
@@ -86,13 +87,14 @@ public void Should_get_parsed_data_for_print_json_packet()
                     new JsonMessagePart { Type = JsonMessagePartType.LocationName, Text = "Text7" },
                     new JsonMessagePart { Type = JsonMessagePartType.PlayerId, Text = "8" },
                     new JsonMessagePart { Type = JsonMessagePartType.PlayerName, Text = "Text9" },
-                    new JsonMessagePart { Type = JsonMessagePartType.EntranceName, Text = "Text10" }
-                }
+                    new JsonMessagePart { Type = JsonMessagePartType.EntranceName, Text = "Text10" },
+                    new JsonMessagePart { Type = JsonMessagePartType.HintStatus, Text = "Text11", HintStatus = HintStatus.Avoid }
+				}
             };
 
             socket.PacketReceived += Raise.Event<ArchipelagoSocketHelperDelagates.PacketReceivedHandler>(packet);
 
-            Assert.That(parts.Length, Is.EqualTo(10));
+            Assert.That(parts.Length, Is.EqualTo(11));
             Assert.That(parts[0].Text, Is.EqualTo("Text1"));
             Assert.That(parts[0].Color, Is.EqualTo(Color.White));
             Assert.That(parts[0].IsBackgroundColor, Is.EqualTo(false));
@@ -142,7 +144,12 @@ public void Should_get_parsed_data_for_print_json_packet()
             Assert.That(parts[9].Color, Is.EqualTo(Color.Blue));
             Assert.That(parts[9].IsBackgroundColor, Is.EqualTo(false));
             Assert.That(parts[9].Type, Is.EqualTo(MessagePartType.Entrance));
-        }
+
+            Assert.That(parts[10].Text, Is.EqualTo("Text11"));
+            Assert.That(parts[10].Color, Is.EqualTo(Color.Salmon));
+            Assert.That(parts[10].IsBackgroundColor, Is.EqualTo(false));
+            Assert.That(parts[10].Type, Is.EqualTo(MessagePartType.HintStatus));
+		}
 
         [Test]
         public void Should_mark_local_player_as_magenta()
@@ -1032,6 +1039,43 @@ public void ItemSendLogMessage_for_group_receiver_should_be_related_to_active_pl
 			Assert.That(logMessage.IsRelatedToActivePlayer, Is.True);
 		}
 
+		[Test]
+		public void Should_not_crash_on_parsing_unknown_message_type()
+		{
+			var socket = Substitute.For<IArchipelagoSocketHelper>();
+			var itemInfoResolver = Substitute.For<IItemInfoResolver>();
+			var players = Substitute.For<IPlayerHelper>();
+			var connectionInfo = Substitute.For<IConnectionInfoProvider>();
+
+			var sut = new MessageLogHelper(socket, itemInfoResolver, players, connectionInfo);
+
+			ChatLogMessage logMessage = null;
+
+			sut.OnMessageReceived += (message) =>
+				logMessage = message as ChatLogMessage;
+
+
+			var packet = new ChatPrintJsonPacket
+			{
+				Data = new[] {
+					new JsonMessagePart { Type = null, Text = "Some unknown typed text" }, // add invallid type..
+				},
+				Team = 0,
+				Slot = 2,
+				Message = "I dont know",
+				MessageType = JsonMessageType.Chat
+			};
+
+			Assert.DoesNotThrow(() =>
+			{
+				socket.PacketReceived += Raise.Event<ArchipelagoSocketHelperDelagates.PacketReceivedHandler>(packet);
+
+			});
+
+			Assert.That(logMessage, Is.Not.Null);
+			Assert.That(logMessage.ToString(), Is.EqualTo("Some unknown typed text"));
+		}
+
 #if NET471 || NET472
 	    static Dictionary<int, ReadOnlyCollection<PlayerInfo>> GetPlayerCollection(IList<PlayerInfo> playerInfos) => 
 		    new Dictionary<int, ReadOnlyCollection<PlayerInfo>>(

Archipelago.MultiClient.Net.Tests/MessageParsingFixture.cs

@@ -73,5 +73,22 @@ public void Should_handle_multiple_packets_in_same_message()
 			Assert.That(packets.OfType<RetrievedPacket>().Count(), Is.EqualTo(1));
 			Assert.That(packets.OfType<LocationInfoPacket>().Count(), Is.EqualTo(1));
 		}
+
+		[Test, Ignore("The lib currently not future compatible as it does not handle new types it does not know")]
+		public void Should_not_throw_on_unknown_message_part_type()
+		{
+			const string message =
+				@"[{""cmd"":""PrintJSON"",""data"":[{""text"":""[Hint]: ""},{""text"":""(some new type of element)"",""new_value"":1337,""type"":""other_type""}],""type"":""Hint"",""receiving"":1,""item"":{""item"":1337116,""location"":1337109,""player"":2,""flags"":1,""class"":""NetworkItem""},""found"":false}]";
+
+			List<ArchipelagoPacketBase> packets = null;
+			Assert.DoesNotThrow(() =>
+			{
+				packets = JsonConvert.DeserializeObject<List<ArchipelagoPacketBase>>(message, Converter);
+			});
+
+			Assert.That(packets, Is.Not.Null);
+			Assert.That(packets.Count, Is.EqualTo(1));
+			Assert.That(packets.OfType<HintPrintJsonPacket>().Count(), Is.EqualTo(1));
+		}
 	}
 }

Archipelago.MultiClient.Net/Archipelago.MultiClient.Net.csproj

@@ -3,16 +3,16 @@
 		<TargetFrameworks>net35;net40;net45;netstandard2.0;net6.0</TargetFrameworks>
 		<AssemblyTitle>Archipelago.MultiClient.Net</AssemblyTitle>
 		<Product>Archipelago.MultiClient.Net</Product>
-		<Copyright>Copyright © 2024</Copyright>
+		<Copyright>Copyright © 2025</Copyright>
 		<OutputPath>bin\$(Configuration)\</OutputPath>
 		<Description>A client library for use with .NET based prog-langs for interfacing with Archipelago hosts.</Description>
 		<PackageProjectUrl>https://github.com/ArchipelagoMW/Archipelago.MultiClient.Net</PackageProjectUrl>
 		<PackageReadmeFile>README.md</PackageReadmeFile>
 		<RepositoryUrl>https://github.com/ArchipelagoMW/Archipelago.MultiClient.Net</RepositoryUrl>
 		<RepositoryType>git</RepositoryType>
-		<AssemblyVersion>6.4.0.0</AssemblyVersion>
-		<FileVersion>6.4.0.0</FileVersion>
-		<Version>6.4.0</Version>
+		<AssemblyVersion>6.5.0.0</AssemblyVersion>
+		<FileVersion>6.5.0.0</FileVersion>
+		<Version>6.5.0</Version>
 		<PackageLicenseExpression>MIT</PackageLicenseExpression>
 		<PackageRequireLicenseAcceptance>False</PackageRequireLicenseAcceptance>
 		<PackageIcon>blue-icon.png</PackageIcon>

Archipelago.MultiClient.Net/Enums/JsonMessagePartType.cs

@@ -48,6 +48,11 @@ public enum JsonMessagePartType
         /// <summary>
         /// Regular text that should be colored. Only type that will contain color data.
         /// </summary>
-        Color
-    }
+        Color,
+
+		/// <summary>
+		/// The HintStatus of the hint
+		/// </summary>
+		HintStatus,
+	}
 }

Archipelago.MultiClient.Net/Helpers/MessageLogHelper.cs

@@ -149,7 +149,8 @@ static IEnumerable<PrintJsonPacket> SplitPacketsPerLine(PrintJsonPacket printJso
                         Type = part.Type,
                         Color = part.Color,
                         Flags = part.Flags,
-                        Player = part.Player
+                        Player = part.Player,
+						HintStatus = part.HintStatus
                     });
 
                     if (i < (lines.Length -1))
@@ -303,6 +304,8 @@ MessagePart GetMessagePart(JsonMessagePart part)
                     return new LocationMessagePart(players, itemInfoResolver, part);
                 case JsonMessagePartType.EntranceName:
                     return new EntranceMessagePart(part);
+				case JsonMessagePartType.HintStatus:
+					return new HintStatusMessagePart(part);
                 default:
                     return new MessagePart(MessagePartType.Text, part);
             }

Archipelago.MultiClient.Net/MessageLog/Parts/HintStatusMessagePart.cs

@@ -0,0 +1,36 @@
+using Archipelago.MultiClient.Net.Enums;
+using Archipelago.MultiClient.Net.Models;
+
+namespace Archipelago.MultiClient.Net.MessageLog.Parts
+{
+	/// <summary>
+	/// Part of a LogMessage that contains information about the entrance
+	/// </summary>
+	/// <seealso cref="T:Archipelago.MultiClient.Net.MessageLog.Parts.MessagePart"/>
+	public class HintStatusMessagePart : MessagePart
+	{
+		internal HintStatusMessagePart(JsonMessagePart messagePart) : base(MessagePartType.HintStatus, messagePart)
+		{
+			Text = messagePart.Text;
+
+			switch (messagePart.HintStatus)
+			{
+				case HintStatus.Found:
+					Color = Color.Green;
+					break;
+				case HintStatus.Unspecified:
+					Color = Color.White;
+					break;
+				case HintStatus.NoPriority:
+					Color = Color.SlateBlue;
+					break;
+				case HintStatus.Avoid:
+					Color = Color.Salmon;
+					break;
+				case HintStatus.Priority:
+					Color = Color.Plum;
+					break;
+			}
+		}
+	}
+}

Archipelago.MultiClient.Net/MessageLog/Parts/MessagePartType.cs

@@ -14,6 +14,8 @@ public enum MessagePartType
 		/// <inheritdoc cref="T:Archipelago.MultiClient.Net.MessageLog.Parts.LocationMessagePart"/>
 		Location,
 		/// <inheritdoc cref="T:Archipelago.MultiClient.Net.MessageLog.Parts.EntranceMessagePart"/>
-		Entrance
+		Entrance,
+		/// <inheritdoc cref="T:Archipelago.MultiClient.Net.MessageLog.Parts.HintStatusMessagePart"/>
+		HintStatus
 	}
 }

Archipelago.MultiClient.Net/Models/JsonMessagePart.cs

@@ -23,5 +23,8 @@ public class JsonMessagePart
 
         [JsonProperty("flags")]
         public ItemFlags? Flags { get; set; }
-    }
+
+        [JsonProperty("hint_status")]
+        public HintStatus? HintStatus { get; set; }
+	}
 }