Teamcraft simulator

Table of contents

• About
• Installation
• Documentation
• Development
• License

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