moved files to Decks/ directory
This commit is contained in:
65
_template/STRUCTURE.md
Normal file
65
_template/STRUCTURE.md
Normal file
@@ -0,0 +1,65 @@
|
||||
# Recommended Deck Layout
|
||||
|
||||
This file shows two practical folder layouts that match the example manifests in this template folder.
|
||||
|
||||
## Option 1: Template-Driven Layout
|
||||
|
||||
Use with `deck.json`.
|
||||
|
||||
```text
|
||||
My Custom Deck/
|
||||
deck.json
|
||||
majors/
|
||||
00.png
|
||||
01.png
|
||||
02.png
|
||||
...
|
||||
21.png
|
||||
minors/
|
||||
wands-01.png
|
||||
wands-02.png
|
||||
...
|
||||
wands-14.png
|
||||
cups-01.png
|
||||
...
|
||||
swords-14.png
|
||||
disks-14.png
|
||||
```
|
||||
|
||||
How it resolves:
|
||||
- Majors use `majors/{number}.png` with `numberPad: 2`
|
||||
- Minors use `minors/{suit}{index}.png`
|
||||
- `suitPrefix.wands = "wands-"` means `Ace of Wands -> minors/wands-01.png`
|
||||
|
||||
## Option 2: Explicit Major Map + Sequential Minors
|
||||
|
||||
Use with `deck.canonical-map.example.json` after renaming it to `deck.json`.
|
||||
|
||||
```text
|
||||
My Mapped Deck/
|
||||
deck.json
|
||||
majors/
|
||||
fool.webp
|
||||
magician.webp
|
||||
high-priestess.webp
|
||||
...
|
||||
world.webp
|
||||
minors/
|
||||
01.webp
|
||||
02.webp
|
||||
03.webp
|
||||
...
|
||||
56.webp
|
||||
```
|
||||
|
||||
How it resolves:
|
||||
- Each major is explicitly mapped in `majors.cards`
|
||||
- Minors use `minors/{number}.webp`
|
||||
- `suitBase` controls where each suit starts in the numbered run
|
||||
|
||||
## Practical Notes
|
||||
|
||||
- Keep file extensions and case consistent with your manifest.
|
||||
- If your deck uses renamed trumps such as `Aeon` or `Universe`, keep the image names aligned with either `nameOverrides` or explicit `cards` mappings.
|
||||
- If your minors have titled names such as `Six of Cups -> Pleasure`, define those in `minorNameOverrides`.
|
||||
- `validate:decks` checks manifest shape, required card coverage, supported modes, and referenced image files.
|
||||
Reference in New Issue
Block a user