mirror of
https://github.com/mwisnowski/mtg_python_deckbuilder.git
synced 2026-04-05 20:57:16 +02:00
docs: documentation overhaul - archive, user guides, env parity (#62)
Some checks failed
CI / build (push) Has been cancelled
Some checks failed
CI / build (push) Has been cancelled
* docs: archive CLI runner scripts and Windows Docker guide, update web runner scripts * docs: overhaul README and DOCKER.md, add 10 user guides - README: Budget Mode section, corrected Further Reading links, theme badge descriptions, diagnostics expansion - DOCKER.md: Windows path note, Budget Mode + Include/Exclude sections, env table additions - docs/user_guides/: 10 new feature guides covering budget mode, include/exclude, locks/replace/permalinks, batch build, theme browser, random build, owned cards, partner mechanics, bracket compliance, quick build & skip controls * fix: map PriceTimeoutError→503, add budget exceptions to status map; update error_handling.md * docs: env var parity — add missing vars to .env.example and README table
This commit is contained in:
parent
537f5d3834
commit
ac6c9f4daa
21 changed files with 1074 additions and 23 deletions
73
docs/user_guides/locks_replace_permalinks.md
Normal file
73
docs/user_guides/locks_replace_permalinks.md
Normal file
|
|
@ -0,0 +1,73 @@
|
|||
# Locks, Replace & Permalinks
|
||||
|
||||
Core Step 5 tools for refining, sharing, and restoring deck builds.
|
||||
|
||||
---
|
||||
|
||||
## Locks
|
||||
|
||||
Lock cards to pin them in place across reruns. Locked cards are always kept in the deck regardless of theme changes, pool reshuffles, or bracket adjustments.
|
||||
|
||||
### How to Lock
|
||||
- In Step 5, click the lock icon on any card row. The card is immediately locked and visually marked.
|
||||
- Alternatively, click the card name to open its detail panel, then toggle the lock there.
|
||||
|
||||
### Behavior
|
||||
- Locked cards persist when you click **Rebuild** (re-runs the build with the same settings).
|
||||
- Locks are stored in the session and exported to the summary JSON sidecar (`*.summary.json`).
|
||||
- When restoring a deck via permalink, locks are restored alongside the rest of the build state.
|
||||
- Locking has no interaction with Must Include/Exclude lists — a locked card and a must-include card are both always present. Avoid locking a card that is also in Must Exclude.
|
||||
|
||||
### Unlocking
|
||||
Click the lock icon again to unlock. The card re-enters the pool on the next rebuild.
|
||||
|
||||
---
|
||||
|
||||
## Replace
|
||||
|
||||
Swap any card in the current deck for an alternative from the same category pool.
|
||||
|
||||
### How to Use
|
||||
1. In Step 5, enable **Replace mode** (toggle at the top of the card list).
|
||||
2. Click any card to open the **Alternatives panel**.
|
||||
3. Browse or filter alternatives. Toggle **Owned only** to restrict candidates to your uploaded library.
|
||||
4. Click a card in the alternatives panel to swap it in. The replaced card moves out of the deck.
|
||||
5. The replacement is locked automatically to prevent it from being displaced on the next rebuild.
|
||||
|
||||
### Notes
|
||||
- Replace respects category boundaries: land replacements come from the land pool, creature replacements from the creature pool, etc.
|
||||
- Combo-paired cards (flagged in the Combos section of Step 5) will surface a warning if you replace one half of a known combo pair.
|
||||
- Replace history is included in the summary JSON.
|
||||
|
||||
---
|
||||
|
||||
## Permalinks
|
||||
|
||||
Permalinks encode the full build state into a shareable URL so you or anyone else can restore that exact deck later.
|
||||
|
||||
### What a Permalink Encodes
|
||||
- Commander (and partner/background if applicable)
|
||||
- Primary, secondary, and tertiary themes
|
||||
- Bracket selection
|
||||
- Locked cards
|
||||
- Must Include / Must Exclude lists
|
||||
- Budget ceiling (if set)
|
||||
- Build name (if set)
|
||||
|
||||
### Creating a Permalink
|
||||
- In Step 5, click **Copy Permalink**.
|
||||
- From the Finished Decks page, click the permalink icon on any completed build.
|
||||
|
||||
### Restoring from a Permalink
|
||||
1. Click **Open Permalink…** on the homepage or Build a Deck modal.
|
||||
2. Paste the permalink URL or token.
|
||||
3. The builder restores the commander, themes, bracket, locks, and lists, then lands in Step 5 with the saved state ready to rebuild or export.
|
||||
|
||||
### Sharing
|
||||
Permalink URLs are self-contained — no server state is required. Anyone with the URL can restore the build as long as the card data in the application is compatible (same catalog version or later).
|
||||
|
||||
---
|
||||
|
||||
## Combos (Step 5 Panel)
|
||||
|
||||
The Combos section in Step 5 lists known two-card combo pairs detected in the current deck. This is informational — no cards are added or removed automatically. Use locks to preserve combo pairs across rebuilds, or add individual combo cards to Must Include if you want them guaranteed.
|
||||
Loading…
Add table
Add a link
Reference in a new issue