Files
mtg-builder/README.md
2026-02-20 00:21:45 +01:00

96 lines
2.4 KiB
Markdown

# MTG EDH Deck Manager
Command-line toolkit for managing Magic: The Gathering Commander (EDH) decks using the Scryfall API.
## Installation
```bash
git clone <repo-url>
cd Decks
# Install git hook for auto-updating docs
cp scripts/pre-commit .git/hooks/pre-commit
chmod +x .git/hooks/pre-commit
```
No dependencies required - pure Python 3 standard library.
## Usage
### Hydrate a Collection
Fetch card data from Scryfall for a decklist:
```bash
python hydrate.py hydrate collection/decklist.txt -o collection_hydrated/ -c card_cache.json
```
### Create a New Deck
```bash
python hydrate.py new my_deck
```
### Analyze Decks
Find upgrade options from your collection:
```bash
python scripts/analyze_decks.py --collection collection_hydrated/deck.json --deck-dir decks/
```
### Find Synergies
Search for cards by keywords, colors, and type:
```bash
# Find landfall cards in Simic colors
python scripts/find_synergies.py --collection collection_hydrated/deck.json --colors U G --keywords landfall
# Find Bird creatures in Bant colors
python scripts/find_synergies.py --collection collection_hydrated/deck.json --colors U G W --creature-type Bird
# Find instants with CMC 2 or less
python scripts/find_synergies.py --collection collection_hydrated/deck.json --type instant --cmc-max 2
```
### Generate Reports
```bash
python scripts/deck_report.py --collection collection_hydrated/deck.json --decks-dir decks/ --output report.md
```
## Decks
| Deck | Colors | Commander | Archetype |
|------|--------|-----------|-----------|
| Choco | UGW | Choco, Seeker of Paradise | Bird Tribal Landfall |
| Hazel | BG | Hazel of the Rootbloom | Golgari Aristocrats |
| Palamecia | UR | The Emperor of Palamecia // The Lord Master of Hell | Izzet Self-Mill Storm |
| Yshtola | UBW | Y'shtola, Night's Blessed | Esper Stax Drain |
## Workflow
1. **Import** - Place text decklists in `collection/`
2. **Hydrate** - Run `hydrate.py` to fetch Scryfall data → `collection_hydrated/`
3. **Define** - Create deck JSON files in `decks/`
4. **Analyze** - Run `analyze_decks.py` to find upgrade options
5. **Report** - Use `deck_report.py` for markdown summaries
## Collection Stats
- **Total cards:** 1209
- **Unique cards:** 866
- **By type:**
- Artifacts: 84
- Creatures: 390
- Enchantments: 63
- Instants: 124
- Lands: 97
- Planeswalkers: 2
- Sorceries: 105
---
*This file is auto-generated. Edit `docs/templates/README.template.md` instead.*