Merge branch 'staging'

Author: MattFiler

CathodeLib/CathodeLib.csproj

@@ -10,14 +10,15 @@
     <Authors>Matt Filer</Authors>
     <Description>Provides support for parsing and writing common Alien: Isolation formats from the Cathode engine.</Description>
     <Copyright>Matt Filer 2026</Copyright>
-    <Version>0.11.2</Version>
+    <Version>0.12.0</Version>
     <OutputType>Library</OutputType>
-    <AssemblyVersion>0.11.2.0</AssemblyVersion>
-    <FileVersion>0.11.2.0</FileVersion>
+    <AssemblyVersion>0.12.0.0</AssemblyVersion>
+    <FileVersion>0.12.0.0</FileVersion>
     <AllowUnsafeBlocks>False</AllowUnsafeBlocks>
     <PackageReadmeFile>README.md</PackageReadmeFile>
     <PackageTags>alien, modding, alien isolation, mod tool, file utility</PackageTags>
     <Title>CathodeLib</Title>
+    <Configurations>Debug;Release;Ship</Configurations>
   </PropertyGroup>
 
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
@@ -28,6 +29,10 @@
     <DefineConstants>$(DefineConstants)TRACE</DefineConstants>
   </PropertyGroup>
 
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Ship|AnyCPU'">
+    <DefineConstants>$(DefineConstants)TRACE</DefineConstants>
+  </PropertyGroup>
+
   <ItemGroup>
     <Compile Remove="CathodeBIN\NewFolder\**" />
     <EmbeddedResource Remove="CathodeBIN\NewFolder\**" />
@@ -47,10 +52,13 @@
   </ItemGroup>
 
   <ItemGroup>
+    <PackageReference Include="K4os.Compression.LZ4" Version="1.3.8" />
+    <PackageReference Include="K4os.Compression.LZ4.Streams" Version="1.3.8" />
     <PackageReference Include="System.Buffers" Version="4.5.1" />
-    <PackageReference Include="System.Memory" Version="4.5.4" />
+    <PackageReference Include="System.Memory" Version="4.5.5" />
     <PackageReference Include="System.Numerics.Vectors" Version="4.5.0" />
     <PackageReference Include="System.Runtime.CompilerServices.Unsafe" Version="5.0.0" />
+    <PackageReference Include="xxHash.NET" Version="1.0.2" />
   </ItemGroup>
 
   <ItemGroup>

CathodeLib/Resources/info.dat

@@ -4,6 +4,7 @@
 using System;
 using System.Collections.Generic;
 using System.IO;
+using System.IO.Compression;
 using System.Linq;
 using System.Runtime.InteropServices;
 using System.Threading.Tasks;
@@ -25,6 +26,9 @@ public class CollisionMaps : CathodeFile
         private Materials _materials;
         private MaterialMappings _materialMaps;
 
+        public bool Compressed { get { return _compressed; } set { _compressed = value; } }
+        private bool _compressed = false;
+
         private List<COLLISION_MAPPING> _writeList = new List<COLLISION_MAPPING>();
 
         public CollisionMaps(string path, Materials materials, MaterialMappings materialMaps) : base(path)
@@ -51,7 +55,9 @@ public void ClearReferences()
         #region FILE_IO
         override protected bool LoadInternal(MemoryStream stream)
         {
-            using (BinaryReader reader = new BinaryReader(stream))
+            _compressed = _filepath != null && _filepath != "" && Path.GetExtension(_filepath).ToLower() == ".gz";
+
+            using (BinaryReader reader = new BinaryReader(_compressed ? Utilities.GZIPDecompress(stream) : stream))
             {
                 //The way this works:
                 // - First 18 entries are empty
@@ -76,12 +82,18 @@ override protected bool LoadInternal(MemoryStream stream)
                     Entries.Add(entry);
                 }
             }
+
             _writeList.AddRange(Entries);
             return true;
         }
 
         override protected bool SaveInternal()
         {
+            if (_compressed && Path.GetExtension(_filepath).ToLower() != ".gz")
+                _filepath += ".gz";
+            else if (!_compressed && Path.GetExtension(_filepath).ToLower() == ".gz")
+                _filepath = _filepath.Substring(0, _filepath.Length - 3);
+
             //composite_instance_id defo has something to do with the ordering as all the zeros are first
 
             //Entries = Entries.OrderBy(o => o.entity.entity_id.ToUInt32() + o.id.ToUInt32()).ThenBy(o => o.entity.composite_instance_id.ToUInt32()).ThenBy(o => o.zone_id.ToUInt32()).ToList();
@@ -92,14 +104,19 @@ override protected bool SaveInternal()
                 entryBuffers[i] = SerializeEntry(Entries[i]);
             });
 
