mtg_python_deckbuilder/CHANGELOG.md

10 KiB
Raw Blame History

Changelog

All notable changes to this project will be documented in this file.

This format follows Keep a Changelog principles and aims for Semantic Versioning.

How we version

  • Semantic Versioning: MAJOR.MINOR.PATCH (e.g., v1.2.3). Pre-releases use -alpha/-beta/-rc.
  • Tags are created as vX.Y.Z on the default branch; releases and Docker images use that exact version and latest.
  • Change entries prefer the Keep a Changelog types: Added, Changed, Fixed, Removed, Deprecated, Security.
  • Link PRs/issues inline when helpful, e.g., (#123) or [#123]. Reference-style links at the bottom are encouraged for readability.

[Unreleased]

[2.1.1] - 2025-08-29

Added

  • Multi-copy archetypes (Web): opt-in modal suggests packages like Persistent Petitioners, Dragon's Approach, and Shadowborn Apostle when viable; choose quantity and optionally add Thrumming Stone. Applied as the first stage with ideal count adjustments and a per-stage 100-card safety clamp. UI surfaces adjustments and a clamp chip.

Changed

  • Multi-copy modal now appears immediately after commander selection (pre-build) in Step 2. This reduces surprise and lets users make a choice earlier.
  • Stage order updated so the Multi-Copy package is applied first in Step 5, with land steps following on the next Continue. Lands now account for the package additions when filling.

Fixed

  • Ensured apostrophes in multi-copy card names remain safe in templates while rendering correctly in the UI.

[2.0.1] - 2025-08-28

Added

  • Web UI performance: optional virtualized grids/lists in Step 5 and Owned (enable with WEB_VIRTUALIZE=1).
  • Virtualization diagnostics overlay (when SHOW_DIAGNOSTICS=1); press v to toggle pergrid overlays and a global summary bubble with visible range, totals, render time, and counters.
  • Image polish: lazyloading with responsive srcset/sizes and LQIP blur/fadein for Step 5 and Owned thumbnails and the commander preview image.
  • ShortTTL fragment caching for template partials (e.g., finished deck summaries and config run summaries) to reduce rerender cost.
  • Web UI: FastAPI + Jinja front-end for the builder; staged build view with per-stage reasons
  • New Deck modal consolidating steps 13 with optional Name for exports, Enter-to-select commander, and disabled browser autofill
  • Locks, Replace flow, Compare builds, and shareable permalinks for finished decks
  • Compare page: Copy summary action to copy diffs (Only in A/B and Changed counts) to clipboard
  • Finished Decks multi-select → Compare with fallback to "Latest two"; options carry modified-time for ordering
  • Permalinks include locks; global "Open Permalink…" entry exposed in header and Finished Decks
  • Replace flow supports session-local Undo and lock-aware validation
  • New Deck modal: inline summary of selected themes with order (1, 2, 3)
  • Theme combine mode (AND/OR) with tooltips and selection-order display in the Web UI
  • AND-mode creatures pre-pass: select "all selected themes" creatures first, then fill by weighted overlap; staged reasons show matched themes
  • Scryfall attribution footer in the Web UI
  • Owned-cards workflow:
    • Prompt (only if lists exist) to "Use only owned cards?"
    • Support multiple file selection; parse .txt (1 per line) and .csv (any name column)
    • Owned-only mode filters the pool to owned names; commander exempt
    • Recommendations export when owned-only deck is incomplete (~1.5× missing) to deck_files/[stem]_recommendations.csv and .txt
  • CSV export includes an Owned column when not using owned-only
  • Windows EXE build via PyInstaller is produced on tag and attached to GitHub Releases
  • Prefer-owned option in Review: bias selection toward owned cards while allowing unowned fallback (stable reorder + gentle weight boosts applied across creatures and spells)
  • Owned page enhancements: export TXT/CSV, sort controls, live "N shown," color identity dots, exact color-identity combo filters (incl. 4-color), viewport-filling list, and scrollbar styling
  • Finished Decks: theme filters converted to a dropdown with shareable state
  • Staged build: optional "Show skipped stages" toggle to surface stages that added no cards with a clear annotation
  • Owned/Not-owned badges visible across views; consolidated CSS for consistent placement
  • Visual summaries: Mana Curve, Color Pips and Sources charts with cross-highlighting to cards; tooltips show per-color card lists and include a Copy action
  • Source detection: include non-land mana producers and colorless 'C'; basic lands reliably counted; fetch lands excluded as sources
  • Favicon support: /favicon.ico served (ICO with PNG fallback)
  • Diagnostics: /healthz endpoint returns {status, version, uptime_seconds}; responses carry X-Request-ID; unhandled errors return JSON with request_id
  • Diagnostics page and tools gated by SHOW_DIAGNOSTICS; Logs page gated by SHOW_LOGS; both off by default
  • Global error handling: friendly HTML templates for 404/4xx/500 with Request-ID and "Go home" link; JSON structure for HTMX/API
  • Request-ID middleware assigns X-Request-ID to all responses and includes it in JSON error payloads
  • /status/logs?tail=N endpoint (read-only) to fetch a recent log tail for quick diagnostics
  • Tooltip Copy action on chart tooltips (Pips/Sources) for quick sharing of per-color card lists
  • Theme UX: Header includes a Reset Theme control to clear browser preference and reapply server default (THEME) or system mapping. Diagnostics page shows resolved theme and stored preference with a reset action.

Roadmap and usage for Web UI features are tracked in logs/web-ui-upgrade-outline.md.

Changed

  • Accessibility: respect OS “reduced motion” by disabling blur/fade transitions and smooth scrolling.
  • Static asset caching and compression tuned for the web service (cache headers + gzip) to improve load performance.
  • Rename folder from card_library to owned_cards (env override: OWNED_CARDS_DIR; back-compat respected)
  • Docker assets and docs updated:
    • New volume mounts: ./owned_cards:/app/owned_cards and ./config:/app/config
    • Compose and helper scripts updated accordingly
  • Release notes source is RELEASE_NOTES_TEMPLATE.md; RELEASE_NOTES.md ignored
  • README/DOCKER/WINDOWS_DOCKER_GUIDE updated for Web UI, headless examples, and PowerShell-friendly commands
  • Headless: tag_mode (AND/OR) accepted from JSON and environment and exported in interactive run-config JSON
  • Owned lists are enriched at upload-time and persisted in an internal store; header rows skipped and duplicates deduped; per-request parsing removed
  • Builder Review (Step 4): "Use only owned cards" toggle moved here; Step 5 is status-only with "Edit in Review" for changes
  • Minor UI/CSS polish and consolidation across builder/owned pages
  • Deck summary reporting now includes colorless 'C' in totals and cards; UI adds a Show C toggle for Sources
  • New Deck modal submits directly to build, removing the intermediate review step
  • Finished Decks banner and lists now prefer the custom Name provided in the modal
  • Step 5 Replace toggle now includes a tooltip clarifying that reruns will replace picks in that stage when enabled
  • Locks are enforced on rerun; the Locked section live-updates on unlock (row removal and chip refresh)
  • Compare page shows ▲/▼ indicators on Changed counts and preserves the "Changed only" toggle across interactions
  • Bracket selector shows numbered labels (e.g., "Bracket 3: Upgraded") and defaults to bracket 3 on new deck creation
  • List view highlight polished to wrap only the card name (no overrun of the row)
  • Total sources calculation updated to include 'C' properly
  • 404s from Starlette now render the HTML 404 page when requested from a browser (Accept: text/html)
  • Owned page UX: full-size preview now pops on thumbnail hover (not the name); selection highlight tightened to the thumbnail only and changed to white for better contrast; Themes in the hover popout render as a larger bullet list with a brighter "THEMES" label
  • Image robustness: standardized data-card-name on all Scryfall images and centralized retry logic (thumbnails + previews) with version fallbacks (small/normal/large) and a single cache-bust refresh on final failure; removed the previous hover-image cache to reduce complexity and overhead
  • Layout polish: fixed sidebar remains full-height under the banner with a subtle right-edge shadow for depth; grid updated to prevent content squish; extra scroll removed; footer pinned when content is short.
  • Deck Summary list view: rows use fixed tracks for count, ×, name, and owned columns (monospace tabular numerals) to ensure perfect alignment; highlight is an inset box-shadow on the name to avoid layout shifts; long names ellipsize with a tooltip; list starts directly under the type header and remains stable on full-screen widths

Fixed

  • Docker Hub workflow no longer publishes a major.minor tag (e.g., 1.1); only full semver (e.g., 1.2.3) and latest
  • Owned page internal server error resolved via hardened template context and centralized owned context builder
  • Web container crash resolved by removing invalid union type annotation in favicon route; route now returns a single Response type
  • Source highlighting consistency: charts now correctly cross-highlight corresponding cards in both list and thumbnail views
  • Basics handling: ensured basic lands and Wastes are recognized as sources; added fallback oracle text for basics in CSV export
  • Fetch lands are no longer miscounted as mana sources
  • Web 404s previously returned JSON to browsers in some cases; now correctly render HTML via a Starlette HTTPException handler
  • Windows PowerShell curl parsing issue documented with guidance in README
  • Deck summary alignment issues in some sections (e.g., Enchantments) fixed by splitting the count and the × into separate columns and pinning the owned flag to a fixed width; prevents drift across responsive breakpoints
  • Banned list filtering applied consistently to all color/guild CSV generation paths with exact, case-insensitive matching on name/faceName (e.g., Hullbreacher, Dockside Extortionist, and Lutri are excluded)

For prior releases, see the GitHub Releases page.