mirror of
https://github.com/mwisnowski/mtg_python_deckbuilder.git
synced 2025-12-16 07:30:13 +01:00
document deck summary DFC badges, exporter annotations, and per-face metadata across README/DOCKER/release notes record completion of all MDFC roadmap follow-ups and add the authoring guide for multi-face CSV entries wire in optional DFC_PER_FACE_SNAPSHOT env support, exporter regression tests, and diagnostics updates noted in the changelog
2.7 KiB
2.7 KiB
Card Authoring Guide
This guide captures the conventions used by the deckbuilder when new cards are added to the CSV inputs. Always validate your edits by running the fast tagging tests or a local build before committing changes.
Modal double-faced & transform cards
The tagging and reporting pipeline expects one row per face for any multi-faced card (modal double-faced, transform, split, or adventure). Use the checklist below when adding or updating these entries:
- Canonical name — Keep the
namecolumn identical for every face (e.g.,Valakut Awakening // Valakut Stoneforge). Individual faces should instead setface_namewhen available; the merger preserves front-face copy for downstream consumers. - Layout & side — Populate
layoutwith the value emitted by Scryfall (modal_dfc,transform,split,adventure, etc.) and include asidecolumn (a,b, …). The merger usessideordering when reconstructing per-face metadata. - Mana details — Supply
mana_cost,mana_value, andproduces_manafor every face. The per-face land snapshot and deck summary badges rely on these fields to surface the “DFC land” chip and annotated mana production. - Type line accuracy — Ensure
type_lineincludesLandfor any land faces. The builder counts a card toward land totals when at least one face includesLand. - Tags & roles — Tag every face with the appropriate
themeTags,roleTags, andcard_tags. The merge stage unions these sets so the finished card retains all relevant metadata. - Commander eligibility — Only the primary (
side == 'a') face is considered for commander legality. If you add a new MDFC commander, double-check that the front face satisfies the Commander rules text; otherwise the record is filtered during catalog refresh. - Cross-check exports — After the card is added, run a local build and confirm the deck exports include the new
DFCNotecolumn entry for the card. The annotation summarizes each land face so offline reviewers see the same guidance as the web UI.
Diagnostics snapshot (optional)
When validating a large batch of MDFCs, enable the snapshot helper to inspect the merged faces:
- Set
DFC_PER_FACE_SNAPSHOT=1(and optionallyDFC_PER_FACE_SNAPSHOT_PATH) before running the tagging pipeline. - Disable parallel tagging (
WEB_TAG_PARALLEL=0) while the snapshot is active; the helper only writes output during sequential runs. - Once tagging completes, review
logs/dfc_per_face_snapshot.jsonfor the card you added to verify mana fields,produces_mana, and land detection flags.
Following these guidelines keeps the deck summary badges, exporter annotations, and diagnostics snapshots in sync for every new double-faced card.