-            using (BinaryWriter writer = new BinaryWriter(File.OpenWrite(_filepath)))
+            using (Stream stream = File.OpenWrite(_filepath))
+            using (BinaryWriter writer = new BinaryWriter(stream))
             {
                 writer.BaseStream.SetLength(0);
                 writer.Write((Entries.Count) * 48);
                 writer.Write(Entries.Count);
                 for (int i = 0; i < entryBuffers.Length; i++)
                     writer.Write(entryBuffers[i]);
             }
+
+            if (_compressed)
+                Utilities.GZIPCompress(_filepath);
+
             _writeList.Clear();
             _writeList.AddRange(Entries);
             return true;

CathodeLib/Resources/sound_names.bin

@@ -10,6 +10,8 @@
 using static CATHODE.Movers;
 using static CATHODE.Models;
 using CathodeLib.ObjectExtensions;
+using System.IO.Compression;
+
 
 
 #if UNITY_EDITOR || UNITY_STANDALONE_WIN
@@ -28,12 +30,15 @@ public class Collisions : CathodeFile
         public List<WeightedCollision> Entries = new List<WeightedCollision>();
         public static new Implementation Implementation = Implementation.CREATE | Implementation.LOAD | Implementation.SAVE;
 
+        public bool Compressed { get { return _compressed; } set { _compressed = value; } }
+        private bool _compressed = false;
+
+        private List<WeightedCollision> _writeList = new List<WeightedCollision>();
+
         public Collisions(string path) : base(path) { }
         public Collisions(MemoryStream stream, string path = "") : base(stream, path) { }
         public Collisions(byte[] data, string path = "") : base(data, path) { }
 
-        private List<WeightedCollision> _writeList = new List<WeightedCollision>();
-
         ~Collisions()
         {
             Entries.Clear();
@@ -43,7 +48,9 @@ public Collisions(byte[] data, string path = "") : base(data, path) { }
         #region FILE_IO
         override protected bool LoadInternal(MemoryStream stream)
         {
-            using (var reader = new BinaryReader(stream))
+            _compressed = _filepath != null && _filepath != "" && Path.GetExtension(_filepath).ToLower() == ".gz";
+
+            using (var reader = new BinaryReader(_compressed ? Utilities.GZIPDecompress(stream) : stream))
             {
                 //remove these if exceptions dont throw
                 byte[] magic = reader.ReadBytes(4);
@@ -109,12 +116,18 @@ override protected bool LoadInternal(MemoryStream stream)
                     }
                 }
             }
+
             _writeList.AddRange(Entries);
             return true;
         }
 
         override protected bool SaveInternal()
         {
+            if (_compressed && Path.GetExtension(_filepath).ToLower() != ".gz")
+                _filepath += ".gz";
+            else if (!_compressed && Path.GetExtension(_filepath).ToLower() == ".gz")
+                _filepath = _filepath.Substring(0, _filepath.Length - 3);
+
             var collisionData = new List<WeightedCollisionData>();
             var boneData = new List<BoneData>();
             var vertexData = new List<VertexData>();
@@ -177,7 +190,8 @@ override protected bool SaveInternal()
                 }
             }
 
-            using (var writer = new BinaryWriter(File.OpenWrite(_filepath)))
+            using (Stream stream = File.OpenWrite(_filepath))
+            using (BinaryWriter writer = new BinaryWriter(stream))
             {
                 writer.BaseStream.SetLength(0);
                 writer.Write(new byte[4] { 0x0C, 0xA0, 0xFE, 0xEF });
@@ -200,6 +214,10 @@ override protected bool SaveInternal()
                 vertexData.ForEach(v => Utilities.Write(writer, v));
                 indexData.ForEach(i => writer.Write(i));
             }
+
+            if (_compressed)
+                Utilities.GZIPCompress(_filepath);
+
             _writeList.Clear();
             _writeList.AddRange(Entries);
             return true;

CathodeLib/Scripts/CATHODE/CollisionMaps.cs

@@ -9,6 +9,9 @@
 using System.Runtime.InteropServices.ComTypes;
 using System.Threading.Tasks;
 using CATHODE.Scripting.Internal.Parsers;
+using System.Runtime.CompilerServices;
+
+
 
 
 #if UNITY_EDITOR || UNITY_STANDALONE_WIN
@@ -32,6 +35,9 @@ public class Commands : CathodeFile
         private CollisionMaps _colMaps;
         private RenderableElements _reds;
 
