ficsit-toolkit

module
v0.0.0-...-0c1458e Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 7, 2022 License: MIT

README

FICSIT Toolkit

FICSIT Toolkit provides a collection of Go libraries for parsing a Satisfactory save game file.

🚧 This repo is still a massive work in progress. 🚧

Libraries

  • save - A low level parser / serializer for Satisfactory save files.
  • factory - Higher level parser for Satisfactory save files that understands and loads game state.
    • Huge WIP can currently only load some building types and understand conveyor connections
  • resource - Auto generated structs based on the Satisfactory docs.json file

Notes on API and version guarantees

  • Satisfactory is still in early access as such my only interest is maintaining support for the latest release on the early access branch.
  • At this point I'm still experimenting with stuff so the API may change entirely and without notice.

Other Packages

These packages were immensely helpful in understanding the Satisfactory save file structures:

Directories

Path Synopsis
gen
Package save is a parser and serializer for the Satisfactory save file format.
Package save is a parser and serializer for the Satisfactory save file format.
data
Package data provides the ability to read and write the necessary data types from a decompressed Satisfactory save body.
Package data provides the ability to read and write the necessary data types from a decompressed Satisfactory save body.
extra
Package extra provides handling for the extra data that may be appended on to a save.Entity
Package extra provides handling for the extra data that may be appended on to a save.Entity
property
Package property provides handling for the different property types that may be encountered within a Satisfactory save file.
Package property provides handling for the different property types that may be encountered within a Satisfactory save file.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL