@etothepii/satisfactory-file-parser 0.4.14 → 0.4.15

package/LICENCE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 etotheepii
+Copyright (c) 2024 etothepii
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -8,7 +8,7 @@ This parser can read, modify and write:
 - Save Files `.sav`
 - Blueprint Files `.sbp`, `.sbpcfg`
 
-## Supported Versions
+# Supported Versions
 The version support of the packages is indicated below. Some bugs might still be present, see Bug Reporting further down.
 
 Game Version Files of U5 and below are NOT supported.
@@ -20,13 +20,10 @@ Game Version Files of U5 and below are NOT supported.
 | U8             |  ✅ 0.1.20 - 0.3.7           |
 | U1.0           |  ✅ >= 0.4.14                |
 
-## Changelog
-The Changelog is alongside the readme [here](./CHANGELOG.md)
-
-## Installation via npm
+# Installation via npm
 `npm install @etothepii/satisfactory-file-parser`
 
-## Usage of Save Parsing
+# Usage of Save Parsing
 
 I recommend parsing via stream, to save RAM. The binary data of the whole save will still be in memory, but the converted JSON can be streamed. (You can of course keep reading the stream in memory).
 The returned `stream` is a readable WHATWG stream of type string and represents a `SatisfactorySave` object. this object can be serialized again.
@@ -89,7 +86,7 @@ fs.writeFileSync('./MyModifiedSave.sav', Buffer.concat([fileHeader!, ...bodyChun
 ```
 
 
-### Old Save Parsing. Deprecated.
+## 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';
@@ -100,7 +97,7 @@ const parsedSave = Parser.ParseSaveFile('MySave', file);
 ```
 
 
-## Usage of Blueprint Parsing
+# Usage of Blueprint Parsing
 Note, that blueprints consist of 2 files. The `.sbp` main file and the config file `.sbpcfg`.
 
 ```js
@@ -136,11 +133,29 @@ fs.writeFileSync('./MyModifiedBlueprint.sbp', Buffer.concat([mainFileHeader!, ..
 fs.writeFileSync('./MyModifiedBlueprint.sbpcfg', Buffer.from(summary.configFileBinary));
 ```
 
-### Bug Reports or Feedback
+# Bug Reports or Feedback
 So far this was just a private hobby project. But i figure some people actually use it.
 If you find a bug or have feedback about the parser, you can just hit me up on the satisfactory discord `etothepii`.
 
-## License 
+# Changelog
+
+### [0.4.15] (2024-10-02)
+#### updated README
+* changelog document doesn't seem linkable, so it is in the readme for now.
+
+### [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)
+* 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.
+* changed function name `writeFloat()` to `writeFloat32()` of the save writer.
+* changed variable name `saveOrBlueprintIndicator` to `objectVersion` for objects, since the meaning of that number became now more clear.
+
+
+# License 
 MIT License
 
 Copyright (c) 2024 etothepii

package/package.json

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

package/CHANGELOG.md

@@ -1,12 +0,0 @@
-# Changelog
-
-## [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)
-* 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.
-* changed function name `writeFloat()` to `writeFloat32()` of the save writer.
-* changed variable name `saveOrBlueprintIndicator` to `objectVersion` for objects, since the meaning of that number became now more clear.