merge Sewer56/main into main

.github/workflows/reloaded.yml

@@ -48,6 +48,10 @@ env:
   PUBLISH_GAMEBANANA_BF_PATH: ./Publish/ToUpload/BF/GameBanana
   PUBLISH_GITHUB_BF_PATH: ./Publish/ToUpload/BF/Generic
   PUBLISH_NUGET_BF_PATH: ./Publish/ToUpload/BF/NuGet
+
+  PUBLISH_GAMEBANANA_SPD_PATH: ./Publish/ToUpload/SPD/GameBanana
+  PUBLISH_GITHUB_SPD_PATH: ./Publish/ToUpload/SPD/Generic
+  PUBLISH_NUGET_SPD_PATH: ./Publish/ToUpload/SPD/NuGet
 
   PUBLISH_GAMEBANANA_FRAMEWORK_PATH: ./Publish/ToUpload/Framework/GameBanana
   PUBLISH_GITHUB_FRAMEWORK_PATH: ./Publish/ToUpload/Framework/Generic
@@ -119,6 +123,7 @@ jobs:
           ${{ env.PUBLISH_GITHUB_ARC_PATH }}/*
           ${{ env.PUBLISH_GITHUB_PAK_PATH }}/*
           ${{ env.PUBLISH_GITHUB_BF_PATH }}/*
+          ${{ env.PUBLISH_GITHUB_SPD_PATH }}/*
           ${{ env.PUBLISH_GITHUB_FRAMEWORK_PATH }}/*
           
     - name: Upload GameBanana Release Artifact
@@ -134,6 +139,7 @@ jobs:
           ${{ env.PUBLISH_GAMEBANANA_ARC_PATH }}/*
           ${{ env.PUBLISH_GAMEBANANA_PAK_PATH }}/*
           ${{ env.PUBLISH_GAMEBANANA_BF_PATH }}/*
+          ${{ env.PUBLISH_GAMEBANANA_SPD_PATH }}/*
           ${{ env.PUBLISH_GAMEBANANA_FRAMEWORK_PATH }}/*
         
     - name: Upload NuGet Release Artifact
@@ -149,6 +155,7 @@ jobs:
           ${{ env.PUBLISH_NUGET_ARC_PATH }}/*
           ${{ env.PUBLISH_NUGET_PAK_PATH }}/*
           ${{ env.PUBLISH_NUGET_BF_PATH }}/*
+          ${{ env.PUBLISH_NUGET_SPD_PATH }}/*
           ${{ env.PUBLISH_NUGET_FRAMEWORK_PATH }}/*
         
     - name: Upload Changelog Artifact
@@ -174,6 +181,7 @@ jobs:
           ${{ env.PUBLISH_GITHUB_ARC_PATH }}/*
           ${{ env.PUBLISH_GITHUB_PAK_PATH }}/*
           ${{ env.PUBLISH_GITHUB_BF_PATH }}/*
+          ${{ env.PUBLISH_GITHUB_SPD_PATH }}/*
           ${{ env.PUBLISH_GITHUB_FRAMEWORK_PATH }}/*
         
     - name: Push to NuGet (on Tag)

Emulator/AFS.Stream.Emulator/AFS.Stream.Emulator.csproj

@@ -47,8 +47,8 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="AFSLib" Version="1.1.0" />
-    <PackageReference Include="Reloaded.Memory" Version="8.0.1" />
+    <PackageReference Include="AFSLib" Version="1.1.1" />
+    <PackageReference Include="Reloaded.Memory" Version="9.3.2" />
     <PackageReference Include="Reloaded.Mod.Interfaces" Version="2.3.0" ExcludeAssets="runtime" />
   </ItemGroup>
 

Emulator/AFS.Stream.Emulator/Afs/AfsBuilder.cs

@@ -5,6 +5,7 @@
 using FileEmulationFramework.Lib.IO.Struct;
 using FileEmulationFramework.Lib.Utilities;
 using Microsoft.Win32.SafeHandles;
+using Reloaded.Memory.Extensions;
 using Reloaded.Memory.Streams;
 
 // Aliasing for readability, since our assembly name has priority over 'stream'
@@ -75,8 +76,8 @@ public unsafe MultiStream Build(IntPtr handle, string filepath, Logger? logger =
         headerStream.SetLength(headerLength);
 
         // Write header magic and file count
-        headerStream.Write<int>(0x00534641); // 'AFS '
-        headerStream.Write<int>(numFiles);
+        headerStream.Write(0x00534641); // 'AFS '
+        headerStream.Write(numFiles);
 
         // Make MultiStream
         var pairs = new List<StreamOffsetPair<Strim>>()

Emulator/ARC.Stream.Emulator/ARC.Stream.Emulator.csproj

@@ -45,7 +45,7 @@
   </ItemGroup>
 
   <ItemGroup>
-	  <PackageReference Include="Reloaded.Memory" Version="8.0.1" />
+	  <PackageReference Include="Reloaded.Memory" Version="9.3.2" />
 	  <PackageReference Include="Reloaded.Mod.Interfaces" Version="2.3.0" ExcludeAssets="runtime" />
   </ItemGroup>
 

Emulator/ARC.Stream.Emulator/Arc/ArcBuilder.cs

@@ -5,6 +5,7 @@
 using FileEmulationFramework.Lib.IO.Struct;
 using FileEmulationFramework.Lib.Utilities;
 using Microsoft.Win32.SafeHandles;
+using Reloaded.Memory.Extensions;
 using Reloaded.Memory.Streams;
 
 // Aliasing for readability, since our assembly name has priority over 'stream'
@@ -42,7 +43,7 @@ public unsafe MultiStream Build(IntPtr handle, string filepath, Logger? logger =
         MemoryStream headerStream = new MemoryStream(headerLength);
 
         // Write header magic and file count
-        headerStream.Write( 0x4C435241 ); // 'ARCL'
+        headerStream.Write(0x4C435241); // 'ARCL'
         headerStream.Write(numFiles);
 
         // Make MultiStream
@@ -70,7 +71,6 @@ public unsafe MultiStream Build(IntPtr handle, string filepath, Logger? logger =
             }
             else if (x < entries.Length)
             {
-
                 length = (int)entries[x].Length;
 
                 var originalEntry = new FileSlice(entries[x].Offset, length, filepath);

Emulator/AWB.Stream.Emulator/AWB.Stream.Emulator.csproj

@@ -44,7 +44,7 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="Reloaded.Memory" Version="8.0.1" />
+    <PackageReference Include="Reloaded.Memory" Version="9.3.2" />
     <PackageReference Include="Reloaded.Mod.Interfaces" Version="2.3.0" ExcludeAssets="runtime" />
     <PackageReference Include="Reloaded.Memory.SigScan.ReloadedII.Interfaces" Version="1.2.0" />
   </ItemGroup>

Emulator/AWB.Stream.Emulator/Awb/AwbBuilder.cs

@@ -5,6 +5,7 @@
 using FileEmulationFramework.Lib.IO.Struct;
 using FileEmulationFramework.Lib.Utilities;
 using Microsoft.Win32.SafeHandles;
+using Reloaded.Memory.Extensions;
 using Reloaded.Memory.Streams;
 
 // Aliasing for readability, since our assembly name has priority over 'stream'
@@ -73,14 +74,14 @@ public MultiStream Build(IntPtr handle, string filepath, Logger? logger = null)
         headerStream.SetLength(headerLength);
 
         // Write header magic and file count
-        headerStream.Write<int>(Afs2Header.ExpectedMagic); // 'AFS2'
-        headerStream.Write<byte>((byte)(subKey != 0 ? 2 : 1)); // 'Type'
-        headerStream.Write<byte>(posFieldSize); // 'PosLength'
-        headerStream.Write<byte>(idFieldSize); // 'IdLength'
-        headerStream.Write<byte>(0); // 'Pad'
-        headerStream.Write<int>(numFiles); // 'Entry Count'
-        headerStream.Write<short>(AwbAlignment); // 'Alignment'
-        headerStream.Write<short>(subKey); // 'Encryption Key'
+        headerStream.Write(Afs2Header.ExpectedMagic); // 'AFS2'
+        headerStream.Write((byte)(subKey != 0 ? 2 : 1)); // 'Type'
+        headerStream.Write(posFieldSize); // 'PosLength'
+        headerStream.Write(idFieldSize); // 'IdLength'
+        headerStream.Write((byte)0); // 'Pad'
+        headerStream.Write(numFiles); // 'Entry Count'
+        headerStream.Write((short)AwbAlignment); // 'Alignment'
+        headerStream.Write((short)subKey); // 'Encryption Key'
 
         // Make MultiStream
         var pairs = new List<StreamOffsetPair<Strim>>()

Emulator/AWB.Stream.Emulator/Awb/Utilities/ValueWriters.cs

@@ -1,4 +1,5 @@
-using Reloaded.Memory.Streams;
+using Reloaded.Memory.Extensions;
+using Reloaded.Memory.Streams;
 // ReSharper disable RedundantTypeArgumentsOfMethod
 
 namespace AWB.Stream.Emulator.Awb.Utilities;
@@ -19,16 +20,16 @@ public static void WriteNumber(this MemoryStream stream, long value, int size)
         switch (size)
         {
             case 1:
-                stream.Write<byte>((byte)value);
+                stream.Write((byte)value);
                 break;
             case 2:                
-                stream.Write<short>((short)value);
+                stream.Write((short)value);
                 break;
             case 4:
-                stream.Write<int>((int)value);
+                stream.Write((int)value);
                 break;
             case 8:
-                stream.Write<long>(value);
+                stream.Write(value);
                 break;
             default:
                 ThrowHelpers.ThrowBadFieldSizeException();

Emulator/BF.File.Emulator/BfEmulator.cs

@@ -141,7 +141,11 @@ public void OnModLoading(string modFolder)
     /// Invalidates a BF file with a specified name.
     /// </summary>
     /// <param name="bfPath">Full path to the file.</param>
-    public void UnregisterFile(string bfPath) => _pathToStream!.Remove(bfPath, out _);
+    public void UnregisterFile(string bfPath)
+    {
+        _pathToStream!.Remove(bfPath, out var stream);
+        stream?.Dispose();
+    }
 
     public void RegisterFile(string destinationPath, Stream stream)
     {

Emulator/BF.File.Emulator/BfEmulatorApi.cs

@@ -56,13 +56,9 @@ public void RegisterBf(string sourcePath, string destinationPath)
         }
 
         Native.SetFilePointerEx(handle, 0, IntPtr.Zero, 0);
-
-        var fileStream = new FileStream(new SafeFileHandle(handle, false), FileAccess.Read);
-        var stream = StreamUtils.CreateMemoryStream(fileStream.Length);
-        fileStream.CopyTo(stream);
-
-        var emulated = new EmulatedFile<Stream>(stream);
-        _bfEmulator.RegisterFile(destinationPath, stream);
+        var fileStream = new FileStream(new SafeFileHandle(handle, true), FileAccess.Read);
+        var emulated = new EmulatedFile<FileStream>(fileStream);
+        _bfEmulator.RegisterFile(destinationPath, fileStream);
         _framework.RegisterVirtualFile(destinationPath, emulated, false);
 
         _logger.Info("[BfEmulatorApi] Registered bf {0} at {1}", sourcePath, destinationPath);

Emulator/Interfaces/SPD.File.Emulator.Interfaces/ISpdEmulator.cs

@@ -0,0 +1,57 @@
+using SPD.File.Emulator.Interfaces.Structures.IO;
+
+namespace SPD.File.Emulator.Interfaces;
+
+/// <summary>
+/// APIs exposed by Spd Emulator.
+/// </summary>
+public interface ISpdEmulator
+{
+    /// <summary>
+    /// Tries to create an emulated SPD file using an SPD file embedded inside another file as source.
+    /// </summary>
+    /// <param name="sourcePath">Path to the file from which the data will be sourced.</param>
+    /// <param name="offset">Offset in the file where the SPD starts.</param>
+    /// <param name="route">The route of the emulated file.</param>
+    /// <param name="destinationPath">Path to where the emulated file should be put.</param>
+    public bool TryCreateFromFileSlice(string sourcePath, long offset, string route, string destinationPath);
+
+    /// <summary>
+    /// Tries to create an emulated SPD file by merging any applicable sprite or texture files, using the input as the base
+    /// </summary>
+    /// <param name="sourcePath">Path to the SPD file to use as a base.</param>
+    /// <param name="route">The route of the emulated SPD file.</param>
+    /// <param name="destinationPath">Path to where the emulated SPD file should be put.</param>
+    public bool TryCreateFromSpd(string sourcePath, string route, string destinationPath);
+
+    /// <summary>
+    /// Invalidates a file, i.e. unregisters it, will be recreated on next access.
+    /// </summary>
+    /// <param name="SPDPath">Path of the SPD file.</param>
+    public void InvalidateFile(string SPDPath);
+
+    /// <summary>
+    /// Gets the list of input files from other mods fed into the emulator.
+    /// </summary>
+    public RouteGroupTuple[] GetEmulatorInput();
+
+    /// <summary>
+    /// Registers an already merged SPD as an emulated one
+    /// </summary>
+    /// <param name="sourcePath">The path to the SPD file to register</param>
+    /// <param name="destinationPath">The path where the emulated SPD file should be put</param>
+    public void RegisterSpd(string sourcePath, string destinationPath);
+
+    /// <summary>
+    /// Adds a new file to be injected into emulated SPDs
+    /// </summary>
+    /// <param name="file">The path to the file to add</param>
+    /// <param name="route">The route the file is in</param>
+    public void AddFile(string file, string route);
+
+    /// <summary>
+    /// Adds a directory to SPD Emulator so it's like the files were in FEmulator\SPD
+    /// </summary>
+    /// <param name="dir">The directory to add the files from</param>
+    public void AddDirectory(string dir);
+}

Emulator/Interfaces/SPD.File.Emulator.Interfaces/SPD.File.Emulator.Interfaces.csproj

@@ -0,0 +1,9 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <TargetFramework>net7.0</TargetFramework>
+    <ImplicitUsings>enable</ImplicitUsings>
+    <Nullable>enable</Nullable>
+  </PropertyGroup>
+
+</Project>

Emulator/Interfaces/SPD.File.Emulator.Interfaces/Structures/IO/Structures.cs

@@ -0,0 +1,50 @@
+namespace SPD.File.Emulator.Interfaces.Structures.IO;
+
+
+/// <summary>
+/// Represents information tied to an individual directory.
+/// </summary>
+public struct DirectoryInformation
+{
+    /// <summary>
+    /// Full path to the directory.
+    /// </summary>
+    public string FullPath;
+
+    /// <summary>
+    /// Last time this directory was modified.
+    /// </summary>
+    public DateTime LastWriteTime;
+}
+
+/// <summary>
+/// Groups a single directory and a list of files associated with it.
+/// </summary>
+public class DirectoryFilesGroup
+{
+    /// <summary>
+    /// The directory in question.
+    /// </summary>
+    public DirectoryInformation Directory;
+
+    /// <summary>
+    /// The relative file paths tied to this directory.
+    /// </summary>
+    public string[] Files = Array.Empty<string>();
+}
+
+/// <summary>
+/// A tuple representing a group and a route.
+/// </summary>
+public struct RouteGroupTuple
+{
+    /// <summary>
+    /// Route associated with this tuple.
+    /// </summary>
+    public string Route;
+
+    /// <summary>
+    /// Files bound by this route.
+    /// </summary>
+    public DirectoryFilesGroup Files;
+}

Emulator/ONE.Heroes.Stream.Emulator/ONE.Heroes.Stream.Emulator.csproj

@@ -48,7 +48,7 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="Reloaded.Memory" Version="8.0.1" />
+    <PackageReference Include="Reloaded.Memory" Version="9.3.2" />
     <PackageReference Include="Reloaded.Mod.Interfaces" Version="2.3.0" ExcludeAssets="runtime" />
     <PackageReference Include="Reloaded.SharedLib.CSharp.Prs.Interfaces" Version="1.0.2" />
   </ItemGroup>

Emulator/ONE.Heroes.Stream.Emulator/One/OneBuilder.cs

@@ -5,6 +5,7 @@
 using Heroes.SDK.Definitions.Structures.Archive.OneFile;
 using Heroes.SDK.Definitions.Structures.RenderWare;
 using Microsoft.Win32.SafeHandles;
+using Reloaded.Memory.Extensions;
 using Reloaded.Memory.Streams;
 
 // Aliasing for readability, since our assembly name has priority over 'stream'
@@ -145,7 +146,7 @@ private unsafe Dictionary<string, OneBuilderItem> GetExistingFiles(IntPtr hFile,
     {
         var fileStream = new FileStream(new SafeFileHandle(hFile, false), FileAccess.Read);
         var originalPos = fileStream.Position;
-        using var reader = new BufferedStreamReader(fileStream, 4096); // common cluster size on Windows
+        using var reader = new BufferedStreamReader<FileStream>(fileStream, 4096); // common cluster size on Windows
         var result = new Dictionary<string, OneBuilderItem>();
 
         // Read headers.
@@ -163,13 +164,13 @@ private unsafe Dictionary<string, OneBuilderItem> GetExistingFiles(IntPtr hFile,
         // Note: Heroes leaves 2 blank name slots that are unused at runtime, so file count is that and 2 less.
         for (int x = 0; x < fileNameCount - 2; x++)
         {
-            var stillMoreData = reader.Position() < fileStream.Length;
+            var stillMoreData = reader.Position < fileStream.Length;
             if (!stillMoreData)
                 break;
 
             reader.Read<OneFileEntry>(out var currentEntry);
             var fileName    = fileNames[currentEntry.FileNameIndex].ToString();
-            var fileDataPos = reader.Position();
+            var fileDataPos = reader.Position;
             var fileSize    = currentEntry.FileSize;
 #if DEBUG
             if (fileSize == 0)

Emulator/PAK.Stream.Emulator/PAK.Stream.Emulator.csproj

@@ -46,7 +46,7 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="Reloaded.Memory" Version="8.0.1" />
+    <PackageReference Include="Reloaded.Memory" Version="9.3.2" />
     <PackageReference Include="Reloaded.Mod.Interfaces" Version="2.3.0" ExcludeAssets="runtime" />
     <PackageReference Include="Reloaded.Memory.SigScan.ReloadedII.Interfaces" Version="1.2.0" />
   </ItemGroup>