@etothepii/satisfactory-file-parser 0.4.15 → 0.4.17

package/README.md

@@ -18,7 +18,7 @@ Game Version Files of U5 and below are NOT supported.
 | <= U5          |  ❌                          |
 | U6 + U7        |  ✅ 0.0.1 - 0.0.34           |
 | U8             |  ✅ 0.1.20 - 0.3.7           |
-| U1.0           |  ✅ >= 0.4.14                |
+| U1.0           |  ✅ >= 0.4.16                |
 
 # Installation via npm
 `npm install @etothepii/satisfactory-file-parser`
@@ -86,14 +86,19 @@ fs.writeFileSync('./MyModifiedSave.sav', Buffer.concat([fileHeader!, ...bodyChun
 ```
 
 
-## Old Save Parsing. Deprecated.
-For reading a save file (`.sav`) and parse In-Memory, just pass a Buffer to the parser with the file content.
-```js
-import * as fs from 'fs';
-import { Parser } from "@etothepii/satisfactory-file-parser";
+## Inspecting Save Objects
+Once you have the complete parsing done, the JSON is a `SatisfactorySave` object.
+You can for example loop through players and print their cached names and positions.
 
-const file = fs.readFileSync('./MySave.sav') as Buffer;
-const parsedSave = Parser.ParseSaveFile('MySave', file);
+```js
+import { isSaveEntity, SatisfactorySave, SaveEntity, StrProperty } from '@etothepii/satisfactory-file-parser';
+
+const objects = save.levels.flatMap(level => level.objects);
+const players = objects.filter(obj => isSaveEntity(obj) && obj.typePath === '/Game/FactoryGame/Character/Player/Char_Player.Char_Player_C') as SaveEntity[];
+for (const player of players) {
+    const name = (player.properties.mCachedPlayerName as StrProperty).value;
+    console.log(name, player.transform.translation);
+}
 ```
 
 
@@ -138,6 +143,16 @@ So far this was just a private hobby project. But i figure some people actually
 If you find a bug or have feedback about the parser, you can just hit me up on the satisfactory discord `etothepii`.
 
 # Changelog
+### [0.4.17] (2024-10-05)
+#### updated README
+#### bugfix
+* `ClientIdentityInfo` field names and structure got changed, since the meaning is now more clear.
+* removed trailing object list from satisfactory save object.
+* deleted entities references get serialized again, just based on collectables list.
+
+### [0.4.16] (2024-10-03)
+#### bugfix
+* exporting `isSaveEntity` and `isSaveComponent` again.
 
 ### [0.4.15] (2024-10-02)
 #### updated README
@@ -146,8 +161,7 @@ If you find a bug or have feedback about the parser, you can just hit me up on t
 ### [0.4.14] (2024-10-02)
 #### updated README
 * updated the code examples with more context
-
-### Internal renamings (won't affect you if you stick to the code examples)
+#### Internal renamings (won't affect you if you stick to the code examples)
 * improved the interface for abstract parser classes
 * extended some error log messages
 * added an additional check when parsing struct property InventoryItem, since ported saves often have a few more bytes.

package/build/index.d.ts

@@ -21,8 +21,8 @@ export * from './parser/satisfactory/objects/property/generic/Uint32Property';
 export * from './parser/satisfactory/objects/property/generic/Uint64Property';
 export * from './parser/satisfactory/objects/property/generic/Uint8Property';
 export * from './parser/satisfactory/objects/property/special/SpecialAnyProperty';
-export { SaveComponent } from './parser/satisfactory/objects/SaveComponent';
-export { SaveEntity } from './parser/satisfactory/objects/SaveEntity';
+export * from './parser/satisfactory/objects/SaveComponent';
+export * from './parser/satisfactory/objects/SaveEntity';
 export * from './parser/satisfactory/objects/ue/MD5Hash';
 export * from './parser/satisfactory/objects/values/GUID';
 export * from './parser/satisfactory/objects/values/ObjectReference';

package/build/index.js

@@ -14,7 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ReadableStreamParser = exports.Parser = exports.SaveStreamWriter = exports.SaveStreamJsonStringifier = exports.SaveWriter = exports.SaveReader = exports.BlueprintWriter = exports.BlueprintConfigWriter = exports.BlueprintReader = exports.BlueprintConfigReader = exports.ByteWriter = exports.ByteReader = exports.SatisfactorySave = exports.Level = exports.SaveEntity = exports.SaveComponent = exports.DataFields = void 0;
+exports.ReadableStreamParser = exports.Parser = exports.SaveStreamWriter = exports.SaveStreamJsonStringifier = exports.SaveWriter = exports.SaveReader = exports.BlueprintWriter = exports.BlueprintConfigWriter = exports.BlueprintReader = exports.BlueprintConfigReader = exports.ByteWriter = exports.ByteReader = exports.SatisfactorySave = exports.Level = exports.DataFields = void 0;
 __exportStar(require("./parser/satisfactory/blueprint/blueprint.types"), exports);
 var DataFields_1 = require("./parser/satisfactory/objects/DataFields");
 Object.defineProperty(exports, "DataFields", { enumerable: true, get: function () { return DataFields_1.DataFields; } });
@@ -39,10 +39,8 @@ __exportStar(require("./parser/satisfactory/objects/property/generic/Uint32Prope
 __exportStar(require("./parser/satisfactory/objects/property/generic/Uint64Property"), exports);
 __exportStar(require("./parser/satisfactory/objects/property/generic/Uint8Property"), exports);
 __exportStar(require("./parser/satisfactory/objects/property/special/SpecialAnyProperty"), exports);
-var SaveComponent_1 = require("./parser/satisfactory/objects/SaveComponent");
-Object.defineProperty(exports, "SaveComponent", { enumerable: true, get: function () { return SaveComponent_1.SaveComponent; } });
-var SaveEntity_1 = require("./parser/satisfactory/objects/SaveEntity");
-Object.defineProperty(exports, "SaveEntity", { enumerable: true, get: function () { return SaveEntity_1.SaveEntity; } });
+__exportStar(require("./parser/satisfactory/objects/SaveComponent"), exports);
+__exportStar(require("./parser/satisfactory/objects/SaveEntity"), exports);
 __exportStar(require("./parser/satisfactory/objects/ue/MD5Hash"), exports);
 __exportStar(require("./parser/satisfactory/objects/values/GUID"), exports);
 __exportStar(require("./parser/satisfactory/objects/values/ObjectReference"), exports);

package/build/parser/parser.d.ts

@@ -3,7 +3,6 @@ import { Blueprint } from "./satisfactory/blueprint/blueprint.types";
 import { SatisfactorySave } from "./satisfactory/save/satisfactory-save";
 export declare class Parser {
     static WriteSave(save: SatisfactorySave, onBinaryBeforeCompressing: (buffer: ArrayBuffer) => void, onHeader: (header: Uint8Array) => void, onChunk: (chunk: Uint8Array) => void): ChunkSummary[];
-    static ParseSaveFile(name: string, file: Buffer, onDecompressedSaveBody?: (buffer: ArrayBuffer) => void, onProgress?: (progress: number, message?: string) => void): SatisfactorySave;
     static WriteBlueprintFiles(blueprint: Blueprint, onMainFileBinaryBeforeCompressing?: (binary: ArrayBuffer) => void, onMainFileHeader?: (header: Uint8Array) => void, onMainFileChunk?: (chunk: Uint8Array) => void): {
         mainFileChunkSummary: ChunkSummary[];
         configFileBinary: ArrayBuffer;

package/build/parser/parser.js

@@ -3,8 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Parser = void 0;
 const blueprint_reader_1 = require("./satisfactory/blueprint/blueprint-reader");
 const blueprint_writer_1 = require("./satisfactory/blueprint/blueprint-writer");
-const satisfactory_save_1 = require("./satisfactory/save/satisfactory-save");
-const save_reader_1 = require("./satisfactory/save/save-reader");
 const save_writer_1 = require("./satisfactory/save/save-writer");
 class Parser {
     static WriteSave(save, onBinaryBeforeCompressing, onHeader, onChunk) {
@@ -18,21 +16,6 @@ class Parser {
         const chunkSummary = writer.generateChunks(save.compressionInfo, posAfterHeader, onBinaryBeforeCompressing, onHeader, onChunk);
         return chunkSummary;
     }
-    static ParseSaveFile(name, file, onDecompressedSaveBody = () => { }, onProgress = () => { }) {
-        const reader = new save_reader_1.SaveReader(new Uint8Array(file).buffer, onProgress);
-        const header = reader.readHeader();
-        const save = new satisfactory_save_1.SatisfactorySave(name, header);
-        const inflateResult = reader.inflateChunks();
-        onDecompressedSaveBody(reader.getBuffer());
-        const gridHash = reader.readSaveBodyHash();
-        save.gridHash = gridHash;
-        const grids = reader.readGrids();
-        save.grids = grids;
-        save.levels = reader.readLevels();
-        save.compressionInfo = reader.compressionInfo;
-        save.trailingCollectedObjects = reader.trailingCollectedObjects;
-        return save;
-    }
     static WriteBlueprintFiles(blueprint, onMainFileBinaryBeforeCompressing = () => { }, onMainFileHeader = () => { }, onMainFileChunk = () => { }) {
         const blueprintWriter = new blueprint_writer_1.BlueprintWriter();
         blueprint_writer_1.BlueprintWriter.SerializeHeader(blueprintWriter, blueprint.header);

package/build/parser/satisfactory/objects/property/generic/StructProperty.d.ts

@@ -39,11 +39,8 @@ export type DynamicStructPropertyValue = {
     properties: PropertiesMap;
 };
 export type ClientIdentityInfo = {
-    id: string;
-    clientUnk1: number;
-    clientUnk2: number;
-    clientHashSize: number;
-    someClientHash: number[];
+    offlineId: string;
+    accountIds: Record<number, number[]>;
 };
 export type GENERIC_STRUCT_PROPERTY_VALUE = BasicMultipleStructPropertyValue | BasicStructPropertyValue | BoxStructPropertyValue | RailroadTrackPositionStructPropertyValue | InventoryItemStructPropertyValue | FICFrameRangeStructPropertyValue | ClientIdentityInfo | DynamicStructPropertyValue | col4 | vec3 | vec4 | string;
 export declare class StructProperty extends AbstractBaseProperty {

package/build/parser/satisfactory/objects/property/generic/StructProperty.js

@@ -35,7 +35,7 @@ class StructProperty extends BasicProperty_1.AbstractBaseProperty {
         struct.value = StructProperty.ParseValue(reader, struct.subtype, size);
         const readBytes = reader.getBufferPosition() - before;
         if (readBytes !== size) {
-            if (size - readBytes === 4 || struct.subtype === 'ClientIdentityInfo') {
+            if (size - readBytes === 4) {
                 reader.skipBytes(size - readBytes);
             }
             else {
@@ -64,7 +64,7 @@ class StructProperty extends BasicProperty_1.AbstractBaseProperty {
                 value = (size === 16) ? util_types_1.vec4.ParseF(reader) : util_types_1.vec4.Parse(reader);
                 break;
             case 'Box':
-                value = (size === 25) ? {
+                value = ((size === 25) ? {
                     min: util_types_1.vec3.ParseF(reader),
                     max: util_types_1.vec3.ParseF(reader),
                     isValid: reader.readByte() >= 1
@@ -72,7 +72,7 @@ class StructProperty extends BasicProperty_1.AbstractBaseProperty {
                     min: util_types_1.vec3.Parse(reader),
                     max: util_types_1.vec3.Parse(reader),
                     isValid: reader.readByte() >= 1
-                };
+                });
                 break;
             case 'RailroadTrackPosition':
                 value = {
@@ -89,12 +89,19 @@ class StructProperty extends BasicProperty_1.AbstractBaseProperty {
                 value = reader.readString();
                 break;
             case 'ClientIdentityInfo':
-                const id = reader.readString();
-                const clientUnk1 = reader.readInt32();
-                const clientUnk2 = reader.readByte();
-                const clientHashSize = reader.readInt32();
-                const someClientHash = Array.from(reader.readBytes(clientHashSize));
-                value = { id, clientUnk1, clientUnk2, clientHashSize, someClientHash };
+                const offlineId = reader.readString();
+                const numAccountIds = reader.readInt32();
+                const accountIds = {};
+                for (let i = 0; i < numAccountIds; i++) {
+                    const platformFlagMaybe = reader.readByte();
+                    const idSize = reader.readInt32();
+                    const accountId = Array.from(reader.readBytes(idSize));
+                    accountIds[platformFlagMaybe] = accountId;
+                }
+                value = {
+                    offlineId,
+                    accountIds
+                };
                 break;
             case 'InventoryItem':
                 const before = reader.getBufferPosition();
@@ -209,11 +216,13 @@ class StructProperty extends BasicProperty_1.AbstractBaseProperty {
                 break;
             case 'ClientIdentityInfo':
                 value = value;
-                writer.writeString(value.id);
-                writer.writeInt32(value.clientUnk1);
-                writer.writeByte(value.clientUnk2);
-                writer.writeInt32(value.clientHashSize);
-                writer.writeBytesArray(value.someClientHash);
+                writer.writeString(value.offlineId);
+                writer.writeInt32(Object.values(value.accountIds).length);
+                for (const [platformFlagMaybe, accountId] of Object.entries(value.accountIds)) {
+                    writer.writeByte(Number(platformFlagMaybe));
+                    writer.writeInt32(accountId.length);
+                    writer.writeBytesArray(accountId);
+                }
                 break;
             case 'InventoryItem':
                 value = value;

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

@@ -4,7 +4,6 @@ import { SaveComponent } from "../objects/SaveComponent";
 import { SaveEntity } from "../objects/SaveEntity";
 import { SaveObject } from "../objects/SaveObject";
 import { ObjectReference } from "../objects/values/ObjectReference";
-import { SaveReader } from "./save-reader";
 export declare class Level {
     name: string;
     objects: (SaveEntity | SaveComponent)[];
@@ -14,8 +13,6 @@ export declare class Level {
     static WriteLevel(writer: ByteWriter, level: Level, buildVersion: number): void;
     static SerializeObjectContents(writer: ByteWriter, objects: (SaveEntity | SaveComponent)[], buildVersion: number, levelName: string): void;
     static ReadObjectHeaders(reader: BinaryReadable, objectsList: SaveObject[], onProgressCallback: (progress: number, msg?: string) => void): void;
-    static ReadObjectContents(levelName: string, reader: BinaryReadable, objectsList: SaveObject[], buildVersion: number, onProgressCallback: (progress: number, msg?: string) => void): Promise<void>;
-    static ReadLevel(reader: SaveReader, levelName: string, buildVersion: number): Level;
     static SerializeCollectablesList(writer: ByteWriter, collectables: ObjectReference[]): void;
     static ReadCollectablesList(reader: BinaryReadable): ObjectReference[];
 }

package/build/parser/satisfactory/save/level.class.js

@@ -33,6 +33,7 @@ class Level {
         writer.writeInt32(0);
         writer.writeInt32(0);
         Level.SerializeObjectHeaders(writer, level.objects);
+        Level.SerializeCollectablesList(writer, level.collectables);
         writer.writeBinarySizeFromPosition(lenIndicatorHeaderAndDestroyedEntitiesSize, lenIndicatorHeaderAndDestroyedEntitiesSize + 8);
         Level.SerializeObjectContents(writer, level.objects, buildVersion, level.name);
         Level.SerializeCollectablesList(writer, level.collectables);
@@ -81,61 +82,6 @@ class Level {
             }
         }
     }
-    static async ReadObjectContents(levelName, reader, objectsList, buildVersion, onProgressCallback) {
-        const countEntities = reader.readInt32();
-        if (countEntities !== objectsList.length) {
-            throw new Error(`possibly corrupt. entity content count ${countEntities} does not equal object count of ${objectsList.length}`);
-        }
-        for (let i = 0; i < countEntities; i++) {
-            if (countEntities >= 10000 && i % 10000 === 0) {
-                onProgressCallback(reader.getBufferProgress(), `read object count [${(i + 1)}/${(countEntities + 1)}] in level ${levelName}`);
-            }
-            const obj = objectsList[i];
-            obj.objectVersion = reader.readInt32();
-            obj.unknownType2 = reader.readInt32();
-            const binarySize = reader.readInt32();
-            const before = reader.getBufferPosition();
-            if ((0, SaveEntity_1.isSaveEntity)(obj)) {
-                SaveEntity_1.SaveEntity.ParseData(obj, binarySize, reader, buildVersion, obj.typePath);
-            }
-            else if ((0, SaveComponent_1.isSaveComponent)(obj)) {
-                SaveComponent_1.SaveComponent.ParseData(obj, binarySize, reader, buildVersion, obj.typePath);
-            }
-            const after = reader.getBufferPosition();
-            if (after - before !== binarySize) {
-                console.warn('entity may be corrupt', obj.instanceName);
-            }
-        }
-    }
-    static ReadLevel(reader, levelName, buildVersion) {
-        const level = new Level(levelName);
-        const headersBinLen = reader.readInt32();
-        const unk = reader.readInt32();
-        const posBeforeHeaders = reader.getBufferPosition();
-        Level.ReadObjectHeaders(reader, level.objects, reader.onProgressCallback);
-        let remainingSize = headersBinLen - (reader.getBufferPosition() - posBeforeHeaders);
-        if (remainingSize > 0) {
-            const doubledCollectablesIgnored = Level.ReadCollectablesList(reader);
-        }
-        else {
-        }
-        remainingSize = headersBinLen - (reader.getBufferPosition() - posBeforeHeaders);
-        if (remainingSize !== 0) {
-            console.warn('remaining size not 0. Save may be corrupt.', remainingSize, levelName);
-        }
-        const objectContentsBinLen = reader.readInt32();
-        const unk2 = reader.readInt32();
-        reader.onProgressCallback(reader.getBufferProgress());
-        const posBeforeContents = reader.getBufferPosition();
-        Level.ReadObjectContents(levelName, reader, level.objects, buildVersion, reader.onProgressCallback);
-        const posAfterContents = reader.getBufferPosition();
-        if (posAfterContents - posBeforeContents !== objectContentsBinLen) {
-            console.warn('save seems corrupt.', this.name);
-        }
-        reader.onProgressCallback(reader.getBufferProgress());
-        level.collectables = Level.ReadCollectablesList(reader);
-        return level;
-    }
     static SerializeCollectablesList(writer, collectables) {
         writer.writeInt32(collectables.length);
         for (const collectable of collectables) {

package/build/parser/satisfactory/save/satisfactory-save.d.ts

@@ -1,5 +1,4 @@
 import { ChunkCompressionInfo } from "../../file.types";
-import { ObjectReference } from "../objects/values/ObjectReference";
 import { Level } from "./level.class";
 import { ByteArray4, Grids } from "./save-reader";
 import { SatisfactorySaveHeader } from "./save.types";
@@ -9,7 +8,6 @@ export declare class SatisfactorySave {
     gridHash: ByteArray4;
     grids: Grids;
     levels: Level[];
-    trailingCollectedObjects: ObjectReference[];
     compressionInfo?: ChunkCompressionInfo;
     constructor(name: string, header: SatisfactorySaveHeader);
 }

package/build/parser/satisfactory/save/satisfactory-save.js

@@ -6,7 +6,6 @@ class SatisfactorySave {
         this.gridHash = [0, 0, 0, 0];
         this.grids = {};
         this.levels = [];
-        this.trailingCollectedObjects = [];
         this.name = name;
         this.header = header;
     }

package/build/parser/satisfactory/save/save-reader.d.ts

@@ -32,5 +32,4 @@ export declare class SaveReader extends ByteReader {
     };
     readSaveBodyHash: () => ByteArray4;
     readGrids: () => Grids;
-    readLevels(): Level[];
 }

package/build/parser/satisfactory/save/save-reader.js

@@ -9,7 +9,6 @@ const alignment_enum_1 = require("../../byte/alignment.enum");
 const byte_reader_class_1 = require("../../byte/byte-reader.class");
 const parser_error_1 = require("../../error/parser.error");
 const MD5Hash_1 = require("../objects/ue/MD5Hash");
-const level_class_1 = require("./level.class");
 exports.DEFAULT_SATISFACTORY_CHUNK_HEADER_SIZE = 49;
 class SaveReader extends byte_reader_class_1.ByteReader {
     constructor(fileBuffer, onProgressCallback = () => { }) {
@@ -23,10 +22,10 @@ class SaveReader extends byte_reader_class_1.ByteReader {
             chunkHeaderSize: exports.DEFAULT_SATISFACTORY_CHUNK_HEADER_SIZE
         };
         this.readSaveBodyHash = () => {
-            const unk = this.readInt32();
+            this.readInt32();
             const cannotBeLevelCountWhatIsIt = this.readInt32();
             const noneString = this.readString();
-            const unk2 = this.readInt32();
+            this.readInt32();
             const gridValidationHash = Array.from(this.readBytes(4));
             const unk3 = this.readInt32();
             const noneString2 = this.readString();
@@ -163,35 +162,6 @@ class SaveReader extends byte_reader_class_1.ByteReader {
             numChunks: currentChunks.length
         };
     }
-    readLevels() {
-        if (!this.header) {
-            throw new parser_error_1.ParserError('ParserError', 'Header must be set before objects can be read.');
-        }
-        const roughSaveVersion = SaveReader.getRoughSaveVersion(this.header.saveVersion, this.header.saveHeaderType);
-        if (roughSaveVersion === '<U6') {
-            throw new parser_error_1.UnsupportedVersionError('Game Version < U6 is not supported.');
-        }
-        else if (roughSaveVersion === 'U6/U7') {
-            throw new parser_error_1.UnsupportedVersionError('Game Version U6/U7 is not supported in this package version. Consider downgrading to the latest package version supporting it, which is 0.0.34');
-        }
-        else if (roughSaveVersion === 'U8') {
-            throw new parser_error_1.UnsupportedVersionError('Game Version U8 is not supported in this package version. Consider downgrading to the latest package version supporting it, which is 0.3.7');
-        }
-        const levels = [];
-        const levelCount = this.readInt32();
-        this.onProgressCallback(this.getBufferProgress(), `reading pack of ${levelCount} levels.`);
-        for (let i = 0; i < levelCount; i++) {
-            let levelSingleName = this.readString();
-            if (i % 500 === 0) {
-                this.onProgressCallback(this.getBufferProgress(), `reading level [${(i + 1)}/${(levelCount + 1)}] ${levelSingleName}`);
-            }
-            levels.push(level_class_1.Level.ReadLevel(this, levelSingleName, this.header.buildVersion));
-        }
-        levels.push(level_class_1.Level.ReadLevel(this, this.header.mapName, this.header.buildVersion));
-        const trailingStuffToIgnore = level_class_1.Level.ReadCollectablesList(this);
-        this.onProgressCallback(this.getBufferProgress(), 'finished parsing.');
-        return levels;
-    }
 }
 exports.SaveReader = SaveReader;
 SaveReader.EPOCH_TICKS = 621355968000000000n;

package/build/parser/stream/reworked/readable-stream-parser.js

@@ -72,6 +72,12 @@ class ReadableStreamParser {
                 const objectCountToRead = Math.min(countObjectHeaders - totalReadObjectsInLevel, batchingSizeOfObjects);
                 const objects = _a.ReadNObjectHeaders(reader, objectCountToRead);
                 afterHeadersOfBatch = reader.getBufferPosition();
+                if (countObjectHeaders === totalReadObjectsInLevel + objects.length) {
+                    const bytesLeft = afterAllHeaders - reader.getBufferPosition();
+                    if (bytesLeft > 0) {
+                        _a.ReadDestroyedEntityReferences(reader);
+                    }
+                }
                 if (totalReadObjectsInLevel === 0) {
                     reader.skipBytes(afterAllHeaders - reader.getBufferPosition());
                     const objectContentsBinLen = reader.readInt32();

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@etothepii/satisfactory-file-parser",
 	"author": "etothepii",
-	"version": "0.4.15",
+	"version": "0.4.17",
 	"description": "A file parser for satisfactory files. Includes save files and blueprint files.",
 	"types": "./build/index.d.ts",
 	"main": "./build/index.js",