Pouch v2.0.0 (#6)

- Adding byte[] support
- Only send events to clients that have the same pipe available

Author: PrashantMohta

Event/Event.cs

@@ -48,6 +48,11 @@ public class baseEventData
         /// Corresponding EventData
         /// </summary>
         public string EventData = "";
+
+        /// <summary>
+        /// Extra Bytes sent with the event
+        /// </summary>
+        public byte[] ExtraBytes = new byte[0];
     }
 
     /// <summary>

Event/OnAble.cs

@@ -55,6 +55,7 @@ private void OnEvent_handler(object sender, EventContainer e)
                 e.Event.FromPlayer = e.FromPlayer;
                 e.Event.ToPlayer = e.ToPlayer;
                 e.Event.SceneName = e.SceneName;
+                e.Event.ExtraBytes = e.ExtraBytes;
             }
             thenActions.ForEach(x => x(e.Event));
         }
@@ -82,6 +83,7 @@ void OnEvent_do_Once_handler(object sender, EventContainer e)
                     e.Event.FromPlayer = e.FromPlayer;
                     e.Event.ToPlayer = e.ToPlayer;
                     e.Event.SceneName = e.SceneName;
+                    e.Event.ExtraBytes = e.ExtraBytes;
                 }
                 Callback(e.Event);
                 handler -= OnEvent_do_Once_handler;

HkmpPouch.csproj

@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
 	<!-- Change this to the path of your modded HK installation -->
-	<HollowKnightRefs>D:\SteamLibrary\steamapps\common\Hollow Knight\hollow_knight_Data\Managed</HollowKnightRefs>
+	<HollowKnightRefs>E:\SteamLibrary\steamapps\common\Hollow Knight\hollow_knight_Data\Managed</HollowKnightRefs>
 	<!-- Change this to the path where you want the ready-to-upload exports to be -->
 	<ExportDir>D:/__Exports/</ExportDir>
 	<!-- Uncomment this to generate a documentation file to be included with the mod -->
@@ -323,9 +323,12 @@
 	<Reference Include="UnityEngine.XRModule">
 		<HintPath>$(HollowKnightRefs)/UnityEngine.XRModule.dll</HintPath>
 	</Reference>
-	<Reference Include="Hkmp">
-		<HintPath>$(HollowKnightRefs)/Mods/HKMP/HKMP.dll</HintPath>
-	</Reference>
+	  <Reference Include="Hkmp">
+		  <HintPath>$(HollowKnightRefs)/Mods/HKMP/HKMP.dll</HintPath>
+	  </Reference>
+	  <Reference Include="Satchel">
+		  <HintPath>$(HollowKnightRefs)/Mods/Satchel/Satchel.dll</HintPath>
+	  </Reference>
   </ItemGroup>
   <ItemGroup>
     <None Include=".gIthub\worlflows\main.yml" />

Logger.cs

@@ -1,4 +1,7 @@
-namespace HkmpPouch
+using HkmpPouch.Networking;
+using System;
+
+namespace HkmpPouch
 {
     internal interface ILogger {
         internal void Error(string str);
@@ -13,6 +16,27 @@ public class Logger
     {
         private readonly string Name;
         private readonly ILogger _logger;
+
+        /// <summary>
+        /// StupidError will try to log an error, it will not print what addon tried to print the error because it does not know.
+        /// </summary>
+        /// <param name="text">The error to log</param>
+        [Obsolete("Ideally you shouldn't need to use this. Use your own instance of the logger from your pipe instead.")]
+        public static void StupidError(string text)
+        {
+            if (Server.Instance != null)
+            {
+                Server.Instance.Error(text);
+            } else if (Client.Instance != null)
+            {
+                Client.Instance.Error(text);
+            } else
+            {
+                // we cannot log it, but ideally this will never happen because HKMP would initialise atleast one of these.
+            }
+        }
+
+
         internal Logger(string Name,ILogger L) {
             this.Name = Name;
             _logger = L;

Networking/Client.cs

@@ -18,6 +18,8 @@ internal class Client : ClientAddon, ILogger
 
         internal static Client Instance;
 
+        internal static List<PipeClient> PipeClients = new ();
+
         internal IClientApi Api;
 
         internal static event EventHandler<EventArgs> OnReady;
@@ -30,6 +32,7 @@ internal class Client : ClientAddon, ILogger
         internal IClientAddonNetworkSender<PacketsEnum> NetSender;
         internal bool HasServerPipeList { get; private set; } = false;
         private List<string> ServerPipeList = new();
+
         public Client() {
             Instance = this;
         }
@@ -113,6 +116,7 @@ internal void PlayerToPlayerPacketHandler(PlayerToPlayerPacket packet)
                 ModName = packet.mod,
                 EventData = packet.eventData,
                 EventName = packet.eventName,
+                ExtraBytes = packet.extraBytes,
             });
         }
 
@@ -126,6 +130,7 @@ internal void PlayerToPlayersPacketHandler(PlayerToPlayersPacket packet)
                 ModName = packet.mod,
                 EventData = packet.eventData,
                 EventName = packet.eventName,
+                ExtraBytes = packet.extraBytes,
             });
         }
 
