Publish the reproducible Sound Lab and FPGA Colour Lab sources

This commit is contained in:
bholman committed 2026-11-18 12:28:31 -07:00
commit 88254d7e24
27 files changed
+4574

No files matched your search

+72
View File
@@ -0,0 +1,72 @@
# VCC Plus Diagnostics
Standalone diagnostic disks for the Tandy Color Computer, VCC Plus, and
compatible FPGA implementations. Designed by Brian Holman · Sponsored by
Dezota LLC.
| Diagnostic | Tagged release | Get started |
| --- | --- | --- |
| Sound Lab | [SL1-44B5F46F](https://vccplus-git.brianholman.com/VCCPlus/VCCPlusDiagnostics/releases/tag/sound-lab-sl1-44b5f46f) | Use Disk BASIC and a Speech/Sound Cartridge. Boot a writable copy in drive 0 with `DOS`. |
| FPGA Colour Lab | [CL1](https://vccplus-git.brianholman.com/VCCPlus/VCCPlusDiagnostics/releases/tag/fpga-colour-lab-cl1) | Use Disk BASIC and enable compatible FPGA 256-color support. Leave the Speech/Sound Cartridge out. Run `RUN"COLORLAB"` from drive 0. |
Use a fresh machine session and keep a pristine disk master. The release pages
link to the exact disk, checksum and source package hosted in the VCC Plus
download area. The [compatibility paper](https://vccplus.brianholman.com/publications/ssc-fpga256/)
identifies the results obtained with these disk revisions.
## Build from a tag
Check out the release tag for the diagnostic you want to reproduce.
### Sound Lab
Use Python 3.10 or later and [VCC Plus 3.7.1 build 67's installed Mac toolchain](https://vccplus.brianholman.com/dl/software/VCCPlus/3.7.1-67/VCC-Plus-for-Mac-3.7.1-67-Universal.dmg),
which supplies CMOC 0.1.101, LWTools 4.25, the guest SSC and Disk BASIC
libraries, and the disk writer and boot-loader installer. The macOS command
below assumes the application is installed in Applications.
```sh
export PYTHONDONTWRITEBYTECODE=1
python3 examples/sound-lab/check.py \
--toolchain '/Applications/VCC Plus.app/Contents/Resources/Toolchain' \
--output .build/sound-lab-sl1
```
This runs the host checks, builds the disk, and records the input and output
hashes. The published source package contains the build inputs for the guest
libraries and the source or build recipes for the toolchain components used by
this release. See [Sound Lab operation and reporting](examples/sound-lab/README.md).
The optional headless VCC test compiles the retained runner against a local
VCC Plus checkout and built core library. On macOS set
`CPATH` to `<VCCPlus checkout>/tests/toolchain/ssc`, then add `--core` and
`--roms` with the paths to the core library and your local ROM directory.
The test boots a disposable copy and measures digital behavior and audio
activity. Listening assessments are recorded separately.
### FPGA Colour Lab
Use Python 3 and LWASM 4.25. The builder accepts an executable path on Mac
or Windows:
```sh
python3 examples/fpga256/build.py --lwasm /path/to/lwasm --output .build/colour-lab-cl1
```
On Windows use `py -3` and the path to `lwasm.exe`. See the
[Colour Lab controls](examples/fpga256/README.md) and the
[Windows FPGA handoff](docs/windows-handoff.md).
## Ownership and attribution
Maintain standalone diagnostic sources here. App and FPGA tests consume a
specific tagged release and verify the disk hash before making test copies.
The examples at the initial tags preserve the source inputs used to build
the published disks.
The original diagnostic source is GPL-3.0-or-later. See [COPYING](COPYING).
The Sound Lab bootstrap retains Pierre Sarrazin's public-domain notice and
credits Roger Schrag. The corresponding Sound Lab sources carry their
component notices. FPGA Colour Lab exercises the CoCo3FPGA extension by
Gary Becker and the MiSTer adaptation by Stan Hodge, Gary Becker and Alan
Steremberg. ROMs are supplied locally by the user for emulator tests.