Satisfactory Save Parser

Copyright (c) 2024 GreyHak

A set of Python tools for parsing Satisfactory save files, and then displaying and manipulating the contents.

Satisfactory is a non-competitive, first-person, open-world, factory-building and exploration game produced by Coffee Stain Studios.

sav_parse.py

sav_parse.py will decode the save file. It can be used as either a library or a program.

When used as a library, call sav_parse.readFullSaveFile(<filename>) to parse the entire save file, or sav_parse.readSaveFileInfo(<filename>) to parse just the header information.

When used as a program, from the command line call py sav_parse.py <filename> to generate a text file representation of the save file.

sav_to_resave.py

sav_to_resave.py will create a save file based on the data producted by sav_parse.py or a manipulated varient of that data. The interface is sav_to_resave.saveFile(saveFileInfo, headhex, grids, levels, extraObjectReferenceList, outFilename) where the first five parameters are the variables that sav_parse.readSaveFileInfo returns.

sav_cli.py

sav_cli.py makes use of sav_parse.py and sav_to_resave.py to either provide specific information from the save file or change data in a save file.

Usage:

• py sav_cli.py --help
• py sav_cli.py --info <save-filename>
• py sav_cli.py --to-json <save-filename> <output-json-filename>
• py sav_cli.py --from-json <input-json-filename> <new-save-filename>
• py sav_cli.py --set-session-name <new-session-name> <original-save-filename> <new-save-filename>
• py sav_cli.py --find-free-stuff [item] [save-filename]
• py sav_cli.py --list-players <save-filename>
• py sav_cli.py --list-player-inventory <player-num> <save-filename>
• py sav_cli.py --export-player-inventory <player-num> <save-filename> <output-json-filename>
• py sav_cli.py --import-player-inventory <player-num> <original-save-filename> <input-json-filename> <new-save-filename> [--same-time]
• py sav_cli.py --tweak-player-inventory <player-num> <slot-index> <item> <quantity> <original-save-filename> <new-save-filename> [--same-time]
• py sav_cli.py --rotate-foundations <primary-color-hex-or-preset> <secondary-color-hex-or-preset> <original-save-filename> <new-save-filename> [--same-time]
• py sav_cli.py --clear-fog <original-save-filename> <new-save-filename> [--same-time]
• py sav_cli.py --export-hotbar <player-num> <save-filename> <output-json-filename>
• py sav_cli.py --import-hotbar <player-num> <original-save-filename> <input-json-filename> <new-save-filename> [--same-time]
• py sav_cli.py --change-num-inventory-slots <num-inventory-slots> <original-save-filename> <new-save-filename> [--same-time]
• py sav_cli.py --restore-somersloops <original-save-filename> <new-save-filename> [--same-time]
• py sav_cli.py --restore-mercer-spheres <original-save-filename> <new-save-filename> [--same-time]
• py sav_cli.py --export-somersloops <save-filename> <output-json-filename>
• py sav_cli.py --export-mercer-spheres <save-filename> <output-json-filename>
• py sav_cli.py --import-somersloops <original-save-filename> <input-json-filename> <new-save-filename> [--same-time]
• py sav_cli.py --import-mercer-spheres <original-save-filename> <input-json-filename> <new-save-filename> [--same-time]
• py sav_cli.py --remember-username <player-num> <username-alias>
• py sav_cli.py --list-vehicle-paths <save-filename>
• py sav_cli.py --export-vehicle-path <path-name> <save-filename> <output-json-filename>
• py sav_cli.py --import-vehicle-path <path-name> <original-save-filename> <input-json-filename> <new-save-filename> [--same-time]
• py sav_cli.py --blueprint --show <save-filename>
• py sav_cli.py --blueprint --sort <original-save-filename> <new-save-filename> [--same-time]
• py sav_cli.py --blueprint --export <save-filename> <output-json-filename>
• py sav_cli.py --blueprint --import <original-save-filename> <input-json-filename> <new-save-filename> [--same-time]
• py sav_cli.py --blueprint --add-category <category> <original-save-filename> <new-save-filename> [--same-time]
• py sav_cli.py --blueprint --add-subcategory <category> <subcategory> <original-save-filename> <new-save-filename> [--same-time]
• py sav_cli.py --blueprint --add-blueprint <category> <subcategory> <blueprint> <original-save-filename> <new-save-filename> [--same-time]
• py sav_cli.py --blueprint --remove-category <category> <original-save-filename> <new-save-filename> [--same-time]
• py sav_cli.py --blueprint --remove-subcategory <category> <subcategory> <original-save-filename> <new-save-filename> [--same-time]
• py sav_cli.py --blueprint --remove-blueprint <category> <subcategory> <blueprint> <original-save-filename> <new-save-filename> [--same-time]
• py sav_cli.py --blueprint --move-blueprint <old-category> <old-subcategory> <new-category> <new-subcategory> <blueprint> <original-save-filename> <new-save-filename> [--same-time]
• py sav_cli.py --blueprint --reset <original-save-filename> <new-save-filename> [--same-time]
• py sav_cli.py --resave-only <original-save-filename> <new-save-filename>

