Skip to content

Latest commit

 

History

History
38 lines (30 loc) · 1.97 KB

README.md

File metadata and controls

38 lines (30 loc) · 1.97 KB
Raw

SatisfactoryTools

Satisfactory Tools for planning and building the perfect base.

Requirements

  • node.js version 16 (lower may work, 17+ doesn't work)
  • yarn
  • PHP 7.1+

Installation

  • git clone git@github.com:greeny/SatisfactoryTools.git
  • yarn install
  • copy env.prod.json to env.json
  • yarn build
  • Set up a virtual host pointing to /www directory (using e.g. Apache or ngnix)

Contributing

Any pull requests are welcome, though some rules must be followed:

  • try to follow current coding style (there's tslint and .editorconfig, those should help you with that)
  • one PR per feature
  • all PRs must target dev branch

Development

Run yarn start to start the automated build process. It will watch over the code and rebuild it on change.

Updating data

Get the latest Docs.json from your game installation and place it into data folder. Then run yarn parseDocscommand and the data.json file would get updated automatically. It will also generate diff.txt file in the same folder, marking differences between the two files in a player-readable format (useful for generating changelogs), as well as imageMapping.json, which will be useful if you want to update icons as well (see below).

Updating icons

First you need to extract the images out of the game pack. You need umodel (UE Viewer) program. Run these commands (replacing paths where necessary):

.\umodel.exe -path="C:\Program Files\Epic Games\SatisfactoryExperimental\FactoryGame\Content\Paks" -out=".\out256" -png -export *_256.uasset -game=ue4.22
.\umodel.exe -path="C:\Program Files\Epic Games\SatisfactoryExperimental\FactoryGame\Content\Paks" -out=".\out256" -png -export *_256_New.uasset -game=ue4.22

After the export is done, copy the resulting out256 folder to data/icons. Then run yarn generateImages, which will automatically generate the images in correct sizes and places. yarn parseDocs has to be run before this command, if it wasn't run in the previous step.