Merge grpc to continue work from master

.github/workflows/ci.yml

@@ -18,8 +18,6 @@ jobs:
           - { name: Windows VS2022, os: windows-2022 }
           - { name: macOS, os: macos-13 }
         dotnet:
-          - { name: .NET 6, version: "6.0.x" }
-          - { name: .NET 7, version: "7.0.x" }
           - { name: .NET 8, version: "8.0.x" }
 
     steps:

.gitignore

@@ -368,4 +368,7 @@ MigrationBackup/
 .ionide/
 
 # Fody - auto-generated XML schema
-FodyWeavers.xsd
+FodyWeavers.xsd
+
+# VSCode Shared Configuration Files
+.vscode/

Lib/Shared.Udp/Serializer.cs

@@ -45,7 +45,7 @@ public static Memory<byte> WriteStruct<T>(T packet)
         var size = Unsafe.SizeOf<T>();
         Memory<byte> memory = new byte[size];
 
-        MemoryMarshal.Write(memory.Span, ref packet);
+        MemoryMarshal.Write(memory.Span, in packet);
 
         return memory;
     }

Lib/Shared.Web/BaseWebServer.cs

@@ -35,6 +35,7 @@ public static IHost Build(Type serverType, IConfiguration configuration)
             }
 
             Log.Information($"Starting web host {serverType.FullName}");
+            #pragma warning disable SYSLIB0039 // TLS 1.0 required
             var hostBuilder =
                 Host.CreateDefaultBuilder()
                     .ConfigureWebHostDefaults(webBuilder =>
@@ -71,7 +72,7 @@ public static IHost Build(Type serverType, IConfiguration configuration)
                                                                                       });
                                        })
                     .UseSerilog();
-
+            #pragma warning restore SYSLIB0039
             return hostBuilder.Build();
         }
         catch (Exception ex)

PIN.sln.DotSettings

@@ -197,11 +197,13 @@
     <s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/Abbreviations/=UGSS/@EntryIndexedValue">UGSS</s:String>
 	<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/Abbreviations/=ABRT/@EntryIndexedValue">ABRT</s:String>
 	<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/PredefinedNamingRules/=LocalConstants/@EntryIndexedValue">&lt;Policy Inspect="True" Prefix="" Suffix="" Style="AaBb" /&gt;</s:String>
+	<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/UserRules/=a4f433b8_002Dabcd_002D4e55_002Da08f_002D82e78cef0f0c/@EntryIndexedValue">&lt;Policy&gt;&lt;Descriptor Staticness="Any" AccessRightKinds="Any" Description="Local constants"&gt;&lt;ElementKinds&gt;&lt;Kind Name="LOCAL_CONSTANT" /&gt;&lt;/ElementKinds&gt;&lt;/Descriptor&gt;&lt;Policy Inspect="True" Prefix="" Suffix="" Style="AaBb" /&gt;&lt;/Policy&gt;</s:String>
 	<s:Boolean x:Key="/Default/Environment/SettingsMigration/IsMigratorApplied/=JetBrains_002EReSharper_002EPsi_002ECSharp_002ECodeStyle_002ECSharpKeepExistingMigration/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/Environment/SettingsMigration/IsMigratorApplied/=JetBrains_002EReSharper_002EPsi_002ECSharp_002ECodeStyle_002ECSharpPlaceEmbeddedOnSameLineMigration/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/Environment/SettingsMigration/IsMigratorApplied/=JetBrains_002EReSharper_002EPsi_002ECSharp_002ECodeStyle_002ECSharpUseContinuousIndentInsideBracesMigration/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/Environment/SettingsMigration/IsMigratorApplied/=JetBrains_002EReSharper_002EPsi_002ECSharp_002ECodeStyle_002ESettingsUpgrade_002EAlwaysTreatStructAsNotReorderableMigration/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/Environment/SettingsMigration/IsMigratorApplied/=JetBrains_002EReSharper_002EPsi_002ECSharp_002ECodeStyle_002ESettingsUpgrade_002EMigrateBlankLinesAroundFieldToBlankLinesAroundProperty/@EntryIndexedValue">True</s:Boolean>
