@etothepii/satisfactory-file-parser
Advanced tools
@etothepii/satisfactory-file-parser - npm Package Compare versions
Comparing version 0.4.14 to 0.4.15
| MIT License | ||
| Copyright (c) 2023 etotheepii | ||
| Copyright (c) 2024 etothepii | ||
@@ -5,0 +5,0 @@ Permission is hereby granted, free of charge, to any person obtaining a copy |
| { | ||
| "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.", | ||
@@ -6,0 +6,0 @@ "types": "./build/index.d.ts", |
@@ -11,3 +11,3 @@ # Satisfactory File Parser | ||
| ## Supported Versions | ||
| # Supported Versions | ||
| The version support of the packages is indicated below. Some bugs might still be present, see Bug Reporting further down. | ||
@@ -24,9 +24,6 @@ | ||
| ## 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 | ||
@@ -94,3 +91,3 @@ 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). | ||
| ### 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. | ||
@@ -106,3 +103,3 @@ ```js | ||
| ## Usage of Blueprint Parsing | ||
| # Usage of Blueprint Parsing | ||
| Note, that blueprints consist of 2 files. The `.sbp` main file and the config file `.sbpcfg`. | ||
@@ -143,7 +140,25 @@ | ||
| ### 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 | ||
@@ -150,0 +165,0 @@ |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by0.01%
551156
- Number of lines in readme file
- increased by9.15%
179
Worsened metrics
- Number of package files
- decreased by-0.91%
109