Skip to content

Latest commit

 

History

History
105 lines (67 loc) · 3.2 KB

README.md

File metadata and controls

105 lines (67 loc) · 3.2 KB
Raw

Sankeyfactory

A tool for planning Satisfactory production chains with convenient sankey diagram view.

The tool: https://sankeyfactory.github.io.

The recipes are up-to-date with Satisfactory version 1.0 (The first version of the released game).

Static Badge

Table of contents

Screenshots

Show screenshots

Plan example

Plan example

Node configuration

Mobile

Building

Dependencies

First of all, you'll need npm.

Once it is installed, you can use it for the project dependencies:

# This will install all required dependencies.
> npm install

Compile

# Runs typescript compiler to check validity of the code.
> npm run compile

Building web application

# Builds application's TypeScript code to runnable by browsers JavaScript.
> npm run build-app

Once the web application is built, it can be viewed in browser by opening dist/index.html file.

To omit problems with CORS you can also run a local server with

> npm run start

Note that already built files can also be found in gh-pages branch of this repository.

Generating Satisfactory data files

# Builds and runs the tool on NodeJS.
> npm run export-satisfactory-data

Exporting Satisfactory icons

First, you'll need to export original icons from the game. See Extracting the game files.

Once you have the icons, they can be automatically copied and renamed by a tool to dist folder.

# Builds and runs the tool on NodeJS.
# RESOURCES_DIR should be set to a path where you exported icons to.
# For example: `RESOURCES_DIR=Path-To-FModel/Output/Exports/FactoryGame/Content`
> RESOURCES_DIR=... npm run export-satisfactory-icons

Note: RESOURCES_DIR is a environment variable and it can only be set this way on UNIX systems. If you're using Windows, setting the environment variable should be performed another way.

Extracting the game files

If you want to extract data from Satisfactory for developing tools like this one, here is what I used:

  1. File with all the in-game recipes: Satisfactory/CommunityResources/Docs/Docs.json

    Note: My tool converts the recipes from there into a more convenient format for my needs. If it's what you are seeking - look at the gh-pages repo branch.

  2. A tutorial for extracting game files such as icons.