preston159 / documentation

Documentation for SML and Unreal modding.

Satisfactory Modding Documentation

Documentation for Satisfactory Mod Loader (SML) and Satisfactory 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 (not checked very often) with questions and suggestions.

We attempt to use Semantic Line Break format in the source files, but this is only loosely followed.

Pull requests should target the dev branch.

Before you submit changes, you should probably follow the Development Setup directions below to verify that the pages are displaying as expected.

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

Although you can edit the .adoc files with just about any editor out there, we suggest either Visual Studio Code (with the Asciidoc and Code Spell Checker plugins) or IntelliJ.

In order to see what the pages will look like on the live site before being deployed, follow the below directions.

Installing

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

2. Use Yarn to install dependencies

yarn install

Building

To build the docs for SML and all other hosted mods (slow):

yarn run build

To build the docs for just SML, download an alternate Antora playbook file and put it in the root folder of the repo.

Then, run the following:

yarn run build:dev

The output HTML files for both commands can be found in \build\site.