32 lines
1.7 KiB
Plaintext
32 lines
1.7 KiB
Plaintext
|
# Deck Template
|
||
|
|
|
||
|
|
This folder is ignored by the deck registry generator.
|
||
|
|
|
||
|
|
Use it as a starter:
|
||
|
|
|
||
|
|
1. Copy `_template` to a new folder under `asset/tarot deck/`.
|
||
|
|
2. Rename the new folder to your deck name.
|
||
|
|
3. Update `deck.json` with your real `id`, `label`, file naming rules, and any name overrides.
|
||
|
|
4. Add your card image files so they match the templates in `deck.json`.
|
||
|
|
5. Run `npm run validate:decks` to check the manifest.
|
||
|
|
6. Run `npm run generate:decks` or `npm run start`.
|
||
|
|
|
||
|
|
Extra examples:
|
||
|
|
- `deck.json` shows a template-driven setup using `trump-template` plus `suit-prefix-and-rank-order`.
|
||
|
|
- `deck.canonical-map.example.json` shows a manually mapped setup using `canonical-map` plus `suit-base-number-template`.
|
||
|
|
- `STRUCTURE.md` shows recommended folder and file layouts for both approaches.
|
||
|
|
|
||
|
|
Naming overrides:
|
||
|
|
- `nameOverrides` is for major-card display names such as `Justice -> Adjustment`.
|
||
|
|
- `minorNameOverrides` is for minor-card display names such as `Six of Cups -> Pleasure`.
|
||
|
|
- `minorNameOverrides` keys should use normal card names like `six of cups`, `princess of disks`, or `10 of swords`.
|
||
|
|
|
||
|
|
Notes:
|
||
|
|
- Folder names starting with `_` or `.` are ignored.
|
||
|
|
- `id` must be unique across all installed decks.
|
||
|
|
- `template`, `templates`, `example`, and `examples` folders are also ignored.
|
||
|
|
- Invalid manifests are skipped during registry generation and reported as warnings in the terminal.
|
||
|
|
- Referenced card image files are audited during generation and validation; decks with missing files are skipped.
|
||
|
|
- Mapped major decks must define all 22 majors, and minor rules must define all 14 ranks.
|
||
|
|
- `npm run validate:decks` exits with a failure code if warnings are found, which is useful before publishing a deck pack.
|