Package Exports
- fab-cards
- fab-cards/dist/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (fab-cards) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Flesh and Blood cards
6.0 breaking changes
- Eliminated card types (like ActionCard) because the 1:1 type:subtype mapping doesn't follow anymore (see Nitro Mechanoid)
card.typehas been deprecated in favor ofcard.typesto match the 2.0 rule setcard.subTypehas been deprecated in favor ofcard.subtypesto match the 2.0 rule set
5.0 breaking changes
card.classhas been deprecated in favor ofcard.classesto match the 2.0 rule set- Images now reference file names instead of complete URLs. This significantly reduces the bundle size of the library and adds flexibility for projects to use their own image hosting. See fabrary/images for an example of how to generate webp files of all cards.
card.defaultImageUrlis deprecated in favor ofcard.defaultImageNameandcard.specialImageNamecard.images.urlis deprecated in favor ofcard.images.name
Overview and installation
A library of all Flesh and Blood cards, available as a bundled TypeScript file with matching interfaces. Source data comes from the amazing the-fab-cube/flesh-and-blood-cards repository maintained by Tyler Luce - all credit goes to him, and all errors are probably added by me in this project 😅.
To install run npm i --save fab-cards.
Access the card data in your project:
import { cards } from "fab-cards";
cards.forEach((card) => {
// do stuff with the card data
});Card interfaces
Card contains all of the fields that could show up for any particular card. Required fields can be found on every card, while optional fields may or may not exist on any given card.
Required
| Field | Data type | Examples |
|---|---|---|
| artists | string array |
[ "Riordan Delmiro" ] |
| cardIdentifier | string |
"snatch-red", "aether-wildfire-red" |
| classes | Class enum array |
["Generic"], ["Warrior","Wizard"] |
| defaultImageName | string |
"1HP001.width-450" |
| images | Image array |
see Image |
| name | string |
"Rain Razors", "Pummel" |
| rarity | Rarity enum |
"Super Rare", "Token" |
| setIdentifiers | string array |
[ "1HP009", "CRU006" ] |
| sets | Release enum array |
[ "History Pack 1", "Crucible of War" ] |
| specialImageName | string |
"1HP001.width-450" |
| subtypes | Subtype enum array |
["OneHanded", "Dagger"], ["Aura"] |
| types | Type enum array |
["Action"], ["Hero"] |
| typeText | string |
"Elemental Ranger Action – Arrow Attack" |
Optional
| Field | Data type | Examples |
|---|---|---|
| cost | number |
0, 10 |
| defense | number |
3, 4 |
| functionalText | string |
"If Snatch hits, draw a card." |
| fusions | Fusion enum array |
[ "Earth", "Ice" ] |
| hero | Hero enum |
"Rhinar", "Dori" |
| intellect | number |
3, 4 |
| isCardBack | boolean |
true |
| keywords | Keyword enum array |
[ "Boost" ] |
| life | number |
18, 40 |
| oppositeSideCardIdentifier | string |
"invoke-kyloria-red", "tomeltai" |
| pitch | number |
1, 2, 3 |
| power | number |
3, 14 |
| restrictedFormats | Format enum array |
[ "Blitz" ] |
| specialCost | string |
"XX", "3X" |
| specialDefense | string |
"*" |
| specialPower | string |
"*" |
| specializations | Hero enum array |
["Dromai","Fai"] |
| talents | Talent enum array |
[ "Draconic" ] |
| young | boolean |
true |
Image contains information needed to correctly display card images
| Field | Data type | Examples |
|---|---|---|
| art | string of Art enum |
"Cold Foil", "Standard" |
| edition | string of ReleaseEdition enum |
"Alpha", "Unlimited" |
| identifier | string |
"1HP001" |
| name | string |
"1HP001.width-450" |
| set | string of Release enum |
"Dynasty", "Uprising" |
| treatment | string of Treatment enum |
"Alternate Art", "Extended Art" |
Enums
Class
"NotClassed", "Generic", "Adjudicator", "Bard", "Brute", "Guardian", "Illusionist", "Mechanologist", "Merchant", "Ninja", "Ranger", "Runeblade", "Shapeshifter", "Warrior", "Wizard",Format
"Blitz", "Clash", "Classic Constructed", "Commoner",Fusion
"Earth", "Ice", "Lightning",Rarity
"Token", "Common", "Rare", "Super Rare", "Majestic", "Legendary", "Fabled", "Promo",Release
// Full sets
"Arcane Rising", "Crucible of War", "Dynasty", "Everfest", "History Pack 1", "Monarch", "Tales of Aria", "Uprising", "Welcome to Rathe",
// Hero/blitz decks
"Boltyn Blitz Deck", "Briar Blitz Deck", "Bravo Blitz Deck", "Chane Blitz Deck", "Classic Battles: Rhinar vs Dorinthea", "Dorinthea Hero Deck", "Ira Welcome Deck", "Katsu Hero Deck", "LeviaBlitzDeck", "Lexi Blitz Deck", "Oldhim Blitz Deck", "Prism Blitz Deck", "Rhinar Hero Deck",
// One-offs
"Promos",Talent
"Not talented", "Draconic", "Earth", "Elemental", "Ice", "Light", "Lightning", "Royal", "Shadow",Type
"Action", "Attack Action", "Attack Reaction", "Defense Reaction", "Equipment", "Hero", "Instant", "Mentor", "Resource", "Token", "Weapon",Hero
"Arakni", "Azalea", "Benji", "Boltyn", "Bravo", "Briar", "Chane", "Dash", "Data Doll", "Dorinthea", "Emperor", "Genis Wotchuneed", "Ira", "Iyslander", "Kano", "Kassai", "Katsu", "Kavdaen", "Kayo", "Levia", "Lexi", "Oldhim", "Prism", "Rhinar", "Ruu’di", "Shiyana", "Taylor", "Valda", "Viserai", "Yorick",Keyword
"Arcane Barrier", "Battleworn", "Blade Break", "Blood Debt", "Boost", "Channel", "Charge", "Combo", "Crush", "Dominate", "Essence", "Freeze", "Fusion", "Go Again", "Heave", "Intimidate", "Legendary", "Mentor", "Negate", "Opt", "Phantasm", "Reload", "Reprise", "Specialization", "Spectra", "Spellvoid", "Temper", "Thaw", "Unfreeze",Working with this project
Card data
- src/cards.csv is the source of truth for all generated data. The data is managed in Google Sheets and sourced from the-fab-cube/flesh-and-blood-cards.
Data transformations
There are three steps involved in transforming the .tsv source data into typed .ts code - executed via npm run transform.
- src/parser.ts reads from the
.tsvfile and converts the data into JavaScript objects (performing basic steps like converting comma-delimited lists into arrays) - src/mapper.ts takes the parsed card data and transforms it to match the interfaces in src/interfaces.ts
- src/writer.ts creates
.tsfiles containing the card information and all types
Bundling the library
To generate the distributed package code run npm run build after transforming the data.