Skip to content

ffxiv-teamcraft/simulator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

3706090 · Jan 23, 2025
Jan 12, 2024
Jan 23, 2025
Jan 23, 2025
Feb 15, 2020
Jun 14, 2019
Nov 2, 2019
Jun 15, 2019
Jun 14, 2019
Jan 23, 2025
Jun 14, 2019
Jun 14, 2019
Oct 24, 2021
Jun 14, 2019
Jan 23, 2025
Jan 23, 2025
Jun 15, 2019
Jun 14, 2019
Jun 14, 2019

Repository files navigation

Teamcraft simulator

CircleCI codecov npm version GitHub issues GitHub stars GitHub license

Table of contents

About

Teamcraft simulator is a simulation library for FINAL FANTASY XIV.

Installation

Install through npm:

npm install --save @ffxiv-teamcraft/simulator

Get started

const simulation = new Simulation(recipe, [new RapidSynthesis(), new RapidSynthesis()], crafterStats);
const result = simulation.run();
const reliabilityReport = simulation.getReliabilityReport();

Documentation

Everything is detailed on the documentation website.

Development

Prepare your environment

  • Install Node.js and NPM
  • Install local dev dependencies: npm install while current directory is this repo

Testing

Run npm test to run tests once or npm run test:watch to continually run tests.

Release

  • Bump the version in package.json (once the module hits 1.0 this will become automatic)
npm run release

License

MIT