@etothepii/satisfactory-file-parser 0.0.15 → 0.0.16

package/build/parser/satisfactory/blueprint/blueprint-writer.js

@@ -0,0 +1,63 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BlueprintConfigWriter = exports.BlueprintWriter = void 0;
+const alignment_enum_1 = require("../../byte/alignment.enum");
+const byte_writer_class_1 = require("../../byte/byte-writer.class");
+const parser_error_1 = require("../../error/parser.error");
+const level_class_1 = require("../save/level.class");
+const save_writer_1 = require("../save/save-writer");
+const util_types_1 = require("../structs/util.types");
+class BlueprintWriter extends byte_writer_class_1.ByteWriter {
+    constructor() {
+        super(alignment_enum_1.Alignment.LITTLE_ENDIAN);
+    }
+    static SerializeHeader(writer, header) {
+        writer.writeInt32(2);
+        writer.writeInt32(36);
+        writer.writeInt32(211839);
+        writer.writeInt32(4);
+        writer.writeInt32(4);
+        writer.writeInt32(4);
+        writer.writeInt32(header.itemCosts.length);
+        for (const itemCost of header.itemCosts) {
+            writer.writeInt32(0);
+            writer.writeString(itemCost[0]);
+            writer.writeInt32(itemCost[1]);
+        }
+        writer.writeInt32(header.recipeReferences.length);
+        for (const recipeReference of header.recipeReferences) {
+            writer.writeInt32(0);
+            writer.writeString(recipeReference);
+        }
+    }
+    generateChunks(compressionInfo, posAfterHeader, onBinaryBeforeCompressing, onHeader, onChunk) {
+        if (posAfterHeader <= 0) {
+            throw new parser_error_1.ParserError('ParserError', 'seems like this buffer has no header. Please write the header first before you can generate chunks.');
+        }
+        const header = new Uint8Array(this.bufferArray.slice(0, posAfterHeader));
+        onHeader(header);
+        this.bufferArray = this.bufferArray.slice(posAfterHeader);
+        const chunkSummary = save_writer_1.SaveWriter.GenerateCompressedChunksFromData(this.bufferArray, compressionInfo, onBinaryBeforeCompressing, onChunk, this.alignment);
+        return chunkSummary;
+    }
+    static SerializeObjects(writer, objects) {
+        const headersLenIndicator = writer.getBufferPosition();
+        writer.writeInt32(0);
+        level_class_1.Level.SerializeObjectHeaders(writer, objects);
+        writer.writeBinarySizeFromPosition(headersLenIndicator, headersLenIndicator + 4);
+        level_class_1.Level.SerializeObjectContents(writer, objects, 0);
+    }
+}
+exports.BlueprintWriter = BlueprintWriter;
+class BlueprintConfigWriter extends byte_writer_class_1.ByteWriter {
+    constructor() {
+        super(alignment_enum_1.Alignment.LITTLE_ENDIAN);
+    }
+    static SerializeConfig(writer, config) {
+        writer.writeInt32(2);
+        writer.writeString(config.description);
+        writer.writeInt32(config.iconID);
+        (0, util_types_1.SerializeCol4RGBA)(writer, config.color);
+    }
+}
+exports.BlueprintConfigWriter = BlueprintConfigWriter;

package/build/parser/satisfactory/blueprint/blueprint.types.d.ts

@@ -0,0 +1,20 @@
+import { ChunkCompressionInfo } from "../../file.types";
+import { SaveComponent } from "../objects/SaveComponent";
+import { SaveEntity } from "../objects/SaveEntity";
+import { col4 } from "../structs/util.types";
+export interface BlueprintConfig {
+    description: string;
+    color: col4;
+    iconID: number;
+}
+export type BlueprintHeader = {
+    itemCosts: [string, number][];
+    recipeReferences: string[];
+};
+export interface Blueprint {
+    name: string;
+    compressionInfo: ChunkCompressionInfo;
+    header: BlueprintHeader;
+    config: BlueprintConfig;
+    objects: (SaveEntity | SaveComponent)[];
+}

