@etothepii/satisfactory-file-parser 0.4.9 → 0.4.11

package/README.md

@@ -18,14 +18,14 @@ 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.9                 |
+| U1.0           |  ✅ >= 0.4.11                |
 
 
 ## 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.
+For reading a save file (`.sav`), just pass a Buffer to the parser with the file content.
 ```js
 import * as fs from 'fs';
 import { Parser } from "@etothepii/satisfactory-file-parser";
@@ -34,8 +34,33 @@ const file = fs.readFileSync('./MySave.sav') as Buffer;
 const parsedSave = Parser.ParseSaveFile(file);
 ```
 
+### Save Parsing via Stream
+
+You can parse via stream, to save RAM. The binary data 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
+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);
+});
+
+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

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

@@ -15,8 +15,8 @@ class BlueprintWriter extends byte_writer_class_1.ByteWriter {
     }
     static SerializeHeader(writer, header) {
         writer.writeInt32(2);
-        writer.writeInt32(42);
-        writer.writeInt32(263910);
+        writer.writeInt32(46);
+        writer.writeInt32(366202);
         let dimensions = [
             header.designerDimension?.x ?? 4,
             header.designerDimension?.y ?? 4,

package/build/parser/satisfactory/edit/edit-constants.d.ts

@@ -1619,7 +1619,7 @@ export declare const EDIT: {
                 readonly CLASS_NAME: "BP_Golfcart_C";
             };
             readonly FACTORY_CART_GOLD: {
-                readonly TYPE_paTH: "/Game/FactoryGame/Buildable/Vehicle/Golfcart/BP_GolfcartGold.BP_GolfcartGold_C";
+                readonly TYPE_PATH: "/Game/FactoryGame/Buildable/Vehicle/Golfcart/BP_GolfcartGold.BP_GolfcartGold_C";
                 readonly CLASS_NAME: "BP_GolfcartGold_C";
             };
             readonly EXPLORER: {
@@ -1632,7 +1632,7 @@ export declare const EDIT: {
             };
             readonly TRACTOR: {
                 readonly TYPE_PATH: "/Game/FactoryGame/Buildable/Vehicle/Tractor/BP_Tractor.BP_Tractor_C";
-                readonly CLAsS_NAME: "BP_Tractor_C";
+                readonly CLASS_NAME: "BP_Tractor_C";
             };
             readonly TRAIN: {
                 readonly LOCOMOTIVE: {
@@ -1777,6 +1777,10 @@ export declare const EDIT: {
                 readonly CLASS_NAME: "Build_QuantumEncoder_C";
             };
         };
+        readonly ALIEN_POWER_BUILDING: {
+            readonly TYPE_PATH: "/Game/FactoryGame/Buildable/Factory/AlienPower/Build_AlienPowerBuilding.Build_AlienPowerBuilding_C";
+            readonly CLASS_NAME: "Build_AlienPowerBuilding_C";
+        };
         readonly STORAGE: {
             readonly CONTAINER_MK_1: {
                 readonly TYPE_PATH: "/Game/FactoryGame/Buildable/Factory/StorageContainerMk1/Build_StorageContainerMk1.Build_StorageContainerMk1_C";
@@ -1822,6 +1826,10 @@ export declare const EDIT: {
                 readonly CLASS_NAME: "Build_StorageMedkit_C";
             };
         };
+        readonly POTTY: {
+            readonly TYPE_PATH: "/Game/FactoryGame/Buildable/Building/Potty/BUILD_Potty_mk1.BUILD_Potty_mk1_C";
+            readonly CLASS_NAME: "BUILD_Potty_mk1_C";
+        };
         readonly SIGN: {
             readonly SMALL: {
                 readonly TYPE_PATH: "/Game/FactoryGame/Buildable/Factory/SignDigital/Build_StandaloneWidgetSign_Small.Build_StandaloneWidgetSign_Small_C";
@@ -1894,7 +1902,7 @@ export declare const EDIT: {
                 readonly TYPE_PATH: "/Game/FactoryGame/Character/Creature/Enemy/Hog/Johnny/Char_Johnny.Char_Johnny_C";
                 readonly CLASS_NAME: "Char_Johnny_C";
             };
-            readonly SPITTER_SMALL: {
+            readonly SPITTER_ALPHA: {
                 readonly TYPE_PATH: "/Game/FactoryGame/Character/Creature/Enemy/Spitter/AlternativeSpitter/Char_Spitter_Alternative.Char_Spitter_Alternative_C";
                 readonly CLASS_NAME: "Char_Spitter_Alternative_C";
             };
@@ -1936,6 +1944,10 @@ export declare const EDIT: {
                 readonly TYPE_PATH: "/Game/FactoryGame/Character/Creature/Wildlife/SpaceRabbit/Char_SpaceRabbit.Char_SpaceRabbit_C";
                 readonly CLASS_NAME: "Char_SpaceRabbit_C";
             };
+            readonly BEETLE: {
+                readonly TYPE_PATH: "/Game/FactoryGame/Character/Creature/Wildlife/Beetle/Char_Beetle.Char_Beetle_C";
+                readonly CLASS_NAME: "Char_Beetle_C";
+            };
             readonly SPACE_GIRAFFE: {
                 readonly TYPE_PATH: "/Game/FactoryGame/Character/Creature/Wildlife/SpaceGiraffe/Char_SpaceGiraffe.Char_SpaceGiraffe_C";
                 readonly CLASS_NAME: "Char_SpaceGiraffe_C";

package/build/parser/satisfactory/edit/edit-constants.js

@@ -1703,7 +1703,7 @@ exports.EDIT = {
                 CLASS_NAME: 'BP_Golfcart_C'
             },
             FACTORY_CART_GOLD: {
-                TYPE_paTH: '/Game/FactoryGame/Buildable/Vehicle/Golfcart/BP_GolfcartGold.BP_GolfcartGold_C',
+                TYPE_PATH: '/Game/FactoryGame/Buildable/Vehicle/Golfcart/BP_GolfcartGold.BP_GolfcartGold_C',
                 CLASS_NAME: 'BP_GolfcartGold_C'
             },
             EXPLORER: {
@@ -1716,7 +1716,7 @@ exports.EDIT = {
             },
             TRACTOR: {
                 TYPE_PATH: '/Game/FactoryGame/Buildable/Vehicle/Tractor/BP_Tractor.BP_Tractor_C',
-                CLAsS_NAME: 'BP_Tractor_C'
+                CLASS_NAME: 'BP_Tractor_C'
             },
             TRAIN: {
                 LOCOMOTIVE: {
@@ -1861,6 +1861,10 @@ exports.EDIT = {
                 CLASS_NAME: 'Build_QuantumEncoder_C'
             },
         },
+        ALIEN_POWER_BUILDING: {
+            TYPE_PATH: '/Game/FactoryGame/Buildable/Factory/AlienPower/Build_AlienPowerBuilding.Build_AlienPowerBuilding_C',
+            CLASS_NAME: 'Build_AlienPowerBuilding_C'
+        },
         STORAGE: {
             CONTAINER_MK_1: {
                 TYPE_PATH: TYPE_PATH_CONTAINER_MK1,
@@ -1906,6 +1910,10 @@ exports.EDIT = {
                 CLASS_NAME: CLASS_NAME_PLAYER_MEDICAL_CRATE
             },
         },
+        POTTY: {
+            TYPE_PATH: '/Game/FactoryGame/Buildable/Building/Potty/BUILD_Potty_mk1.BUILD_Potty_mk1_C',
+            CLASS_NAME: 'BUILD_Potty_mk1_C'
+        },
         SIGN: {
             SMALL: {
                 TYPE_PATH: TYPE_PATH_SIGN_SMALL,
@@ -1978,7 +1986,7 @@ exports.EDIT = {
                 TYPE_PATH: '/Game/FactoryGame/Character/Creature/Enemy/Hog/Johnny/Char_Johnny.Char_Johnny_C',
                 CLASS_NAME: 'Char_Johnny_C'
             },
-            SPITTER_SMALL: {
+            SPITTER_ALPHA: {
                 TYPE_PATH: '/Game/FactoryGame/Character/Creature/Enemy/Spitter/AlternativeSpitter/Char_Spitter_Alternative.Char_Spitter_Alternative_C',
                 CLASS_NAME: 'Char_Spitter_Alternative_C'
             },
@@ -2020,6 +2028,10 @@ exports.EDIT = {
                 TYPE_PATH: TYPE_PATH_LIZARD_DOGGO,
                 CLASS_NAME: CLASS_NAME_LIZARD_DOGGO
             },
+            BEETLE: {
+                TYPE_PATH: '/Game/FactoryGame/Character/Creature/Wildlife/Beetle/Char_Beetle.Char_Beetle_C',
+                CLASS_NAME: 'Char_Beetle_C'
+            },
             SPACE_GIRAFFE: {
                 TYPE_PATH: TYPE_PATH_SPACE_GIRAFFE,
                 CLASS_NAME: CLASS_NAME_SPACE_GIRAFFE

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/special/SpecialAnyProperty.d.ts

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

package/package.json

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