oot-bingo-lists v2.1.0
OoT Bingo Lists
Provides the bingo goal lists and generators of various Ocarina of Time Bingo versions.
Related packages:
- oot-bingo-generator Latest version of the generator, and lots of documentation
- oot-bingo-tools Handy helper functions like frequency analysis and changelog generation
Install
npm install --save oot-bingo-listsSupported bingo versions
v9.1v9.2v9.3v9.4v9.5v9.5.1v10.0v10.1v10.2v10.3v10.3.1v10.3.2v10.4v10.5
Usage
Bingo lists and generators
Use the getBingoList() function to retrieve the bingo list of a specific bingo version:
import { getBingoList } from "oot-bingo-lists";
const bingoList = getBingoList("v10.2");Note that the latest version of the oot-bingo-generator might not
match with the generator that was used for a specific bingo version.
Get a version specific generator with getGenerator():
import { getGenerator } from "oot-bingo-lists";
const generator = getGenerator("v10.2");Latest version
Get the bingo list of the latest version:
import { getBingoList, latestBingoVersion } from "oot-bingo-lists";
const bingoList = getBingoList(latestBingoVersion);Generate boards
It's also possible to generate boards. The package will use the generator that actually belonged to your specified version, so that the resulting boards are correct:
import { generateBingoBoardFromVersion } from "oot-bingo-lists";
const board = generateBingoBoardFromVersion("v9.3", "blackout", 654321);Run source code directly
If you would like to work with the source code directly rather than installing this as a package, you can clone the repo and install the dependencies:
npm installBuild
Create a build of the package outputted in the folder build:
npm run buildPublish
Publish the package to NPM:
npm run prepare
npm publish