@etothepii/satisfactory-file-parser 0.0.12 → 0.0.13
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.README.md +41 -0
- package/package.json +1 -1
package/.README.md
ADDED
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
# Satisfactory File Parser
|
|
2
|
+
This is an NPM TypeScript Module to parse Satisfactory Files. Satisfactory is a game released by Coffee Stain Studios.
|
|
3
|
+
|
|
4
|
+
The Module is written entirely in TypeScript and comes with Type Definitions.
|
|
5
|
+
|
|
6
|
+
This parser can read, modify and write:
|
|
7
|
+
- Save Files `.sav`
|
|
8
|
+
- Blueprint Files `.sbp`, `.sbpcfg`
|
|
9
|
+
|
|
10
|
+
## Supported Versions
|
|
11
|
+
Game Version Files of U5 and below are NOT supported. However, U6 and above is perfectly fine and parsable.
|
|
12
|
+
- ✅ U7
|
|
13
|
+
- ✅ U6
|
|
14
|
+
- ❌ <= U5
|
|
15
|
+
|
|
16
|
+
### U8 is on the Horizon!
|
|
17
|
+
We can not promise that U8 saves will work out of the box!
|
|
18
|
+
If there will be changes, those will come very soon as soon as U8 is out on Experimental.
|
|
19
|
+
|
|
20
|
+
## Installation via npm
|
|
21
|
+
`npm install @etothepii/satisfactory-file-parser`
|
|
22
|
+
## Usage
|
|
23
|
+
Usage of the SaveParser is easy. For reading a save file, just pass a Buffer to it.
|
|
24
|
+
```js
|
|
25
|
+
import { SaveParser } from "@etothepii/satisfactory-file-parser";
|
|
26
|
+
|
|
27
|
+
const file = fs.readFileSync('./MySave.sav') as Buffer;
|
|
28
|
+
const parsedSave = SaveParser.ParseSaveFile(file);
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
Consequently, writing a parsed save file back is just as easy.
|
|
32
|
+
```js
|
|
33
|
+
import { SaveParser } from "@etothepii/satisfactory-file-parser";
|
|
34
|
+
|
|
35
|
+
SaveParser.WriteSave(parsedSave);
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
## License
|
|
39
|
+
MIT
|
|
40
|
+
|
|
41
|
+
The module's code is free to use and open source.
|
package/package.json
CHANGED