@satisfactory-dev/docs.json.ts-production-planner
TypeScript icon, indicating that this package has built-in type declarations

0.2.0 • Public • Published

Satisfactory Production Calculator

Production Calculator for Satisfactory built upon Docs.json.ts.

Using

Requirements

  • Docker
    • vscode recommended to use devcontainer support
  • A copy of Update 's Docs.json file

Setup

  1. Checkout locally
  2. Load in devcontainer-supporting IDE
    • devcontainer setup should automatically run make install
    • NODE_OPTIONS env var may require opening a fresh terminal if you receieve an error along the lines of TypeError [ERR_UNKNOWN_FILE_EXTENSION]: Unknown file extension ".ts"
  3. Copy Docs.json to ./data/
  4. Run make generate
  5. Run make generate--validators (needed to build the typescript definition file for the Ajv validator)

Documentation

No documentation as of yet 😬

Please refer to the tests in the meantime.

Issues

Issue tracker for both the calculator and the UI built atop the calculator are available on GitHub.

Implementations

Dependencies (6)

Dev Dependencies (12)

Package Sidebar

Install

npm i @satisfactory-dev/docs.json.ts-production-planner

Weekly Downloads

65

Version

0.2.0

License

Apache-2.0

Unpacked Size

94.2 kB

Total Files

33

Last publish

Collaborators

  • signpostmarv