If --find-free-stuff is used inconjunction with sav_to_html.py and a blank map, it will generate a map of all the locations for the specified item.

With v1.0.0.4 release, there isn't much point to the --blueprint --sort operation since the game's reverse-sorting is performed on save-open time.

sav_to_html.py

sav_to_html.py can be used as either a library or a program.

Command line: py sav_to_html.py <save-filename> [output-html-file]

Library: sav_to_html.generateHTML(str savFilePath, str outputDirectory, str htmlBaseName)

sav_to_html.py makes use of sav_parse.py to decode a save file and creates a save.html. The HTML page contains:

• Session Name
• Save Date
• Play Time
• Game Phase
• Active Milestone
• Mined Resource Count
• Collected Power Slugs, Somersloops, and Mercer Sphere Counts
• Unopened, Looted, and Opened/Unlooted Hard Drive Counts
• Unlock Progress Counts
• Sink Point Progress
• Dimensional Depot Contains: List by item with quantity and percent full
• Currently Built Items: List of items by quantity

When a blank map, included in the release as blank_map20.png, is provided, this script also creates maps of:

• The location of all the remaining power slugs.
• The location of all the remaining somersloops.
• The location of all the remaining mercer spheres.
• The location of all the hard drives including which are opened, looted and opened/unlooted.
• The power grid.
• The resource nodes including their type, locations, purity, and usage.

sav_monitor.py

Usage: py sav_monitor.py [save-directory] [html-output-directory] [monitor-period] [archive-directory]

sav_monitor.py will check for new save files, generate html/png summary of new save files, and optionally archive the save files.

Credits

The source code in this repo was developed by GreyHak.

Source code credit for the the quaternion/euler rotation conversions used by sav_cli.py goes to Addison Sears-Collins.

Thanks go to AnthorNet of Satisfactory Calculator Interactive Map fame.

• The map used by sav_to_html.py is a modified version of the map extracted from Anthor's Interactive Map.
• Resource purities, available in the sav_parse.py RESOURCE_PURITY variable, used by sav_to_html.py, were extracted from Anthor's Interactive Map.
• Anthor's pre-Update-8 JavaScript code was used as a reference.
• Anthor's Interactive Map was also a great test tool to verify the save files produced by sav_to_resave.py and sav_cli.py.

Thanks go to the Wiki authors who documented the old, but still very helpful, v0.6.1.3 version of the save file format at Satisfactory GG Wiki Save Files. I updated the Satisfactory GG Wiki for v1.0.0.4 based on the information I gained during creation of this tools.

Thanks to robison4th, JP Eagles and Katz, Buggy, Tomtores, and Mattigins for sharing their save files to allow for expanded support.

License

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 3.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.