Files
BoneQuest/docs/manual/README.md
T

1.7 KiB

Bone Quest player manual source

BONEQUEST.md is the authoritative plain GFM player manual. manual.json holds the cover/website metadata. images/ contains selected unmodified guest frames; screenshots.json records exact hashes, machine/app configuration and disk identity. The manual is © Brian K. Holman 2026 and GPL-3.0-or-later. Artwork and components retain their own notices; see assets/CREDITS.md and docs/PROVENANCE.md.

Generate the PDF with VCC Plus's shared documentation exporter, not a separate game-specific renderer. From the VCCPlus checkout:

python3 tools/documentation/export_pdf.py prepare /path/to/BoneQuest/docs/manual/BONEQUEST.md \
  --metadata /path/to/BoneQuest/docs/manual/manual.json --toc \
  --destination /path/to/ignored-output/Bone-Quest-Manual.pdf

Inspect every rendered page, caption and link, then run the exporter's publish REVIEW_DIRECTORY --reviewed action. Source/metadata/image/template changes invalidate the review. Generated PDF/review outputs remain outside Git.

The website imports an explicit source snapshot with scripts/import-project-manual.py, slug bone-quest, this Markdown/metadata and the exact reviewed PDF. The shared site layout owns the online presentation and disk/source/PDF actions. The reading route is https://vccplus.brianholman.com/games/bone-quest/ . Import and local PDF export do not publish software or create a VCC Plus app build.

The November 11, 2026 release PDF has 20 pages. All page images were visually reviewed, and the disk/source cover actions and internal contents links were checked. pdf-review.json records the exact PDF, source, metadata and disk hashes. The local reviewed artifact is retained outside Git at test-output/manual-release/Bone-Quest-Manual.pdf.