Document the fishing minigame and milestone system in README - #117
Conversation
The Features section covered selling fish, housing, and investments but never described the actual fishing mechanic (reaction timing, rod level, time-of-day/weather modifiers, species rarity) or the milestone/achievement system, even though both are core, fully-implemented gameplay. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
|
Self-review rubric:
Repo-specific rubric (all N/A — no source files changed in this PR):
Every factual claim in the new copy was traced to source before writing: energy cost/minimum from Summary: docs-only PR closing a real gap (two fully-implemented, tested gameplay systems — the fishing minigame and milestones — were undocumented in README's Features section). No code paths touched, so no regression risk; CI green. |
Summary
%d-on-float formatting bugs — the repo is in a clean, well-covered state (351 tests passing).src/achievements/achievements.py) — both fully implemented and tested, but entirely absent from player-facing docs.FishingandMilestones, matching the doc's existing tone and em-dash style. Every claim was verified againstsrc/location/docks.py,src/fish/fish.py, andsrc/achievements/achievements.pybefore writing (e.g. the 10-energy-per-hour cost and 10-energy minimum to start matchfish()'shasEnergy/spendEnergycalls; the "announced once, even across reloads" claim matchesgetNewlyEarned's use of the persistedstats.earnedMilestones).PLANNING.md'sFISH LOADING BAIT PRICE BUGgoal note was investigated but left untouched — no corresponding bug was found inpriceForBaitload/save/display code (schema,PlayerJsonReaderWriter, and shop display all use%.2fcorrectly), and the note isn't specific enough to act on without guessing; left as-is rather than fabricating a fix under a docs-only cycle.Test plan
python3 -m compileall -q srcNo tracking issue — gap found during this cycle's documentation sweep (Phase 2, Stage A).