factorio-item-browser/export-data

The export data structure of the Factorio Item Browser.

4.0.0 2021-02-17 11:54 UTC

Requires

• php: ^7.4 | ^8.0
• ext-json: *
• ext-mbstring: *
• ext-zip: *
• bluepsyduck/jms-serializer-factory: ^1.0
• bluepsyduck/laminas-autowire-factory: ^1.0
• jms/serializer: ^3.2
• laminas/laminas-servicemanager: ^3.0
• symfony/yaml: ^4.0 | ^5.0

Requires (Dev)

• bluepsyduck/test-helper: ^1.0
• phpstan/phpstan: ^0.12
• phpstan/phpstan-phpunit: ^0.12
• phpstan/phpstan-strict-rules: ^0.12
• phpunit/phpunit: ^9.0
• rregeer/phpunit-coverage-check: ^0.3
• squizlabs/php_codesniffer: ^3.4

GPL-3.0-or-later

• BluePsyduck

• export
• BluePsyduck
• Factorio Item Browser
• FIB

README

Export Data Library

This library provides a data structure used to persist all the exported data from the Factorio game to the disk to later upload it to the server and import it into the actual database.

This persistence layer is required because the export gets executed on a local machine (able to run Factorio), which does not have access to the database on the server. This library simplifies uploading all the data (of which most are the icon images) and reading it into the importer script.

The data itself is saved in a single JSON file. The library puts this file into a zip archive, and adds all the rendered icon files to it as well, creating a single zip file as upload. All this is managed by the ExportDataService, which is the main entry point for the library.