Skip to content

Latest commit

 

History

History
155 lines (136 loc) · 15.4 KB

csv-schemas.md

File metadata and controls

155 lines (136 loc) · 15.4 KB

CSV Schemas

The CSVs are tab delimited and use " as string indicators.

Ability

Field Name Intended Data Type Explanation Example
Unique ID string The unique identifier for this ability within the data set. This is generated by a script, do not manually fill this out in the English CSV. Other languages' CSVs should use the same IDs as the corresponding keyword in the English CSV. HCCWPfFrNzCwPDntPw6gH
Name string Name of the type. Attack

Artist

Field Name Intended Data Type Explanation Example
Name string Name of the artist. Saad Irfan

Card

Note: Non-English CSVs only use a subset of these fields (the ones that need to be translated)

Field Name Intended Data Type Explanation Example
Unique ID string The unique identifier for this card within the data set. This is generated by a script, do not manually fill this out. nM8BHGHd9qLGTPgwtWzkJ
Name string The name of the card. (Do not include pitch here.) Whelming Gustwave
Pitch int | null The pitch value of the card. Either a numerical value or empty for cards with no pitch value. 1
Cost int | string | null The cost of the card. Either a numerical cost, a text cost for special cases like 'XX', or empty for cards with no cost value (ex: Eye of Ophidia). 0
Power int | string | null The power value of the card. Either a numerical value, a text cost for special cases like '*', or empty for cards with no power. 3
Defense int | string | null The defense value of the card. Either a numerical value, a text cost for special cases like '*', or empty for cards with no defense. 3
Health int | null The health of the (hero) card. Either a numerical value or empty for cards with no health. 40
Intelligence int | null The intelligence of the (hero) card. Either a numerical value or empty for cards with no intelligence. 4
Types string[] The types of the card (main type, sub type, talent, etc). See below for a list of possible types. Action, Attack, Ninja
Card Keywords string[] Any keywords that appear on the card's effect. See below for a list of possible keywords. (Include keywords that are conditionally granted to the card, but not keywords the card grants or removes from other cards, keywords the card interacts with, or keywords on the card's abilities or effect's.) Combo, Go again
Abilities and Effects string[] A list of any types of abilities or effects the card has. (Include just the type, not the actual ability or effect.) Once per Turn Action, Instant
Ability and Effect Keywords string[] A list of any keywords the card's abilities or effects have. (Do not include keywords the card grants or removes from other cards.) Attack, Go again
Granted Keywords string[] A list of keywords that the card grants (conditionally or unconditionally) to other cards. Dominate
Removed Keywords string[] A list of keywords that the card removes (conditionally or unconditionally) from other cards. Phantasm
Interacts with Keywords string[] A list of keywords that the card interacts with. Essentially a catch-all for keyword usage outside of granted/removed keywords. Stealth
Functional Text string The functional text that effects gameplay. Use the text from the latest printing or errata. Use Markdown for bold, italic, etc., and use the list of game icon representations below for representing attack icons, defense icons, etc. Combo - If Surging Strike was the last attack this combat chain, Whelming Gustwave gains +1{p}, go again, and "If this hits, draw a card."
Type Text string The type text as printed on the latest edition of the card. Ninja Action - Attack
Card Played Horizontally bool Is the card played horizontally (Ex: Landmarks)? No value is considered No. Yes
Blitz Legal bool Is the card initially legal in the Blitz format? No given value is considered Yes. Yes
CC Legal bool Is the card initially legal in the Classic Constructed format? No given value is considered Yes. Yes
Commoner Legal bool Is the card initially legal in the Commoner format? No given value is considered Yes. Yes

Note: Cards in are organized by what main set they were initially released in in that language, in order of release. If they were never released in a main set, they are organized by non-set/promo in order of release, with non-set/promo cards above main set cards.

Card Printing

