@etothepii/satisfactory-file-parser 0.4.10 → 0.4.12

package/README.md

@@ -18,24 +18,39 @@ 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.10                |
+| U1.0           |  ✅ >= 0.4.12                |
 
 
 ## Installation via npm
 `npm install @etothepii/satisfactory-file-parser`
 
 ## Usage of Save Parsing
-Usage of the SaveParser is easy. For reading a save file (`.sav`), just pass a Buffer to the parser with the file content.
+
+I recommend parsing via stream, to save RAM. The binary data of the whole save will still be in memory, but the converted JSON won't.
+The returned `stream` is a readable WHATWG stream of type string.
+WHATWG is used by default by browsers. Node js can use them using `Writable.toWeb()` and `Writable.fromWeb()` for example.
+
 ```js
-import * as fs from 'fs';
-import { Parser } from "@etothepii/satisfactory-file-parser";
+const jsonFileStream = fs.createWriteStream(outJsonPath, { highWaterMark: 1024 * 1024 * 200 });  // your outgoing JSON stream. In this case directly to file.
+const whatwgWriteStream = Writable.toWeb(outJsonStream) as WritableStream<string>;               // convert the file stream to WHATWG-compliant stream
+
+const { stream, startStreaming } = ReadableStreamParser.CreateReadableStreamFromSaveToJson(savename, file, decompressedBody => {
+    console.log('on binary body data.');
+}, (progress: number, msg: string | undefined) => {
+    // a callback for reporting progress as number [0,1]. Sometimes has a message.
+    console.log(`${new Date().toString()}: progress`, progress, msg);
+});
 
-const file = fs.readFileSync('./MySave.sav') as Buffer;
-const parsedSave = Parser.ParseSaveFile(file);
+stream.pipeTo(whatwgWriteStream);
+whatwgWriteStream.on('close', () => {
+    // write stream finished
+});
+
+startStreaming();
 ```
 
 Consequently, writing a parsed save file back is just as easy.
-The SaveParser has callbacks to assist in syncing on different occasions during the process.
+The SaveParser has callbacks to assist during syncing on different occasions during the process.
 For example, when writing the header or when writing a chunk of the save body.
 The splitting in individual chunks enables you to more easily stream the binary data to somewhere else.
 ```js
@@ -57,6 +72,18 @@ Parser.WriteSave(save, binaryBeforeCompressed => {
 fs.writeFileSync('./MyModifiedSave.sav', Buffer.concat([header!, ...bodyChunks]));
 ```
 
+
+### Old Usage of 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";
+
+const file = fs.readFileSync('./MySave.sav') as Buffer;
+const parsedSave = Parser.ParseSaveFile(file);
+```
+
+
 ## Usage of Blueprint Parsing
 Blueprint parsing works very similiar. Note, that blueprints consist of 2 files. The `.sbp` main file and the config file `.sbpcfg`.
 

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

@@ -172,7 +172,7 @@ class DataFields {
                             reader.readInt32();
                             reader.readBytes(1);
                             const recipeTypePath = reader.readString();
-                            reader.readInt64();
+                            const blueprintProxy = ObjectReference_1.ObjectReference.read(reader);
                             instances.push({
                                 transform,
                                 unknownUseNumbers,
@@ -180,6 +180,7 @@ class DataFields {
                                 paintFinishPath,
                                 recipeTypePath,
                                 patternPath,
+                                blueprintProxy
                             });
                         }
                         property.buildables.push({
@@ -383,7 +384,7 @@ class DataFields {
                             writer.writeInt32(0);
                             writer.writeByte(0);
                             writer.writeString(instance.recipeTypePath);
-                            writer.writeInt64(0n);
+                            ObjectReference_1.ObjectReference.write(writer, instance.blueprintProxy);
                         }
                     }
                 }

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

@@ -34,7 +34,11 @@ class StructProperty extends BasicProperty_1.AbstractBaseProperty {
         struct.value = StructProperty.ParseValue(reader, struct.subtype, size);
         const readBytes = reader.getBufferPosition() - before;
         if (readBytes !== size) {
-            throw new Error(`possibly corrupt. Read ${readBytes} for StructProperty Content of ${struct.subtype}, but ${size} were indicated.`);
+            if (size - readBytes === 4 && reader.readInt32() === 0) {
+            }
+            else {
+                throw new Error(`possibly corrupt. Read ${readBytes} for StructProperty Content of ${struct.subtype}, but ${size} were indicated.`);
+            }
         }
         return struct;
     }

package/build/parser/satisfactory/objects/property/special/SpecialAnyProperty.d.ts

@@ -42,6 +42,7 @@ export type BuildableTypeInstance = {
     paintFinishPath: string;
     recipeTypePath: string;
     patternPath: string;
+    blueprintProxy: ObjectReference;
 };
 export type BuildableSubsystemSpecialProperty = {
     buildables: {

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

@@ -152,9 +152,6 @@ class Level {
                 const collectable = ObjectReference_1.ObjectReference.read(reader);
                 collected.push(collectable);
             }
-            if (process.env.NODE_ENV === 'debug' && countSmthing > 0) {
-                console.log(printSmthWhenItsCollectables, countSmthing, collected.map(coll => coll.pathName).join(', '));
-            }
         }
         return collected;
     }

package/package.json

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