Download the PHP package satisfactory-tools/docs-parser without Composer

On this page you can find all versions of the php package satisfactory-tools/docs-parser. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of satisfactory-tools/docs-parser

Informations about the package docs-parser

SatisfactoryTools/DocsParser

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

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:

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

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

If you want to use it locally, install dependencies first (requires Composer installed), then run it through PHP:

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

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

Using in PHP

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

Example usage:

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:

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

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.

All versions of docs-parser with dependencies

PHP Build Version
Package Version
Requires php Version ^8.5
ext-iconv Version *
nette/utils Version ^v4.1.1
nette/tokenizer Version ^v3.1.1
symfony/console Version ^v8.0.3
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package satisfactory-tools/docs-parser contains the following files

Loading the files please wait ...