PHPackages                             satisfactory-tools/docs-parser - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Parsing & Serialization](/categories/parsing)
4. /
5. satisfactory-tools/docs-parser

ActiveLibrary[Parsing & Serialization](/categories/parsing)

satisfactory-tools/docs-parser
==============================

Parser for Satisfactory documentation files.

v1.0.2(1mo ago)02MITPHPPHP ^8.5CI passing

Since Jul 9Pushed 1mo agoCompare

[ Source](https://github.com/SatisfactoryTools/DocsParser)[ Packagist](https://packagist.org/packages/satisfactory-tools/docs-parser)[ RSS](/packages/satisfactory-tools-docs-parser/feed)WikiDiscussions master Synced 1w ago

READMEChangelogDependencies (7)Versions (4)Used By (0)

SatisfactoryTools/DocsParser
============================

[](#satisfactorytoolsdocsparser)

This package can parse exported files from Satisfactory to generate info about recipes, items, schematics, etc.

Running the parser
------------------

[](#running-the-parser)

You need to either have Docker installed, or PHP 8.5+.

For docker, you can use the prebuilt image from GitHub Container Registry:

```
docker run --rm -v "$PWD:/data" ghcr.io/satisfactorytools/docs-parser [command]
```

Or build the container yourself once, and then just run it:

```
docker build -t docs-parser .
docker run --rm -v "$PWD:/data" docs-parser [command]
```

Note that the container only sees files under the mounted `/data` directory, so pass input/output paths through it, e.g.:

```
docker run --rm -v "$PWD:/data" docs-parser parse /data/Docs.json -o /data -f wiki
```

If you want to use it locally, install dependencies first (requires [Composer](https://getcomposer.org/) installed), then run it through PHP:

```
composer install
php bin/docsParser [command]
```

### Commands

[](#commands)

If you run the app without any arguments, it'll show you a list of commands.

You can use `help [command]` to get info about supported parameters.

### Examples

[](#examples)

Parse data, export to wiki format, and omit ficsmas data:

```
php bin/docsParser parse /path/to/docs.json -o /path/to/output/dir -f wiki --no-ficsmas
```

Using in PHP
------------

[](#using-in-php)

If you want to use the parser in your own PHP project, you can add it via composer

```
composer require satisfactory-tools/docs-parser
```

Example usage:

```
use SFTools\Data\Parser\DocsParser;

$parser = new DocsParser;
$schema = $parser->parse(file_get_contents(__DIR__ . '/docs.json')); // $schema is SFTools\Data\Schema\DocsSchema

// You can also export the schema in any format you like
use SFTools\Data\Export\WikiExporter;

$exporter = new WikiExporter;
$output = $exporter->export($schema);

// $output is an array of [file prefix => file content]; the prefix may be an empty string for single-file formats
```

### Custom parsing

[](#custom-parsing)

You can implement `SFTools\Data\Export\Exporter` interface to define your own format to export. You can also implement `SFTools\Data\Transformers\Transformer` to add more transformers (they can "fix" wrong datapoints or transform data to different values).

To run a transformer, you can do something like this:

```
$transformer = new MyTransformer;
$schema->transform($transformer);
```

You can also specify a list of handlers/transformers to use in the DocsParser constructor:

```
$parser = new DocsParser([new MyHandler], [new MyTransformer]);
```

This will skip the default handlers and use only the ones you specified. Passing `null` instead of an array will use the default handlers/transformers.

###  Health Score

40

—

FairBetter than 86% of packages

Maintenance90

Actively maintained with recent releases

Popularity2

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity53

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~0 days

Total

3

Last Release

47d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/3734204?v=4)[Tomáš Blatný](/maintainers/greeny)[@greeny](https://github.com/greeny)

---

Top Contributors

[![greeny](https://avatars.githubusercontent.com/u/3734204?v=4)](https://github.com/greeny "greeny (6 commits)")

---

Tags

composer-packageparserphpsatisfactory

###  Code Quality

Static AnalysisPHPStan

Type Coverage Yes

### Embed Badge

![Health badge](/badges/satisfactory-tools-docs-parser/health.svg)

```
[![Health](https://phpackages.com/badges/satisfactory-tools-docs-parser/health.svg)](https://phpackages.com/packages/satisfactory-tools-docs-parser)
```

###  Alternatives

[rector/rector-src

Instant Upgrade and Automated Refactoring of any PHP code

136411.0k14](/packages/rector-rector-src)[ssch/typo3-rector

Instant fixes for your TYPO3 PHP code by using Rector.

2613.3M491](/packages/ssch-typo3-rector)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)