Skip to content

Latest commit

 

History

History
117 lines (77 loc) · 3.16 KB

README.md

File metadata and controls

117 lines (77 loc) · 3.16 KB
Raw

arkham.build

arkham.build is a web-based deckbuilder for Arkham Horror: The Card Game™.

🗺️ Roadmap

Metadata additions

arkham.build extends the arkhamdb deck schema with a few fields for additional functionality.

  • meta.extra_deck: Parallel Jim's spirit deck. Format: comma-separated list of ids "id1,id2,id3".
  • meta.attachments_{code}: cards that are attached to a specific setup deck, for example Joe Diamond or Stick to the Plan. Format: comma-separated list of ids "id1,id2,id2,id3".
  • meta.card_pool: packs that can be used for this deck. Used for limited pool deckbuilding such as #campaign-playalong. Format: "<pack_code>,<pack_code>". For arkham.build, new format pack codes take precedence over old format.
  • meta.sealed_deck: card ids that are pickable for this deck. Used for sealed deckbuilding. Format: comma-separated list of id / quantity pairs in the format "id:2,id:1,...".
  • meta.sealed_deck_name: name of the sealed deck definition used. format: string.
  • meta.transform_into: code of the investigator that this deck's investigator has transformed into. I.e. 04244 for Body of a Yithian.

File formats

Sealed decks

The sealed deck feature expects a csv file in the format:

code,quantity
01039,2
01090,2
06197,2
07032,2

In this example, the sealed deck contains two copies of Deduction, Perception, Practice Makes Perfect and Promise of Power, so users would only be able to add these cards to their deck in the deck builder.

Development

  1. Create an .env file from .env.example.
  2. npm install
  3. npm run dev

API

The API is a separate, private git project hosted as a Cloudflare worker.

Icons

Arkham-related SVG icons are sourced from ArkhamCards's icomoon project and loaded as webfonts. Additional icons are bundled as SVG via vite-plugin-svgr or imported from lucide-react.

Template readme

vite-react-ts-template

extended version of vite's official react-ts template.

additional features:

Install

# install dependencies.
npm i

Develop

npm run dev

Build

npm run build

Test

npm test

# run vitest in watch mode.
npm run test:watch

# collect coverage.
npm run test:coverage

Lint

npm run lint

Format

npm run fmt

Prettier will be run automatically on commit via lint-staged.

Preview

Serves the content of ./dist over a local http server.

npm run preview