The goal of this repository is to store ArkhamDB card data in a format that can be easily updated by multiple people and their changes reviewed.
JSON schema definitions of the different object types can be found in the ./schema
folder. A tool such as JSON Schema Viewer can be used to visualize these schemas.
Full description of (very simple) JSON format can be found here, below there are a few tips most relevant to editing this repository.
When symbols outside the regular ASCII range are needed, UTF-8 symbols come in play. These need to be escaped using \u<4 letter hexcode>
.
To get the 4-letter hexcode of a UTF-8 symbol (or look up what a particular hexcode represents), you can use a UTF-8 converter, such as this online tool.
To have text spanning multiple lines, use \n
to separate them. To have quotes as part of the text, use \"
. For example, "flavor": "\"Winter is Fghghghghfhgh.\"\n-Eddard Stark"
results in following flavor text:
"Winter is Fghghghghfhgh."
-Eddard Stark
These can be used in a card's text
section.
[reaction]
[action]
[free]
[elder_sign]
[skull]
[cultist]
[tablet]
[elder_thing]
[auto_fail]
[curse]
[bless]
[willpower]
[intellect]
[combat]
[agility]
[wild]
[mystic]
[rogue]
[seeker]
[survivor]
[guardian]
[neutral]
[health]
[sanity]
[per_investigator]
[frost]
[seal_a]
[seal_b]
[seal_c]
[seal_d]
[seal_e]
Some cards have a tags
fields that is used to relate these cards to certain deckbuilding rules that are otherwise too hard to parse. When new content is released, tags
need to be reflected on added cards.
The available tags are:
hh
=> Heals horror, used for Carolyn Fern.hd
=> Heals damage, used for Vincent Lee.pa
=> Parley, used for Alessandra Zorzi.se
=> Seals token, used for ||Father Mateo.fa
=> Firearm in card text, used for Michael McGlen.
These tags have been used in the past but are unused right now:
st
=> Spell trait, used to mark whether a card had bonded spells for Marie Lambeau, which is no longer relevant, but still part of the deckbuilding rules.
To merge new changes in default language in all locales, run the CoffeeScript script update_locales
.
Pre-requisites:
node
andnpm
installednpm -g install coffee-script
Usage: coffee update_locales.coffee