37 lines
1.4 KiB
Markdown
37 lines
1.4 KiB
Markdown
|
## Deck Repository (Install Ready)
|
||
|
|
|
||
|
|
Use this companion repository for downloadable decks:
|
||
|
|
|
||
|
|
- https://code.glowers.club/goyimnose/tarot-deck
|
||
|
|
|
||
|
|
Typical flow:
|
||
|
|
|
||
|
|
1. Clone the deck repository somewhere local.
|
||
|
|
2. Copy one or more deck folders into `asset/tarot deck/`.
|
||
|
|
3. Validate and regenerate the deck registry.
|
||
|
|
|
||
|
|
```powershell
|
||
|
|
git clone https://code.glowers.club/goyimnose/tarot-deck.git
|
||
|
|
# Copy selected deck folder(s) into Tarot Time deck directory.
|
||
|
|
npm run validate:decks
|
||
|
|
npm run start
|
||
|
|
```
|
||
|
|
|
||
|
|
## Deck Authoring and Validation
|
||
|
|
|
||
|
|
Deck discovery is registry-driven and generated automatically.
|
||
|
|
|
||
|
|
1. Copy `asset/tarot deck/_template/` to a new folder under `asset/tarot deck/`.
|
||
|
|
2. Rename the new folder and update its `deck.json`.
|
||
|
|
3. Add card image files matching the naming rules in the manifest.
|
||
|
|
4. Run `npm run validate:decks` before publishing/testing.
|
||
|
|
5. Run `npm run start` (or `npm run generate:decks`) to rebuild `asset/tarot deck/decks.json`.
|
||
|
|
|
||
|
|
Rules and behavior:
|
||
|
|
|
||
|
|
- Folders without `deck.json` are ignored.
|
||
|
|
- Folders beginning with `_` or `.` are ignored (safe for `_template`).
|
||
|
|
- `_template` includes `deck.canonical-map.example.json` for explicit major-card file mapping.
|
||
|
|
- `_template/STRUCTURE.md` documents recommended `majors/` and `minors/` layouts.
|
||
|
|
- Manifests may override labels with `nameOverrides` and `minorNameOverrides`.
|
||
|
|
- Invalid manifests or missing mapped files are skipped with terminal warnings.
|