Skip to content

About

JSON formatted data for the ArkhamDB deckbuilder

Resources

Stars

8 stars

Watchers

0 watching

Forks

 
 

Repository files navigation

ArkhamDB cards JSON data

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.

Data schemas

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.

JSON text editing tips

Full description of (very simple) JSON format can be found here, below there are a few tips most relevant to editing this repository.

Non-ASCII symbols

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.

Quotes and breaking text into multiple lines

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

Arkham LCG Game Symbols

These can be used in a card's text section.

  • [reaction]
  • [action]
  • [fast]
  • [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]
  • [blood]
  • [seal_a]
  • [seal_b]
  • [seal_c]
  • [seal_d]
  • [seal_e]

Card tags

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.

Numerical values

Numerical values in the game can sometimes contain symbols such as - or X. Historically, consumers of this data expect these values to be number | null, so we have to use an enumeration to represent special characters. The following mappings are defined:

  • 0 and higher: literal integers.
  • null: -
  • X: -2
  • *: -3
  • ?: -4

Translations

The reference language is the English language. All files in English are in the pack directory (some shared concepts have files at the root directory, like packs.json or factions.json)

Translations files are in the translations/<language_code>/pack directories

Pre-requisites

  1. Install node.js

This will install both the node and npm (node package manager) binaries you can use from the command-line

  1. Install this project dependencies using npm install in this repository

Updating translation files

When there are new English files or new cards added to existing English files, we may want to update the translation files. To merge new changes in default language in all locales, run: npm run update-locales

To merge new changes in a specific locale, run: npm run update-locales <locale> (where <locale> is the directory name where translations for this language are).

For example, for French, run: npm run update-locales fr
For Korean, run: npm run update-locales ko etc.

About

JSON formatted data for the ArkhamDB deckbuilder

Resources

Stars

8 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages