Locally Stored Files - mulark/factorio-benchmark-helper GitHub Wiki

After you run factorio-benchmark-helper once, a folder will be created in your data directory

/home/alice/.local/share/factorio-benchmark-helper

C:\Users\Alice\AppData\Roaming\factorio-benchmark-helper

This folder will at various stages contain the following files/folders:

cache/

This folder contains all mods and saves that will be benchmarked with. As to not clobber your existing saves with potentially different saves of the same name, this folder is used as a staging location. Should your benchmark procedures have download links defined, there is no risk to deleting this folder.

procedures/

This folder contains the actual benchmark procedure JSON files which themselves are a template for running a benchmark.

config.ini

The config file used for running factorio-benchmark-helper. This config file is forward compatible, if any changes occur here pre-existing values will be brought forward. There is no forward compatibility for comments. The fields available in the config file at this time are:

; Comments begin with a semicolon ';'

; Property used for updating this config file
config-file-version=1

use-steam-version=true

; The path to Factorio, if Steam version is not used or could not be found
; Required if use-steam-version is false
factorio-path=

; Erase the preview image from saves during a --create-benchmark
; Saves a couple of bytes in the resulting save
; Uses 7z so that must be installed for it to succeed
erase-preview-image=true

; Backblaze keyID to allow automatic upload of saves to b2 Backblaze
b2-backblaze-keyID=

; Backblaze application key to allow automatic upload of saves to b2 Backblaze
b2-backblaze-applicationKey=

; For test use only
TRAVIS_CI_B2_KEYID=
TRAVIS_CI_B2_APPLICATIONKEY=

results.db

The performance metrics obtained from benchmarks. This is a sqlite3 database. WIP: Currently there's no sanctioned way to dump data from this database from within factorio-benchmark-helper. This means you do need sqlite3 installed to be able to dump it. A bash script is available for quicker dumps here: https://github.com/mulark/Factorio-benchmarking-tools/blob/master/create_sql_pivot.sh