Files
Quadrapassel/docs/PROVENANCE.md
T
Brian Holman 2e163049d1 Fix joystick fire ghost keys and independent axis arming
Filter keyboard rows grounded by joystick buttons before processing actions,
preventing right fire from acting as A/D/E and undoing its release rotation.
Arm X and Y independently so an uncentered vertical axis cannot block steering.

Reproduce both defects in host regressions, retain ordinary CMOC input APIs,
and update official project membership. Compact unchanged display data and make
render profiling optional to preserve the original memory and stack bounds.

Deliver QUADPSL02.DSK with fresh scores. Retire the old artifact from tracking
while leaving the loaded local disk untouched. Host suites, official Release
build and MC6809/512 KB keyboard/audio smoke checks pass. Actual joystick-port
confirmation and the reported normal-window buzz remain pending.
2026-11-11 13:27:18 -07:00

117 lines
6.6 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# Provenance and permitted use of reference material
## Behavioral reference
The specification was prepared from Brian Holman's
[Quadrapassel macOS fork](https://github.com/bkholman/quadrapassel-macos), revision
`be8769a403e506edb930372f963a9c4c83a0881e` ("Update references for
quadrapassel-macos repository"). Its upstream is
[GNOME Quadrapassel](https://gitlab.gnome.org/GNOME/quadrapassel).
Files reviewed for the specification include `src/game.vala`,
`src/game-view.vala`, `src/quadrapassel.vala`, `src/style.css`,
`data/org.gnome.Quadrapassel.gschema.xml`, `tests/test-scoring.vala`,
`tests/test-scoreboard.vala`, `README.md` and `COPYING`.
Their observed SHA-256 values are in [reference/source-manifest.json](reference/source-manifest.json).
The 28 piece states in [pieces.json](reference/pieces.json) were extracted from
`BLOCK_TABLE` in `src/game.vala` without changing positions or state order.
The numeric cases in [scoring.json](reference/scoring.json) express the reference
scoring rules and regression expectations, including new-level multiplication.
These files are data for the new implementation, not a bundled Vala application.
The implementation chat is intentionally restricted to this self-contained
specification and allowed public/reference material. The source links and hashes
above preserve attribution; they do not authorize that chat to inspect the Mac
source or its development chat. This is a black-box boundary around the emulator
and a specification-based implementation workflow, not a claim of legally
independent provenance from the GPL game.
## Credits and licensing
The reference application is **GPL-3.0-or-later**. `COPYING` preserves its GNU
GPL version 3 license text. `src/game.vala` credits **Robert Ancell (2010–2013)**
and **Lubomir Rintel (2009)**. The application's credits include **J. Marcin
Gorycki, Lubomir Rintel, Robert Ancell, John Ward, Will Warner**, and **Brian
Holman (macOS port)**. The difficult-piece selection describes its algorithm as
originating in **Federico Poloni's Bastet**. Retain these credits in the port.
The specification and derived piece/scoring reference data are distributed under
GPL-3.0-or-later. Future game code derived from them should preserve that license
and the relevant notices. The Mac fork's separate libgnome-games-support library
has its own LGPL-3.0-or-later terms; that library is not included here.
Pierre Sarrazin's CMOC/compiler and individual libraries/examples have their own
notices, including public-domain components. Check the exact files used; do not
label every example or bundled library GPL or public domain. Using a public API
does not require copying its implementation. No third-party sound recordings,
ROMs, Mac binaries or emulator source were imported into this repository.
## Supplied title image
[title-reference.png](reference/title-reference.png) is the image Brian supplied
for this project and explicitly authorized as its title reference. It is retained
unchanged and is **design reference only**, not a CoCo screenshot or runtime asset.
Its hash is recorded in the manifest. This permission is not a general grant to
relicense every visual element for unrelated reuse.
The CoCo screen should recreate the composition at native resolution with its
own game graphics: dark grid, colored tetrominoes and a readable title. Replace
the Mac platform wording with **for CoCo**. No other game's assets or implementation
are required for this reference treatment.
## Explicit adaptations
The specification identifies behavior adapted for the CoCo: conventional
persistent hold swapping, bounded score storage and rule markers, a compact
deterministic PRNG rather than GLib stream compatibility, one-button joystick
menus, lower-color CoCo 2 graphics, approximate tone sequences, and safe handling
of pieces above the board. They must not be described as byte-for-byte Mac parity.
Hardware feasibility, timing, physical palette appearance, API performance and
disk layout are still to be demonstrated by the implementation. The arithmetic
memory estimates and reference tests do not establish a working CoCo build.
## CMOC example references consulted during implementation
Pierre Sarrazin's local CardGame 0.1.15 `beep-demo.c` (public domain) was consulted
for `initSound`, `getTicksForFrequency` and `beep` usage. CoCoLetters 0.1.0
`file.c`/`file.h` (Copyright 2026 Pierre Sarrazin, GPL-3.0-or-later) were consulted
for `decb_init`/`decb_registerDrive` initialization. The disk adapter follows
that initialization pattern, adds error handling, and uses the installed public
API contracts for writes, lengths and close/flush behavior. No standalone disk
driver, assembly sound routine or other game's rendering engine was copied.
The existing DOS loader is Pierre Sarrazin's public-domain autostart.c 0.1.2,
retained from the official disk-project template with the launch command adapted.
The audio correction also uses the documented bsound Player_disableSound API.
Only its standard mute helper is used; no Player IRQ or custom sound driver is
installed. The CardGame public-domain example implementation was consulted to
understand setup/teardown, without copying its assembly/register code.
## November 11 font update
The menu/HUD font is an unchanged subset of Pierre Sarrazin's public-domain
CardGame 0.1.15 font, also used by Color8. The original two font files, exact
SHA-256 values, source URL and public-domain notice are retained in
`third_party/cardgame-font/`. `src/platform/pierre_font.h` contains 26 letters,
ten digits and twelve punctuation glyphs. No drawing engine or assembly was
imported. Existing lowercase input maps to uppercase glyphs. The new C renderer
uses the original six visible columns/seven rows in each eight-pixel cell.
Brian explicitly permitted inspecting the supplied Mac scoring source on
November 11. The read-only checkout at revision
`be8769a403e506edb930372f963a9c4c83a0881e` confirms the existing Modern and
Classic (40.2) formulas. `scoring_through_drop` in tests/rules_test.c adapts the
GPL-3.0-or-later setup in its tests/test-scoring.vala to exercise actual piece
drops, bottom-row detection and level changes in the CoCo rules engine. No Mac
application code was changed or bundled.
For the build-02 joystick correction, Pierre Sarrazin's GPL-3.0-or-later
CoCoPlanes 0.1.0 coco-planes.c was consulted for its separate controller paths,
periodic sampling and active-low primary-button masks. Public coco.h keyboard
coordinates and Joystick.h contracts identify the shared input rows. No raw
register/interrupt/assembly code was copied. The new keyboard-row fixture is
authored for this repository; details are in JOYSTICK_FIX.md.