+	<s:Boolean x:Key="/Default/Environment/SettingsMigration/IsMigratorApplied/=JetBrains_002EReSharper_002EPsi_002ECSharp_002ECodeStyle_002ESettingsUpgrade_002EPredefinedNamingRulesToUserRulesUpgrade/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=Baneclaw/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=Battlelab/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=Cinerarium/@EntryIndexedValue">True</s:Boolean>

PIN.targets

@@ -1,6 +1,6 @@
 <Project>
     <PropertyGroup>
-        <TargetFramework>net6.0</TargetFramework>
+        <TargetFramework>net8.0</TargetFramework>
         <LangVersion>latest</LangVersion>
         <CodeAnalysisRuleSet>..\..\stylecop.ruleset</CodeAnalysisRuleSet>
     </PropertyGroup>

README.md

@@ -16,7 +16,7 @@ https://user-images.githubusercontent.com/920861/134824107-03e9f99c-b420-47c7-b7
 4. Download the [latest PIN release](https://github.com/themeldingwars/PIN/releases/latest)
 5. Make a backup copy of the original `FirefallClient.exe` in `Firefall\system\bin`
 6. Replace the `FirefallClient.exe` with the patched `FirefallClient.exe` from the PIN release
-7. Make sure the [.NET 6 Runtime](https://dotnet.microsoft.com/download/dotnet/6.0) is installed
+7. Make sure the [.NET 8 Runtime](https://dotnet.microsoft.com/download/dotnet/8.0) is installed
 8. Trust self-signed development certificates by running `dotnet dev-certs https --trust`
 9. Start all three applications:
    - GameServer
@@ -44,29 +44,26 @@ PlayIntroMovie = false
 
 ### Features
 
-- Loading into any of the existing zone
-- Basic character movement, including jetpacks
-- Primary and secondary weapon usage
-  - **Note:** In about one third of the cases, the weapons can't be used, try a relog in those cases
-- One partially working ability that breaks the camera position
-- Sound effects, ambient and music
-- The map can be opened
+- Loading into any zone (WebHostManager)
+- Basic character movement, including jetpacks and gliders
+- Switch between battleframes with preconfigured loadouts
+- Customize character appearance in NewYou (RIN.WebAPI)
+- Call down vehicles and some deployables
 
 ### Limitations
 
-- Weapons don't always work
-- Jetpacks are missing all visual effects
+- There is no combat, projectile or damage simulation
 - Most of the UI doesn't work properly
-- No gliders
-- No abilities
-- No call downs
-- No NPCs of any sort
-- No Melding
+- Most abilities are not fully working
+- Vehicles only have physics if a player is driving it (client-side)
+- No AI
+- No Encounters
+- No PvP
 
 ## Development
 
 1. Install Visual Studio or JetBrains Rider
-   - Include the [.NET 6 SDK](https://dotnet.microsoft.com/download/dotnet/6.0) component or install it separately
+   - Include the [.NET 8 SDK](https://dotnet.microsoft.com/download/dotnet/8.0) component or install it separately
 2. Recursive clone the repository `git clone --recurse-submodules https://github.com/themeldingwars/PIN.git`
 3. Build the solution
 4. Trust self-signed development certificates by running `dotnet dev-certs https --trust`

StartGameServer.bat

@@ -1 +1 @@
-start /D UdpHosts\GameServer\bin\Debug\net6.0 UdpHosts\GameServer\bin\Debug\net6.0\GameServer.exe
+start /D UdpHosts\GameServer\bin\Debug\net8.0 UdpHosts\GameServer\bin\Debug\net8.0\GameServer.exe

StartMatrixServer.bat

@@ -1 +1 @@
-start /D UdpHosts\MatrixServer\bin\Debug\net6.0 UdpHosts\MatrixServer\bin\Debug\net6.0\MatrixServer.exe
+start /D UdpHosts\MatrixServer\bin\Debug\net8.0 UdpHosts\MatrixServer\bin\Debug\net8.0\MatrixServer.exe

StartWebHostManager.bat

@@ -1 +1 @@
-start /D WebHostManager\bin\Debug\net6.0 WebHostManager\bin\Debug\net6.0\WebHostManager.exe
+start /D WebHostManager\bin\Debug\net8.0 WebHostManager\bin\Debug\net8.0\WebHostManager.exe

UdpHosts/GameServer/App.Default.config

@@ -2,6 +2,8 @@
 <configuration>
     <appSettings>
         <add key="serilog:minimum-level" value="Debug"/>
-        <!-- More settings here -->
+        <add key="Port" value="25001"/>
+        <add key="GrpcChannelAddress" value="http://localhost:5201"/>
+        <add key="StaticDBPath" value="C:\Program Files\Steam\steamapps\common\Firefall\system\db\clientdb.sd2"/>
     </appSettings>
 </configuration>

UdpHosts/GameServer/Channel.cs

@@ -1,7 +1,9 @@
 #nullable enable
 using System;
+using System.Collections;
 using System.Collections.Concurrent;
 using System.Collections.Generic;
+using System.Collections.Specialized;
 using System.Linq;
 using System.Runtime.InteropServices;
 using System.Threading;
@@ -29,6 +31,7 @@ public class Channel
     private readonly INetworkClient _client;
     private readonly ConcurrentQueue<GamePacket> _incomingPackets;
     private readonly ConcurrentQueue<Memory<byte>> _outgoingPackets;
+    private SortedDictionary<ushort, GamePacket> _incomingSplitMessagePackets;
 
     private Channel(ChannelType channelType, bool isSequenced, bool isReliable, INetworkClient networkClient, ILogger logger)
     {
@@ -42,6 +45,7 @@ private Channel(ChannelType channelType, bool isSequenced, bool isReliable, INet
 
         _incomingPackets = new ConcurrentQueue<GamePacket>();
         _outgoingPackets = new ConcurrentQueue<Memory<byte>>();
+        _incomingSplitMessagePackets = new SortedDictionary<ushort, GamePacket>();
     }
 
     public delegate void PacketAvailableDelegate(GamePacket packet);
@@ -54,6 +58,7 @@ private Channel(ChannelType channelType, bool isSequenced, bool isReliable, INet
     private ushort CurrentSequenceNumber { get; set; }
     private DateTime LastActivity { get; set; }
     private ushort LastAck { get; set; }
+    private bool InSplitMode { get; set; }
 
     public static Dictionary<ChannelType, Channel> GetChannels(INetworkClient client, ILogger logger)
     {
@@ -90,6 +95,7 @@ public void Process(CancellationToken ct)
             }
 
             // TODO: Implement SequencedPacketQueue
+            // TODO: Fix resent message handling
             if (packet.Header.ResendCount > 0)
             {
                 // de-xor data
@@ -126,18 +132,45 @@ public void Process(CancellationToken ct)
                 _logger.Fatal("---> Resent packet!!! C:{0}: {1} bytes", Type, packet.TotalBytes);
             }
 
-            if (packet.Header.IsSplit)
+            // TODO: Ensure we follow sequence number when combining split messages
+            if (InSplitMode)
             {
-                _logger.Fatal("---> Split packet!!! C:{0}: {1} bytes", Type, packet.TotalBytes);
-            }
+                _incomingSplitMessagePackets.Add(sequenceNumber, packet);
+                if (!packet.Header.IsSplit)
+                {
+                    // Finish split mode
+                    InSplitMode = false;
+                    var combined = _incomingSplitMessagePackets
+                    .SelectMany((pair) => pair.Value.PacketData[2..].ToArray()) // Skip seqnum
+                    .ToArray();
+                    _incomingSplitMessagePackets.Clear();
+
+                    var combinedPacket = new GamePacket(packet.Header, new ReadOnlyMemory<byte>(combined));
 
-            if (IsReliable && (sequenceNumber > LastAck || (sequenceNumber < 0xff && LastAck > 0xff00)))
+                    _client.SendAck(Type, sequenceNumber, packet.Received);
+                    LastAck = sequenceNumber;
+
+                    PacketAvailable?.Invoke(combinedPacket);
+                    _logger.Fatal("---> Collected Split Packet");
+                }
+            }
+            else if (packet.Header.IsSplit)
             {
-                _client.SendAck(Type, sequenceNumber, packet.Received);
-                LastAck = sequenceNumber;
+                // Enter split mode
+                InSplitMode = true;
+                _incomingSplitMessagePackets.Add(sequenceNumber, packet);
             }
+            else
+            {
+                if (IsReliable && (sequenceNumber > LastAck || (sequenceNumber < 0xff && LastAck > 0xff00)))
+                {
+                    _client.SendAck(Type, sequenceNumber, packet.Received);
+                    LastAck = sequenceNumber;
+                }
 
-            PacketAvailable?.Invoke(packet);
+                PacketAvailable?.Invoke(packet);
+            }
+
             LastActivity = DateTime.Now;
         }
 
@@ -298,8 +331,8 @@ public bool SendGSS<T>(T packet, ulong entityId, Enums.GSS.Controllers? controll
     ///     Send a GSS class to the client
     /// </summary>
     /// <typeparam name="TPacket">The type of the packet</typeparam>
-    /// <param name="packet"></param>
-    /// <param name="entityId"></param>
+    /// <param name="packet">The packet</param>
+    /// <param name="entityId">Id of the entity the packet is for</param>
     /// <param name="controllerIdParameter">If not provided on the <see cref="GSSMessageAttribute" /> on the packet, the controller Id may be specified here</param>
     /// <param name="messageEnumType">Optionally, the enum type containing the message id may be specified for enhanced verbose-level logging</param>
     /// <returns>true if the operation succeeded, false in all other cases</returns>
@@ -343,16 +376,22 @@ public bool SendGSSClass<TPacket>(TPacket packet, ulong entityId, Enums.GSS.Cont
         return SendPacketMemory(entityId, messageId, controllerId, ref packetToSend, messageEnumType);
     }
 
+    public bool SendChecksum(ulong entityId, Enums.GSS.Controllers controllerId, uint checksum)
+    {
+        var messageData = Serializer.WritePrimitive(checksum);
+        return SendPacketMemory(entityId, 2, controllerId, ref messageData);
+    }
+
     /// <summary>
     ///     Send an <see cref="IAero" /> package to the client
     /// </summary>
     /// <typeparam name="TPacket">The type of the packet</typeparam>
-    /// <param name="packet"></param>
-    /// <param name="entityId"></param>
+    /// <param name="packet">The Aero message</param>
+    /// <param name="entityId">Id of the entity the packet is for</param>
     /// <param name="messageIdOverride">Optional way to override the message ID</param>
     /// <param name="messageEnumType">Optionally, the enum type containing the message id may be specified for enhanced verbose-level logging</param>
     /// <returns>true if the operation succeeded, false in all other cases</returns>
-    /// <exception cref="ArgumentException"></exception>
+    /// <exception cref="ArgumentException">The passed packet does not have the AeroMessageIdAttribute</exception>
     public bool SendIAero<TPacket>(TPacket packet, ulong entityId = 0, byte messageIdOverride = 0, Type? messageEnumType = null)
         where TPacket : class, IAero
     {
@@ -383,6 +422,7 @@ public bool SendIAero<TPacket>(TPacket packet, ulong entityId = 0, byte messageI
                 }
 
             case AeroMessageIdAttribute.MsgType.Control:
+                return SendPacketMemoryMatrix(messageId, ref packetMemory, messageEnumType); // Everything's gonna be just fine
             default:
                 throw new ArgumentException("Message type not implemented");
         }
@@ -404,6 +444,33 @@ public bool SendIAeroControllerKeyframe<TPacket>(TPacket packet, ulong entityId,
         return SendPacketMemory(entityId, 4, controllerId, ref messageData);
     }
 
+    public bool SendIAeroControllerRemove<TPacket>(TPacket packet, ulong entityId, ulong playerId)
+        where TPacket : class, IAero
+    {
+        if (typeof(TPacket).GetCustomAttributes(typeof(AeroMessageIdAttribute), false).FirstOrDefault() is not AeroMessageIdAttribute aeroMsgAttr)
+        {
+            throw new ArgumentException($"The passed package is required to be annotated with {nameof(AeroMessageIdAttribute)} (Type: {typeof(TPacket).FullName})");
+        }
+
+        var controllerId = (Enums.GSS.Controllers)aeroMsgAttr.ControllerId;
+        var messageData = new Memory<byte>(new byte[8]);
+        Serializer.WritePrimitive(playerId).CopyTo(messageData);
+        return SendPacketMemory(entityId, 5, controllerId, ref messageData);
+    }
+
+    public bool SendIAeroScopeOut<TPacket>(TPacket packet, ulong entityId)
+        where TPacket : class, IAero
+    {
+        if (typeof(TPacket).GetCustomAttributes(typeof(AeroMessageIdAttribute), false).FirstOrDefault() is not AeroMessageIdAttribute aeroMsgAttr)
+        {
+            throw new ArgumentException($"The passed package is required to be annotated with {nameof(AeroMessageIdAttribute)} (Type: {typeof(TPacket).FullName})");
+        }
+
+        var controllerId = (Enums.GSS.Controllers)aeroMsgAttr.ControllerId;
+        var messageData = new Memory<byte>(new byte[0]);
+        return SendPacketMemory(entityId, 6, controllerId, ref messageData);
+    }
+
     public bool SendIAeroChanges<TPacket>(TPacket packet, ulong entityId)
         where TPacket : class, IAeroViewInterface
     {
@@ -419,13 +486,26 @@ public bool SendIAeroChanges<TPacket>(TPacket packet, ulong entityId)
         return SendPacketMemory(entityId, 1, typeCode, ref packetMemory);
     }
 
+    public bool SendIAeroChanges<TPacket>(TPacket packet, ulong entityId, Memory<byte> packetMemory)
+        where TPacket : class, IAeroViewInterface
+    {
+        if (typeof(TPacket).GetCustomAttributes(typeof(AeroMessageIdAttribute), false).FirstOrDefault() is not AeroMessageIdAttribute aeroMsgAttr)
+        {
+            throw new ArgumentException($"The passed package is required to be annotated with {nameof(AeroMessageIdAttribute)} (Type: {typeof(TPacket).FullName})");
+        }
+
+        var typeCode = (Enums.GSS.Controllers)aeroMsgAttr.ControllerId;
+
+        return SendPacketMemory(entityId, 1, typeCode, ref packetMemory);
+    }
+
     /// <summary>
     ///     Send serialized data of a gss channel packet to the client
     /// </summary>
-    /// <param name="entityId"></param>
-    /// <param name="messageId"></param>
-    /// <param name="controllerId"></param>
-    /// <param name="packetToSend"></param>
+    /// <param name="entityId">Id of the entity the packet is for</param>
+    /// <param name="messageId">Message Id relative to the controllerId</param>
+    /// <param name="controllerId">Typecode of the entity matching the view or controller</param>
+    /// <param name="packetToSend">Memory buffer</param>
     /// <param name="msgEnumType">Optionally, the enum type containing the message id may be specified for enhanced verbose-level logging</param>
     /// <returns>true if the operation succeeded, false in all other cases</returns>
     /// <exception cref="InvalidOperationException">If <see cref="msgEnumType" /> is not null and does not contain an element with a value equal to <see cref="messageId" /> </exception>
@@ -472,8 +552,8 @@ private bool SendPacketMemory(ulong entityId,
     /// <summary>
     ///     Send serialized data of a matrix channel packet to the client
     /// </summary>
-    /// <param name="messageId"></param>
-    /// <param name="packetMemory"></param>
+    /// <param name="messageId">Id of the matrix message being sent</param>
+    /// <param name="packetMemory">Memory buffer</param>
     /// <param name="msgEnumType">TODO: Optionally, the enum type containing the message id may be specified for enhanced verbose-level logging</param>
     /// <returns>true if the operation succeeded, false in all other cases</returns>
     private bool SendPacketMemoryMatrix(byte messageId, ref Memory<byte> packetMemory, Type? msgEnumType = null)
@@ -488,7 +568,7 @@ private bool SendPacketMemoryMatrix(byte messageId, ref Memory<byte> packetMemor
     /// <summary>
     ///     Send data to the client
     /// </summary>
-    /// <param name="packetData"></param>
+    /// <param name="packetData">Memory buffer</param>
     /// <returns>true if the operation succeeded, false in all other cases</returns>
     private bool Send(Memory<byte> packetData)
     {

UdpHosts/GameServer/ChannelType.cs

@@ -1,6 +1,9 @@
 #nullable enable
+using System.Diagnostics.CodeAnalysis;
+
 namespace GameServer;
 
+[SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1602:EnumerationItemsMustBeDocumented", Justification = "See the wiki for more details on how the channels differ: https://github.com/themeldingwars/Documentation/wiki/Game-Server-Protocol-Overview#main-connection")]
 public enum ChannelType : byte
 {
     Control = 0,