cal/mantimon-tcg
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Mantimon TCG - Monster collecting trading card game
38 Commits 2 Branches 0 Tags 20 MiB
TypeScript 46.9%
Python 43.4%
Vue 9.5%
Shell 0.1%
cd8226c4e6
Go to file
Cal Corum cd8226c4e6 Complete LOW-001: Verify comprehensive docstring coverage 
Audit of all 14 core module files confirms they already have
comprehensive Google-style documentation:
- Module docstrings with usage examples
- Class docstrings with Attributes sections
- Method/function docstrings with Args, Returns, Raises

Files verified:
- enums.py, config.py, rng.py
- models/card.py, models/actions.py, models/game_state.py
- effects/base.py, effects/registry.py, effects/handlers.py
- rules_validator.py, turn_manager.py, win_conditions.py
- visibility.py, engine.py

PROJECT_PLAN.json: 32/32 tasks complete - game engine scaffolding done!
2026-01-26 14:55:03 -06:00
backend Complete LOW-001: Verify comprehensive docstring coverage 2026-01-26 14:55:03 -06:00
docs Move legacy docs to project root docs/legacy 2026-01-26 14:19:19 -06:00
AGENTS.md Consolidate CLAUDE.md into AGENTS.md 2026-01-26 14:21:29 -06:00
PROJECT_PLAN.md Add RPG campaign structure inspired by GBC Pokemon TCG 2026-01-24 18:22:36 -06:00

docs/README.md

Mantimon TCG Documentation

Active Documentation

File Description
ARCHITECTURE.md Technical architecture overview covering frontend (Vue+Phaser), backend (FastAPI), database schema, real-time communication, game engine design, and offline fork considerations.
GAME_RULES.md Game rules document defining campaign structure, base ruleset, energy system, deck building, win conditions, turn structure, card types, and status conditions.

Legacy Documentation

Historical documents from completed development phases, preserved for reference.

File Description
legacy/SYSTEM_REVIEW.md Comprehensive code review of the core game engine (Jan 2026). Identified 15 issues across models, effects, and engine - all resolved. 826 tests passing.
legacy/PROJECT_PLAN_ENERGY_EVOLUTION.md Implementation plan for energy/tool attachment refactor and evolution stack system. Changed attached_energy/attached_tools from list[str] to list[CardInstance]. Completed Jan 2026.