Skip to content

Imachicken29/Documentation

 
 

Repository files navigation

Satisfactory Modding Documentation

Documentation for SML and Unreal modding. Master branch is live on https://docs.ficsit.app/. Please contact us on the Satisfactory Modding Discord Server (preferred) or the Ficsit.app forums with questions and suggestions.

We attempt to roughly follow Semantic Line Break format, but this is only loosely followed.

Pull requests should target the dev branch.

Documentation for other mods is also served through the same site. If you have written documentation for your mod and would like it to be added, contact us.

Development Setup

Installing

  1. Install Node.js and Yarn Package Manager through your preferred method

  2. Use Yarn to install dependencies

yarn install

Building

yarn run build

The output files will be in \build\site

If this command fails for you, you may need to download an alternate playbook file specifically for development and put it in the root folder of the repo. To use it, run yarn run build:dev instead of the above.

About

Documentation for SML and Unreal modding.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Handlebars 53.7%
  • CSS 36.0%
  • JavaScript 6.5%
  • Dockerfile 3.6%
  • PowerShell 0.2%