1.0.0-a • Published 3 years ago

satisfactory-data-parser v1.0.0-a

Weekly downloads
29
License
MIT
Repository
github
Last release
3 years ago

SatisfactoryDataParser

Parses included Docs.json file to a documented JSON structure.

Installation

Install all the needed libraries using yarn install command.

CLI Usage

Create directory data and put the Docs.json file from game there (found at CommunityResources/Docs.json). Then run yarn parse. This will create a file called data.json with all the data, as well as output directory with data split to separate files.

API

Typescript:

import {Parser} from 'satisfactory-data-parser';

const result = Parser.parseString('data string'); // returns IDataSchema

Schema

JSON schema can be found in schema.json. You can also check src/Parser/Schema.ts file for Typescript schema definitions.