Field Name Intended Data Type Explanation Example
Unique ID string The unique identifier for this card printing within the data set. This is generated by a script, do not manually fill this out. qkzD8rHMJQ8KfLDnrWqfp
Card Unique ID string The unique identifier for the card within the data set that this card printing is a printing of. nM8BHGHd9qLGTPgwtWzkJ
Card Name string The name the card within the data set that this card printing is a printing of. This is just used to make readibility of the CSV a little bit easier, and is not used or verified in any way. Blazing Aether
Card Pitch string The pitch value of the card within the data set that this card printing is a printing of. This is just used to make readibility of the CSV a little bit easier, and is not used or verified in any way. 1
Card ID string The identifiers for the card's various printings. Order them in this order: set (order of release), non-set (order of release), promo (alphabetically). WTR110, KSU016, LGS007
Set Printing Unique ID string The unique identifier for the set printing within the data set that this card printing belongs to. rW8hnzQk9DFq89t6Gm9cH
Set ID string The set identifier for this card printing. WTR
Edition string The edition for this card printing. U
Rarity string The rarity for this card printing. C
Foiling string The foiling for this card printing. R
Art Variation string The art variation (if any) of this card printing. The Collector's Center has good resources for finding details on this. AA
Artist string The artist of this card printing. Agri Karuniawan
Flavor Text string The flavor text (if any) that appears on this card printing. Do not use italics on this, text is assumed to be in italics. (Example pulled from Talisman of Warfare.) It's said that wherever the Dracai of War planted this talisman, the lava was soon to flow.
Image URL string Link to the image of the card printing from fabtcg.com's image galleries. https://storage.googleapis.com/fabmaster/media/images/ELE146.width-450.png
TCGPlayer ID string The product ID of the card printing on TCGPlayer 225537

Card Face Association

Field Name Intended Data Type Explanation Example
Front Card Printing Unique ID string The unique identifier for the card that is on the front of the double-sided card. This corresponds to the Unique ID field in the Card CSV. cJtC9QKfTGBtdJngJfgd6
Front Card Name string Name of the card that is on the front of the double-sided card. This field is purely for readability when maintaining the CSV and to help scripts verify data integrity, and is not used when generated JSON data. Invoke Tomeltai
Front Card Printing string Variatio data for the card that is on the front of the double-sided card. This field is purely for readability when maintaining the CSV and to help scripts verify data integrity, and is not used when generated JSON data. UPR007 – N
Back Card Printing Unique ID string The unique identifier for the card that is on the back of the double-sided card. This corresponds to the Unique ID field in the Card CSV. QNkHgfg9hDrqFh6jqzQK6
Back Card Name string Name of the card that is on the back of the double-sided card. This field is purely for readability when maintaining the CSV and to help scripts verify data integrity, and is not used when generated JSON data. Tomeltai
Back Card Printing string Variatio data for the card that is on the back of the double-sided card. This field is purely for readability when maintaining the CSV and to help scripts verify data integrity, and is not used when generated JSON data. UPR007 – N

Card References

Field Name Intended Data Type Explanation Example
Card Unique ID string The unique identifier for the card that is referencing another card. r9GQj9McpQbr8Jf9jhkch
Card Name string Name of the card that is referencing another card. This field is purely for readability when maintaining the CSV and to help scripts verify data integrity, and is not used when generated JSON data. Predatory Streak
Card Pitch string Pitch of the card that is referencing another card. This field is purely for readability when maintaining the CSV and to help scripts verify data integrity, and is not used when generated JSON data. 1
Referenced Card Unique Id string The unique identifier for the card that is being referenced. cJtC9QKfTGBtdJngJfgd6
Referenced Card Name string Name of the card that is being referenced. This field is purely for readability when maintaining the CSV and to help scripts verify data integrity, and is not used when generated JSON data. Crouching Tiger
Referenced Card Pitch string Pitch of the card that is being referenced. This field is purely for readability when maintaining the CSV and to help scripts verify data integrity, and is not used when generated JSON data.

Edition

Field Name Intended Data Type Explanation Example
Shorthand string Shorthand representation of the edition. U
Name string Name of the edition. Unlimited Edition

Foiling

Field Name Intended Data Type Explanation Example
Shorthand string Shorthand representation of the foiling. R
Name string Name of the foiling. Rainbow Foil

Icon