+        public bool Compressed { get { return _compressed; } set { _compressed = value; } }
+        private bool _compressed = false;
+
         public Commands(string path, EnvironmentAnimations envAnims, CollisionMaps colMaps, RenderableElements reds) : base(path)
         {
             _envAnims = envAnims;
@@ -41,6 +47,19 @@ public Commands(string path, EnvironmentAnimations envAnims, CollisionMaps colMa
             Utils = new CommandsUtils(this);
 
             _loaded = Load();
+
+            //Overwrite loaded data with the data from BIN
+            switch  (Path.GetExtension(_filepath).ToUpper())
+            {
+                case ".BIN":
+                case ".GZ":
+                    foreach (var composites in CommandsBIN.EntityNames)
+                        foreach (var entities in composites.Value)
+                            Utils.SetEntityName(composites.Key, entities.Key, entities.Value);
+                    foreach (var others in CommandsBIN.ParameterNames)
+                        ShortGuidUtils.Generate(others.Value); // do we even need to do this?
+                    break;
+            }
         }
 
         public void ClearReferences()
@@ -63,12 +82,6 @@ public void ClearReferences()
         private ShortGuid[] _entryPoints = null;
         private Composite[] _entryPointObjects = null;
 
-        /// <summary>
-        /// Set this value to true before initialising your Commands object to load with non-capitalised composite names.
-        /// Changing this value AFTER loading will not make any difference to the loaded Commands object, only future ones.
-        /// </summary>
-        public static bool UsePrettyPaths = false;
-
         /// <summary>
         /// Use this to access various utilities for dealing with Commands data.
         /// Additional metadata generated by these utils will write to your Commands file when saved.
@@ -78,29 +91,21 @@ public void ClearReferences()
         #region FILE_IO
         override protected bool LoadInternal(MemoryStream stream)
         {
-            byte[] content = stream.ToArray();
+            _compressed = _filepath != null && _filepath != "" && Path.GetExtension(_filepath).ToLower() == ".gz";
+
             switch (Path.GetExtension(_filepath).ToUpper())
             {
                 case ".PAK":
                     CommandsPAK.Read(stream, out _entryPoints, out Entries, _envAnims, _colMaps, _reds);
                     break;
+                case ".GZ":
                 case ".BIN":
-                    CommandsBIN.Read(stream, out _entryPoints, out Entries, _envAnims, _colMaps, _reds);
+                    CommandsBIN.Read(_compressed ? Utilities.GZIPDecompress(stream) : stream, out _entryPoints, out Entries, _envAnims, _colMaps, _reds);
                     break;
                 default:
                     return false;
             }
 
-            if (UsePrettyPaths)
-            {
-                foreach (Composite composite in Entries)
-                {
-                    string prettyPath = CustomTable.Vanilla.CompositePaths.GetPrettyPath(composite.shortGUID);
-                    if (prettyPath != "") composite.name = prettyPath;
-                    composite.name = composite.name.Replace("/", "\\");
-                }   
-            }
-
             return true;
         }
 
@@ -110,6 +115,11 @@ override protected bool SaveInternal()
             if (Entries.Count == 0) return false;
             if (_entryPoints == null) _entryPoints = new ShortGuid[3];
 
+            if (_compressed && Path.GetExtension(_filepath).ToLower() != ".gz")
+                _filepath += ".gz";
+            else if (!_compressed && Path.GetExtension(_filepath).ToLower() == ".gz")
+                _filepath = _filepath.Substring(0, _filepath.Length - 3);
+
             #region FIX_POTENTIAL_ERRORS
             //If we have composites but the entry points are broken, correct them first!
             if (GetComposite(_entryPoints[2]) == null)
@@ -228,17 +238,24 @@ override protected bool SaveInternal()
                 case ".PAK":
                     CommandsPAK.Write(_entryPoints, Entries, out content, _envAnims, _colMaps, _reds);
                     break;
+                case ".GZ":
                 case ".BIN":
                     CommandsBIN.Write(_entryPoints, Entries, out content, _envAnims, _colMaps, _reds);
                     break;
                 default:
                     return false;
             }
-            using (BinaryWriter writer = new BinaryWriter(File.OpenWrite(_filepath)))
+
+            using (Stream stream = File.OpenWrite(_filepath))
+            using (BinaryWriter writer = new BinaryWriter(stream))
             {
                 writer.BaseStream.SetLength(0);
                 writer.Write(content);
             }
+
+            if (_compressed)
+                Utilities.GZIPCompress(_filepath);
+
             return true;
         }
         #endregion

CathodeLib/Scripts/CATHODE/Collisions.cs

@@ -1,4 +1,5 @@
 using CATHODE.Scripting.Internal;
+using CathodeLib;
 using System;
 using System.Collections.Generic;
 using System.Data;

CathodeLib/Scripts/CATHODE/Commands.cs

@@ -1,4 +1,4 @@
-using System;
+using System;
 using System.Collections.Generic;
 using System.Text;
 
@@ -1197,6 +1197,8 @@ public enum CustomTableType
         CATHODE_ENUM_INFO,                      // Database of available Cathode enums
         COMPOSITE_PATHS,                        // Full properly-cased paths for vanilla composites
         COMPOSITE_PAGE_HISTORY,                 // Stores the previously opened flowgraph page for a composite
+        FLAGS,                                  // A table of generic flags that can store level modification metadata
+        MATERIAL_MAPPINGS,                      // Stores material mappings to populate as parameters or aliases
 
         //Add new entries here
 
@@ -1211,5 +1213,6 @@ public enum CustomTableFileType
         COMMANDS_PAK,
         COMMANDS_BIN,
         STANDALONE,
+        COMMANDS_COMPRESSED,
     }
 }