Files
Quadrapassel/docs/manual/README.md
T

2.1 KiB

Quadrapassel player manual source

QUADRAPASSEL.md is the plain GFM source for the online and PDF player guide. manual.json supplies its shared cover/hero metadata. images/ contains 17 unchanged guest-framebuffer PNGs; screenshots.json records their hashes, configuration and public capture receipts. The scoreboard example is AAA / 40 / Modern, difficulty 0 / Normal.

The manual is © Brian K. Holman 2026, GNU GPL-3.0-or-later. Preserve the exact spaced copyright wording in the manuscript/metadata and component acknowledgements. The game source remains the independent, specification-based CoCo implementation; see ../PROVENANCE.md for its behavioral references and GPL-derived data.

Generate and review the PDF

Use the shared VCCPlus process, not a project-specific PDF generator. From the VCCPlus checkout, substitute the actual selected paths:

python3 tools/documentation/export_pdf.py prepare /path/to/Quadrapassel/docs/manual/QUADRAPASSEL.md \
  --metadata /path/to/Quadrapassel/docs/manual/manual.json --toc \
  --destination /path/to/Quadrapassel/test-output/manual/Quadrapassel-for-CoCo-Manual.pdf

Inspect every page PNG in the printed review directory, then use the shared tool's publish REVIEW_DIRECTORY --reviewed command. Source, metadata, image and template changes invalidate that review. Generated PDFs/review images stay under ignored output folders. The source Markdown remains authoritative.

Import and publish the online edition

VCCPlusWebsite owns the shared online layout and its authorized static publisher. Use its scripts/import-project-manual.py with this selected Markdown/metadata, slug quadrapassel, and the fully reviewed final PDF. The imported snapshot makes the website independent of this checkout. Review desktop/narrow layouts, run the website checks and use its existing publish/dry-run/verification flow. No game disk, app binary, update feed, native settings or personal score file is published or modified by these documentation operations.

Current route: https://vccplus.brianholman.com/games/quadrapassel/ . The game build remains 05; documentation alone does not create build 06.