@@ -138,6 +143,7 @@ internal void ToPlayerPacketHandler(ToPlayerPacket packet)
                 ModName = packet.mod,
                 EventData = packet.eventData,
                 EventName = packet.eventName,
+                ExtraBytes = packet.extraBytes,
             });
         }
 
@@ -150,6 +156,7 @@ internal void ToPlayersPacket(ToPlayersPacket packet)
                 ModName = packet.mod,
                 EventData = packet.eventData,
                 EventName = packet.eventName,
+                ExtraBytes = packet.extraBytes,
             });
         }
 
@@ -188,5 +195,13 @@ void x(object _, EventArgs e)
             }
         }
 
+        internal void RegisterPipeWithServer(PipeClient pipe)
+        {
+            //pipe.ModName;
+            Send<RegisterPipePacket>(PacketsEnum.RegisterPipePacket, new RegisterPipePacket { 
+                modName = pipe.ModName
+            });
+        }
+
     }
 }

Networking/Server.cs

@@ -6,6 +6,7 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
+using System.Net.Sockets;
 
 namespace HkmpPouch.Networking
 {
@@ -28,6 +29,8 @@ internal class Server : ServerAddon, ILogger
         internal Dictionary<string, DataStorageServerManager> ModDataStorageServerManager = new Dictionary<string, DataStorageServerManager>();
         private List<string> PipeList = new();
 
+        internal Dictionary<string, List<IServerPlayer>> PipeToPlayersMap = new();
+        internal Dictionary<ushort,List<string>> PlayerIdToPipeMap = new();
         internal void AddPipe(string s)
         {
             PipeList.Add(s);
@@ -58,20 +61,68 @@ internal void RecieveData(EventContainer r)
         public override void Initialize(IServerApi serverApi)
         {
             Api = serverApi;
+            Api.ServerManager.PlayerDisconnectEvent += ServerManager_PlayerDisconnectEvent;
             NetReceiver = Api.NetServer.GetNetworkReceiver<PacketsEnum>(Instance,PacketBoi.InstantiatePacket);
 
             NetReceiver.RegisterPacketHandler<GetServerMetadataPacket>(PacketsEnum.GetServerMetadataPacket, GetServerMetadataPacketHandler);
+            NetReceiver.RegisterPacketHandler<RegisterPipePacket>(PacketsEnum.RegisterPipePacket, RegisterPipePacketHandler);
 
             NetReceiver.RegisterPacketHandler<ToServerPacket>(PacketsEnum.ToServerPacket, ToServerPacketHandler);
             NetReceiver.RegisterPacketHandler<PlayerToPlayerPacket>(PacketsEnum.PlayerToPlayerPacket, PlayerToPlayerPacketHandler);
             NetReceiver.RegisterPacketHandler<PlayerToPlayersPacket>(PacketsEnum.PlayerToPlayersPacket, PlayerToPlayersPacketHandler);
 
         }
 
+        private void ServerManager_PlayerDisconnectEvent(IServerPlayer player)
+        {
+            RemovePlayerPipeRegisterations(player);
+        }
+
+        private void RemovePlayerPipeRegisterations(IServerPlayer player)
+        {
+            foreach(var pipe in PipeToPlayersMap)
+            {
+                if (pipe.Value.Contains(player))
+                {
+                    pipe.Value.Remove(player);
+                }
+            }
+            if (PlayerIdToPipeMap.ContainsKey(player.Id))
+            {
+                PlayerIdToPipeMap.Remove(player.Id);
+            }   
+        }
+
+        private void RegisterPipePacketHandler(ushort fromPlayer, RegisterPipePacket packet)
+        {
+            var player = Api.ServerManager.GetPlayer(fromPlayer);
+            if (packet.modName == null)
+            {
+                Error($"Recieved A packet without modname from playerid {player.Id}.");
+                return;
+            }
+            if (!PipeToPlayersMap.TryGetValue(packet.modName, out _))
+            {
+                PipeToPlayersMap[packet.modName] = new();
+            }
+            if (!PipeToPlayersMap[packet.modName].Contains(player))
+            {
+                PipeToPlayersMap[packet.modName].Add(player);
+            }
+
+            if (!PlayerIdToPipeMap.TryGetValue(fromPlayer, out _))
+            {
+                PlayerIdToPipeMap[fromPlayer] = new();
+            }
+            if (!PlayerIdToPipeMap[fromPlayer].Contains(packet.modName))
+            {
+                PlayerIdToPipeMap[fromPlayer].Add(packet.modName);
+            }
+        }
+
         private void GetServerMetadataPacketHandler(ushort playerId, GetServerMetadataPacket packet)
         {
 
-            Logger.Info("got get packet " + PipeList.Count);
             Send<ServerPipeListPacket>(PacketsEnum.ServerPipeListPacket, new ServerPipeListPacket
             {
                 PipeList = PipeList
@@ -90,14 +141,25 @@ internal void ToServerPacketHandler(ushort fromPlayer, ToServerPacket packet)
                 ModName = packet.mod,
                 EventData = packet.eventData,
                 EventName = packet.eventName,
+                ExtraBytes = packet.extraBytes
             });
         }
 
         internal void PlayerToPlayerPacketHandler(ushort fromPlayer, PlayerToPlayerPacket packet)
         {
             // rebroadcast
             packet.fromPlayer = fromPlayer;
-            Send<PlayerToPlayerPacket>(PacketsEnum.PlayerToPlayerPacket, packet, packet.toPlayer);
+
+            if (PlayerIdToPipeMap.TryGetValue(fromPlayer, out var pipes))
+            {
+                if (pipes.Contains(packet.mod))
+                {
+                    Send<PlayerToPlayerPacket>(PacketsEnum.PlayerToPlayerPacket, packet, packet.toPlayer);
+                }
+            } else
+            {
+                Send<PlayerToPlayerPacket>(PacketsEnum.PlayerToPlayerPacket, packet, packet.toPlayer);
+            }
         }
 
         internal void PlayerToPlayersPacketHandler(ushort fromPlayer, PlayerToPlayersPacket packet)
@@ -107,7 +169,10 @@ internal void PlayerToPlayersPacketHandler(ushort fromPlayer, PlayerToPlayersPac
             bool allScenes = packet.sceneName == Constants.AllScenes;
             bool sameScene = packet.sceneName == Constants.SameScenes;
 
-            var players = Api.ServerManager.Players;
+            if(!PipeToPlayersMap.TryGetValue(packet.mod, out var players))
+            {
+                players = (List<IServerPlayer>)Api.ServerManager.Players;
+            }
             var sender = Api.ServerManager.GetPlayer(fromPlayer);
             packet.fromPlayer = fromPlayer;
 
@@ -123,8 +188,8 @@ internal void PlayerToPlayersPacketHandler(ushort fromPlayer, PlayerToPlayersPac
                     sceneName = packet.sceneName,
                     mod = packet.mod,
                     eventData = packet.eventData,
-                    eventName = packet.eventName
-                    
+                    eventName = packet.eventName,
+                    extraBytes = packet.extraBytes,
                     }, player.Id);
                 }
             }