package/build/parser/satisfactory/blueprint/blueprint.types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/build/parser/satisfactory/objects/DataFields.d.ts

@@ -1,5 +1,5 @@
 import { ByteReader } from "../../byte/byte-reader.class";
-import { SaveWriter } from "../../save-writer";
+import { SaveWriter } from "../save/save-writer";
 import { AbstractBaseProperty } from "./Property";
 export declare class DataFields {
     properties: any[];

package/build/parser/satisfactory/objects/DataFields.js

@@ -12,7 +12,6 @@ class DataFields {
         const start = reader.getBufferPosition();
         const fields = new DataFields();
         if (length === 0) {
-            //WARNING
             fields.shouldBeNulled = true;
             return fields;
         }
@@ -24,7 +23,6 @@ class DataFields {
         }
         let int1 = reader.readInt32();
         if (int1 !== 0) {
-            //WARNING
         }
         const end = reader.getBufferPosition();
         let remainingBytes = start + length - end;
@@ -36,18 +34,6 @@ class DataFields {
         if (currentProperty.name === 'None') {
             return null;
         }
-        //TODO: What is this extra byte that is appearing sometime?
-        // i dont think there is an extra byte.
-        /*
-        let extraByteTest = reader.readByte();
-        if (extraByteTest !== 0) {
-            reader.currentByte -= 1;
-        }
-        else {
-            console.log('Property extra byte', currentProperty);
-        }
-        */
-        //TODO assign type and index after parsing.
         const propertyType = reader.readString();
         const binarySize = reader.readInt32();
         const index = reader.readInt32();
@@ -83,12 +69,6 @@ class DataFields {
                 currentProperty = Property_1.Int64Property.Parse(reader, propertyType, index);
                 overhead = Property_1.Int64Property.CalcOverhead(currentProperty);
                 break;
-            // TODO
-            /*
-        case 'UInt64Property':
-            currentProperty = Int64Property.Parse(reader, propertyType, index);
-            break;
-            */
             case 'SingleProperty':
             case 'FloatProperty':
                 currentProperty = Property_1.FloatProperty.Parse(reader, propertyType, index);
@@ -121,7 +101,6 @@ class DataFields {
                 overhead = Property_1.ArrayProperty.CalcOverhead(currentProperty);
                 break;
             case 'MapProperty':
-                //currentProperty = reader.readMapProperty(currentProperty, '');
                 currentProperty = Property_1.MapProperty.Parse(reader, propertyName, buildVersion, binarySize);
                 overhead = Property_1.MapProperty.CalcOverhead(currentProperty);
                 break;
@@ -154,10 +133,8 @@ class DataFields {
     }
     static SerializeProperty(writer, property, propertyName, buildVersion) {
         writer.writeString(property.ueType);
-        // binary length indicator
         const lenIndicator = writer.getBufferPosition();
         writer.writeInt32(0);
-        // write index if it is not 0. Since it normally is.
         writer.writeInt32(property.index ?? 0);
         const start = writer.getBufferPosition();
         let overhead = 0;
@@ -191,7 +168,6 @@ class DataFields {
                 overhead = Property_1.Int64Property.CalcOverhead(property);
                 Property_1.Int64Property.Serialize(writer, property);
                 break;
-            // TODO: uint64Property
             case 'SingleProperty':
             case 'FloatProperty':
                 overhead = Property_1.FloatProperty.CalcOverhead(property);
@@ -242,7 +218,6 @@ class DataFields {
             default:
                 throw new Error(`Unimplemented type ${property.type}`);
         }
-        // replace len indicator.
         writer.writeBinarySizeFromPosition(lenIndicator, start + overhead);
     }
 }

package/build/parser/satisfactory/objects/Property.d.ts

@@ -1,5 +1,5 @@
 import { ByteReader } from "../../byte/byte-reader.class";
-import { SaveWriter } from "../../save-writer";
+import { SaveWriter } from "../save/save-writer";
 import { col4, vec3, vec4 } from "../structs/util.types";
 import { ObjectReference } from "./ObjectReference";
 export type Properties = {

package/build/parser/satisfactory/objects/Property.js

@@ -12,7 +12,6 @@ class AbstractProperty {
 }
 exports.AbstractProperty = AbstractProperty;
 class AbstractBaseProperty extends AbstractProperty {
-    // overhead like Guid is not calculated into property size
     constructor(type, ueType, index) {
         super(type, index && index !== 0 ? index : undefined);
         this.ueType = ueType;
@@ -32,7 +31,7 @@ const ParseGUID = (reader) => {
     let guid;
     if (hasGuid) {
         throw new Error('Unexpected!');
-        guid = reader.readBytes(16); //UE Guid is 4 x uint32
+        guid = reader.readBytes(16);
     }
     return guid;
 };
@@ -378,7 +377,6 @@ class TextProperty extends BasicProperty {
         this.value = value;
     }
     static Parse(reader, ueType, index = 0) {
-        //let name = reader.readString();
         const guidInfo = (0, exports.ParseGUID)(reader);
         const value = TextProperty.ParseValue(reader);
         return new TextProperty(value, ueType, guidInfo, index);
@@ -389,15 +387,12 @@ class TextProperty extends BasicProperty {
             historyType: reader.readByte()
         };
         switch (prop.historyType) {
-            // HISTORYTYPE_BASE
             case 0:
                 prop.namespace = reader.readString();
                 prop.key = reader.readString();
                 prop.value = reader.readString();
                 break;
-            // HISTORYTYPE_NAMEDFORMAT
             case 1:
-            // HISTORYTYPE_ARGUMENTFORMAT
             case 3:
                 prop.sourceFmt = TextProperty.ParseValue(reader);
                 const argumentsCount = reader.readInt32();
@@ -416,22 +411,15 @@ class TextProperty extends BasicProperty {
                     prop.arguments.push(currentArgumentsData);
                 }
                 break;
-            // see https://github.com/EpicGames/UnrealEngine/blob/4.25/Engine/Source/Runtime/Core/Private/Internationalization/TextHistory.cpp#L2268
-            // HISTORYTYPE_TRANSFORM
             case 10:
                 prop.sourceText = TextProperty.ParseValue(reader);
                 prop.transformType = reader.readByte();
                 break;
-            // HISTORYTYPE_NONE
             case 255:
-                // See: https://github.com/EpicGames/UnrealEngine/blob/4.25/Engine/Source/Runtime/Core/Private/Internationalization/Text.cpp#L894
-                // TODO: do i need that? check with goz3rr
-                //if (this.header!.buildVersion >= 140822) {
                 prop.hasCultureInvariantString = reader.readInt32() === 1;
                 if (prop.hasCultureInvariantString) {
                     prop.value = reader.readString();
                 }
-                //}
                 break;
             default:
                 throw new Error('Unimplemented historyType `' + prop.historyType);
@@ -449,15 +437,12 @@ class TextProperty extends BasicProperty {
         writer.writeInt32(value.flags);
         writer.writeByte(value.historyType);
         switch (value.historyType) {
-            // HISTORYTYPE_BASE
             case 0:
                 writer.writeString(value.namespace);
                 writer.writeString(value.key);
                 writer.writeString(value.value);
                 break;
-            // HISTORYTYPE_NAMEDFORMAT
             case 1:
-            // HISTORYTYPE_ARGUMENTFORMAT
             case 3:
                 TextProperty.SerializeValue(writer, value.sourceFmt);
                 writer.writeInt32(value.arguments.length);
@@ -474,22 +459,15 @@ class TextProperty extends BasicProperty {
                     }
                 }
                 break;
-            // see https://github.com/EpicGames/UnrealEngine/blob/4.25/Engine/Source/Runtime/Core/Private/Internationalization/TextHistory.cpp#L2268
-            // HISTORYTYPE_TRANSFORM
             case 10:
                 TextProperty.SerializeValue(writer, value.sourceText);
                 writer.writeByte(value.transformType);
                 break;
-            // HISTORYTYPE_NONE
             case 255:
-                // See: https://github.com/EpicGames/UnrealEngine/blob/4.25/Engine/Source/Runtime/Core/Private/Internationalization/Text.cpp#L894
-                // TODO: do i need that? check with goz3rr
-                //if (this.header!.buildVersion >= 140822) {
                 writer.writeInt32(value.hasCultureInvariantString ? 1 : 0);
                 if (value.hasCultureInvariantString) {
                     writer.writeString(value.value);
                 }
-                //}
                 break;
             default:
                 throw new Error('Unimplemented historyType `' + value.historyType);
@@ -578,7 +556,6 @@ class StructProperty extends AbstractBaseProperty {
                     unk3: reader.readString(),
                     properties: [],
                 };
-                //TODO - what is this? currentProperty.value.properties.push(reader.readProperty());
                 break;
             case 'FluidBox':
                 value = {
@@ -591,7 +568,6 @@ class StructProperty extends AbstractBaseProperty {
             case 'DateTime':
                 value = reader.readLong().toString();
                 break;
-            // MODS
             case 'FINNetworkTrace':
                 value = (0, exports.ReadFINNetworkTrace)(reader);
                 break;
@@ -600,14 +576,13 @@ class StructProperty extends AbstractBaseProperty {
                     values: (0, exports.ReadFINLuaProcessorStateStorage)(reader, size)
                 };
                 break;
-            case 'FICFrameRange': // https://github.com/Panakotta00/FicsIt-Cam/blob/c55e254a84722c56e1badabcfaef1159cd7d2ef1/Source/FicsItCam/Public/Data/FICTypes.h#L34
+            case 'FICFrameRange':
                 value = {
                     begin: reader.readLong().toString(),
                     end: reader.readLong().toString(),
                 };
                 break;
             default:
-                //TODO: use buildversion
                 value = (0, exports.ParseDynamicStructData)(reader, 0, subtype);
         }
         return value;
@@ -673,7 +648,6 @@ class StructProperty extends AbstractBaseProperty {
                 writer.writeString(value.itemName);
                 writer.writeString(value.unk2);
                 writer.writeString(value.unk3);
-                //TODO - how to write properties?
                 break;
             case 'FluidBox':
                 value = value;
@@ -687,7 +661,6 @@ class StructProperty extends AbstractBaseProperty {
                 value = value;
                 writer.writeInt64(BigInt(value));
                 break;
-            // MODS
             case 'FINNetworkTrace':
                 value = value;
                 (0, exports.SerializeFINNetworkTrace)(writer, value);
@@ -696,13 +669,12 @@ class StructProperty extends AbstractBaseProperty {
                 value = value;
                 (0, exports.SerializeFINLuaProcessorStateStorage)(writer, value.values);
                 break;
-            case 'FICFrameRange': // https://github.com/Panakotta00/FicsIt-Cam/blob/c55e254a84722c56e1badabcfaef1159cd7d2ef1/Source/FicsItCam/Public/Data/FICTypes.h#L34
+            case 'FICFrameRange':
                 value = value;
                 writer.writeInt64(BigInt(value.begin));
                 writer.writeInt64(BigInt(value.end));
                 break;
             default:
-                //TODO: use buildversion
                 value = value;
                 (0, exports.SerializeDynamicStructData)(writer, 0, value);
         }
@@ -718,7 +690,7 @@ class ArrayProperty extends BasicProperty {
     }
     static Parse(reader, ueType, index, propertyName) {
         const subtype = reader.readString();
-        reader.skipBytes(); // unk
+        reader.skipBytes();
         let property;
         const elementCount = reader.readInt32();
         switch (subtype) {
@@ -754,10 +726,10 @@ class ArrayProperty extends BasicProperty {
                 property = new ArrayProperty(subtype, new Array(elementCount).fill(0).map(e => ObjectProperty.ReadValue(reader)), ueType, index);
                 break;
             case "StructProperty":
-                const name = reader.readString(); // Same as currentProperty.name
-                const type = reader.readString(); // StructProperty
-                const binarySize = reader.readInt32(); // structureSize
-                const allIndex = reader.readInt32(); // 0
+                const name = reader.readString();
+                const type = reader.readString();
+                const binarySize = reader.readInt32();
+                const allIndex = reader.readInt32();
                 const allStructType = reader.readString();
                 const allGuid = reader.readInt32();
                 const allUnk1 = reader.readInt32();
@@ -780,11 +752,6 @@ class ArrayProperty extends BasicProperty {
                 const before = reader.getBufferPosition();
                 const maArr = new Array(elementCount).fill(0).map(e => {
                     const struct = new StructProperty(allStructType, type, allIndex, allGuid);
-                    // we do NOT assign individual unk's here. Since they are only serialized always on ArrayProperty's Level once for all elements.
-                    //struct.unk1 = allUnk1;
-                    //struct.unk2 = allUnk2;
-                    //struct.unk3 = allUnk3;
-                    //struct.unk4 = allUnk4;
                     struct.value = StructProperty.ParseValue(reader, allStructType, binarySize);
                     return struct;
                 });
@@ -792,7 +759,6 @@ class ArrayProperty extends BasicProperty {
                 if (readBytees !== binarySize) {
                     throw new Error('possibly corrupt in array of struct.');
                 }
-                // Array Properties with struct values have some more properties.
                 property = new ArrayProperty(subtype, maArr, ueType, index, innerStructValueFields);
                 break;
             default:
@@ -871,8 +837,8 @@ class SetProperty extends BasicProperty {
     }
     static Parse(reader, ueType, index, propertyName) {
         const subtype = reader.readString();
-        reader.skipBytes(1); // unk
-        reader.skipBytes(4); // unk2
+        reader.skipBytes(1);
+        reader.skipBytes(4);
         const elementCount = reader.readInt32();
         let property;
         switch (subtype) {
@@ -900,7 +866,6 @@ class SetProperty extends BasicProperty {
     }
     static Serialize(writer, property) {
         writer.writeString(property.subtype);
-        //TODO: what is that
         writer.writeByte(0);
         writer.writeInt32(0);
         writer.writeInt32(property.values.length);
@@ -915,7 +880,6 @@ class SetProperty extends BasicProperty {
                 property.values.forEach(v => StrProperty.SerializeValue(writer, v));
                 break;
             case "StructProperty":
-                //TODO: this would only work for mRemovalLocations. Get a way to check for propertyname at least.
                 property.values.forEach(v => (0, util_types_1.SerializeVec3)(writer, v));
                 break;
             default:
@@ -940,119 +904,7 @@ class MapProperty extends BasicProperty {
         const property = new MapProperty(reader.readString(), reader.readString(), ueType, index);
         reader.skipBytes(1);
         property.modeType = reader.readInt32();
-        //property.remainingData = reader.readBytes(size - (reader.getBufferPosition() - start));
         property.remainingData = Array.from(reader.readBytes(size - 4));
-        // TODO
-        /*
-
-        if (property.modeType === 2) {
-            property.modeUnk2 = reader.readString();
-            property.modeUnk3 = reader.readString();
-        } else if (property.modeType === 3) {
-            property.modeUnk1 = reader.readHex(9);
-            property.modeUnk2 = reader.readString();
-            property.modeUnk3 = reader.readString();
-        }
-
-        let elementCount = reader.readInt32();
-        for (let i = 0; i < elementCount; i++) {
-            let key: number | string | ObjectReferenceV2 | vec3 | any[] | boolean;
-            let value: number | string | ObjectReferenceV2 | any[] | boolean;
-
-            switch (property.keyType) {
-                case 'IntProperty':
-                    key = Int32Property.ReadValue(reader);
-                    break;
-                case 'Int64Property':
-                    key = Int64Property.ReadValue(reader);
-                    break;
-                case 'NameProperty':
-                case 'StrProperty':
-                    key = StrProperty.ReadValue(reader);
-                    break;
-                case 'ObjectProperty':
-                    key = ObjectProperty.ReadValue(reader);
-                    break;
-                case 'EnumProperty':
-                    key = EnumProperty.ReadValue(reader);
-                    break;
-                case 'StructProperty':
-                    if (propertyName === 'Destroyed_Foliage_Transform' || parentType === '/BuildGunUtilities/BGU_Subsystem.BGU_Subsystem_C') // Mod: Universal Destroyer/Factory Statistics
-                    {
-                        key = ParseVec3(reader);
-                        break;
-                    }
-
-                    key = [];
-                    while (true) {
-                        let singleValueProperty = DataFieldsV2.ParseProperty(reader, buildVersion, propertyName);
-                        if (singleValueProperty === null) {
-                            break;
-                        }
-
-                        key.push(singleValueProperty);
-                    }
-                    break;
-                default:
-                    throw new Error(`not implemented type ${property.keyType}`);
-            }
-
-
-            switch (property.valueType) {
-                case 'ByteProperty':
-                    if (property.keyType === 'StrProperty') {
-                        value = reader.readString();
-                    }
-                    else {
-                        value = reader.readByte();
-                    }
-                    break;
-                case 'BoolProperty':
-                    value = BoolProperty.ReadValue(reader);
-                    break;
-                case 'IntProperty':
-                    value = Int32Property.ReadValue(reader);
-                    break;
-                case 'FloatProperty':
-                    value = FloatProperty.ReadValue(reader);
-                    break;
-                case 'StrProperty':
-                    value = StrProperty.ReadValue(reader);
-                    break;
-                case 'ObjectProperty':
-                    value = ObjectProperty.ReadValue(reader);
-                    break;
-                case 'StructProperty':
-                    // TODO: what is this
-                    /*
-                    if (parentType === 'LBBalancerData') {
-                        mapPropertySubProperties.mNormalIndex = this.readInt32();
-                        mapPropertySubProperties.mOverflowIndex = this.readInt32();
-                        mapPropertySubProperties.mFilterIndex = this.readInt32();
-                    }
-                    else { }
-                    */
-        /*
-
-        value = [];
-        while (true) {
-            let singleValueProperty = DataFieldsV2.ParseProperty(reader, buildVersion, propertyName);
-            if (singleValueProperty === null) {
-                break;
-            }
-
-            value.push(singleValueProperty);
-        }
-        break;
-    default:
-        throw new Error(`not implemented type ${property.valueType}`);
-}
-
-property.values.push({
-    key, value
-});
-}
-*/
         return property;
     }
     static CalcOverhead(property) {
@@ -1064,7 +916,6 @@ property.values.push({
         writer.writeByte(0);
         writer.writeInt32(property.modeType);
         writer.writeBytesArray(property.remainingData);
-        //TODO: do the actual serialization.
     }
 }
 exports.MapProperty = MapProperty;

package/build/parser/satisfactory/save/level.class.d.ts

@@ -0,0 +1,21 @@
+import { ByteReader } from "../../byte/byte-reader.class";
+import { ByteWriter } from "../../byte/byte-writer.class";
+import { ObjectReference } from "../objects/ObjectReference";
+import { SaveComponent } from "../objects/SaveComponent";
+import { SaveEntity } from "../objects/SaveEntity";
+import { SaveObject } from "../objects/SaveObject";
+import { SaveReader } from "./save-reader";
+export declare class Level {
+    name: string;
+    objects: (SaveEntity | SaveComponent)[];
+    collectables: ObjectReference[];
+    constructor(name: string);
+    static SerializeObjectHeaders(writer: ByteWriter, objects: (SaveEntity | SaveComponent)[]): void;
+    static WriteLevel(writer: ByteWriter, level: Level, buildVersion: number): void;
+    static SerializeObjectContents(writer: ByteWriter, objects: (SaveEntity | SaveComponent)[], buildVersion: number): void;
+    static ReadObjectHeaders(reader: ByteReader, objectsList: SaveObject[], onProgressCallback: (progress: number, msg?: string) => void): void;
+    static ReadObjectContents(reader: ByteReader, objectsList: SaveObject[], buildVersion: number, onProgressCallback: (progress: number, msg?: string) => void): void;
+    static ReadLevel(reader: SaveReader, levelName: string, buildVersion: number): Level;
+    static SerializeCollectablesList(writer: ByteWriter, collectables: ObjectReference[]): void;
+    static ReadCollectablesList(reader: SaveReader): ObjectReference[];
+}