Field Name Intended Data Type Explanation Example
Shorthand string Shorthand representation of the icon, intended for representing the icon in effect text and correlating between other CSVs. When displaying text in an app, search for this to replace with the actual icon. {p}
Name string Name of the icon. Attack
Image URL string Url to the icon. TODO

Keyword

Field Name Intended Data Type Explanation Example
Unique ID string The unique identifier for this keyword within the data set. This is generated by a script, do not manually fill this out in the English CSV. Other languages' CSVs should use the same IDs as the corresponding keyword in the English CSV. 77JKJwz6k8BRrGbmRDPTT
Name string Name of the keyword. Battleworn
Description string Description of the keyword's meaning. TODO

Legality (CC / Blitz / Commoner / UPF)

Field Name Intended Data Type Explanation Example
Unique ID string The unique identifier for this legality change entry within the data set. This is generated by a script, do not manually fill this out in the English CSV. 77JKJwz6k8BRrGbmRDPTT
Card Unique ID string The unique identifier for the card that is having its legality changed. This corresponds to the Unique ID field in the Card CSV. CtgLqKpjrGRtLnwbHjd9f
Card Name string The name of the card having its legality changed. This field is purely for readability when maintaining the CSV and to help scripts verify data integrity, and is not used when generated JSON data. Belittle
Card Pitch int | null The pitch value of the card having its legality changed. Either a numerical value or empty for cards with no pitch value. This field is purely for readability when maintaining the CSV and to help scripts verify data integrity, and is not used when generated JSON data. 1
Status Active string Represents whether the current status the CSV represents is active or not. For example, when a card becomes banned or suspended, the value should be "Yes". If a card is unbanned or unsuspended, the value should be "No". Yes
Date Announced datetime The date the new legality was announced on. 2023-01-24T00:00:00.000Z
Date In Effect datetime The date the new legality will go into effect on. 2023-01-30T00:00:00.000Z
Planned End string NOTE: This field is only available on suspension legality CSVs. Info on when the card is planned to be unsuspended in the given format. Until Iyslander becomes Living Legend
Legality Article string The URL to the article detailing this change. https://fabtcg.com/articles/banned-and-suspended-announcement/

Rarity

Field Name Intended Data Type Explanation Example
Shorthand string Shorthand representation of the rarity, intended for quick typing and correlating between other CSVs. M
Text string Full name of the rarity. Majestic

Set

Field Name Intended Data Type Explanation Example
Unique ID string The unique identifier for this set within the data set. This is generated by a script, do not manually fill this out unless you are ensuring consistency between different language entries for the same set. K8MGfzFdqWGwrcJgpDqRR
Identifier string The set code. WTR
Name string The full name of the set. Welcome to Rathe

Set Printing

Field Name Intended Data Type Explanation Example
Unique ID string The unique identifier for this set printing within the data set. This is generated by a script, do not manually fill this out. rW8hnzQk9DFq89t6Gm9cH
Set Unique ID string The unique identifier for the set within the data set that this set printing is a printing of. K8MGfzFdqWGwrcJgpDqRR
Edition string The edition of the set printing. Alpha
Start Card Id string The id of the first card in the set printing. WTR000
End Card Id string The id of the first card in the set printing. WTR225
Initial Release Date datetime The initial release date for the set in ISO 8601 format and UTC timezone. 2019-10-11T00:00:00.000Z
Out of Print Date datetime The Out of Print (OOP) announcement date for the set in ISO 8601 format and UTC timezone. If the set is still in print, use null instead of a date. 2019-10-11T00:00:00.000Z
Product Page string The URL for the fabtcg.com product page of the set printing. https://fabtcg.com/products/booster-set/welcome-rathe/
Collector's Center string The URL for the fabtcg.com collector's center page. https://fabtcg.com/collectors-centre/welcome-rathe/
Card Gallery string The URL for the fabtcg.com card gallery page. https://fabtcg.com/resources/card-galleries/welcome-rathe-booster/

Type

Field Name Intended Data Type Explanation Example
Unique ID string The unique identifier for this type within the data set. This is generated by a script, do not manually fill this out in the English CSV. Other languages' CSVs should use the same IDs as the corresponding keyword in the English CSV. FwdBrBrwHWcPN78TcRCMT
Name string Name of the type. Attack