@@ -148,8 +213,10 @@ internal void PlayerToPlayersPacketHandler(ushort fromPlayer, PlayerToPlayersPac
         internal void Broadcast(ToPlayersPacket packet) {
             bool allScenes = packet.sceneName == Constants.AllScenes;
 
-            var players = Api.ServerManager.Players;
-
+            if (!PipeToPlayersMap.TryGetValue(packet.mod, out var players))
+            {
+                players = (List<IServerPlayer>)Api.ServerManager.Players;
+            }
             for (var i = 0; i < players.Count; i++)
             {
                 var player = players.ElementAt(i);

Packets/BasePacket.cs

@@ -1,24 +1,42 @@
 using Hkmp.Networking.Packet;
+using System;
 
 namespace HkmpPouch.Packets
 {
     internal class BasePacket
     {
-
         public bool IsReliable => _isReliable;
         public bool DropReliableDataIfNewerExists => false; //cannot set this to true because our packets are reused between mods.
 
         public bool _isReliable = false;
         public string mod { get; set; }
         public string eventName { get; set; }
         public string eventData { get; set; }
+        public bool hasExtraBytes { get => extraBytes != null && extraBytes.Length > 0; }
+        public ulong extraBytesSize { get; set; }
+        public byte[] extraBytes { get; set; }
 
         public void WriteData(IPacket packet)
         {
             //order of read should be same as order of write
             packet.Write(mod);
             packet.Write(eventName);
             packet.Write(eventData);
+            
+        }
+
+        public void WriteExtraBytes(IPacket packet)
+        {
+            packet.Write(hasExtraBytes);
+            if (hasExtraBytes)
+            {
+                extraBytesSize = (ulong)extraBytes.Length;
+                packet.Write(extraBytesSize);
+                for (ulong i = 0; i < extraBytesSize; i++)
+                {
+                    packet.Write(extraBytes[i]);
+                }
+            }
         }
 
         public void ReadData(IPacket packet)
@@ -28,5 +46,31 @@ public void ReadData(IPacket packet)
             eventName = packet.ReadString();
             eventData = packet.ReadString();
         }
+
+        public void ReadExtraBytes(IPacket packet)
+        {
+            extraBytesSize = 0;
+            try
+            {
+                var hasExtraBytes = packet.ReadBool();
+                if (hasExtraBytes)
+                {
+                    extraBytesSize = packet.ReadULong();
+                    extraBytes = new byte[extraBytesSize];
+                    for (ulong i = 0; i < extraBytesSize; i++)
+                    {
+                        extraBytes[i] = packet.ReadByte();
+                    }
+                }
+            }
+            catch(Exception ex){
+                // eat the error here that will happen when ReadBool tries to read from a packet that does not have data to read
+                // this will happen when a player with old pouch connects to new servers, i don't know if we are on the server or unity so here goes
+#pragma warning disable CS0618 // Type or member is obsolete but only for others
+                Logger.StupidError(ex.ToString());
+#pragma warning restore CS0618 // Type or member is obsolete but only for others
+            }
+        }
+
     }
 }

Packets/Packets.cs

@@ -12,7 +12,8 @@ internal enum PacketsEnum
         ToPlayersPacket,
 
         GetServerMetadataPacket,
-        ServerPipeListPacket
+        ServerPipeListPacket,
+        RegisterPipePacket
     }
     internal static class PacketBoi
     {
@@ -34,6 +35,8 @@ internal static IPacketData InstantiatePacket(PacketsEnum packetId)
                     return new PacketDataCollection<GetServerMetadataPacket>();
                 case PacketsEnum.ServerPipeListPacket:
                     return new PacketDataCollection<ServerPipeListPacket>();
+                case PacketsEnum.RegisterPipePacket:
+                    return new PacketDataCollection<RegisterPipePacket>();
             }
             return null;
         }