Files
CoCo3_Plus_MiSTer/docs/INSTALL.md
T
bholman cb40fed3b9 Introduce Coco 3 Plus for MiSTer
Add original-firmware Sound & Speech, four configurable Multi-Pak sockets,
bounded per-slot ROM allocation and a nine-page menu organized around devices
and media. Repair inherited clock/reset/CPU-memory/video paths and add explicit
conditional external-I/O timing contracts. Preserve native Main startup-file
ordering, saved layouts, stock-core separation and the coco3plus media profile.

Provide native Windows tool downloads, pinned ToolShed ROM assembly, fresh
Quartus builds, functional and fitted timing checks, reviewed release packaging
and passwordless SSH installation with backups. Retain original component
notices, document contribution copyright and keep SSC ROM inputs outside Git.

Validation: Quartus17.0.2 Build602 seed5, zero errors; 15 functional jobs,
368 both-corner timing scopes and eight tooling-integrity checks pass.
The renamed build reaches Disk BASIC, PRINT1+1 returns2 and SSC loads ready.
Physical cold power cycling and conditional board-delay assumptions remain
separate. Full original upstream histories are preserved before this single
consolidated implementation commit.
2026-11-18 16:00:45 -07:00

5.2 KiB

Install and operate Coco 3 Plus

Existing MiSTer, passwordless SSH

Have a working MiSTer installation and key-based SSH login before running the installer. On Windows OpenSSH is available as an optional Windows feature. Test:

ssh root@YOUR-MISTER

Establish the correct host fingerprint and public-key login through your normal SSH setup. The installer uses BatchMode=yes and StrictHostKeyChecking=yes: it does not request/store passwords or accept unknown host keys silently. The default Unix user is root, as on standard MiSTer. Another account must already have permission to write the FAT volume and issue MiSTer commands.

Build ROMs/FPGA per BUILD_WINDOWS.md. Put the two separately obtained chip ROMs in roms/ssc; packaging checks their exact size and SHA-256 before remote writes. They remain ignored by Git. Then save guest work, close files and stop disk activity. Installation returns to MENU, so the current guest session is ended.

.\windows\Install-MiSTer.ps1 -Load
# Or specify the address:
.\windows\Install-MiSTer.ps1 -HostName YOUR-MISTER -Load

If no address is given, the script prompts for one. It first validates every local input, then checks remote access, stages files, verifies remote SHA-256, returns to MENU, backs up replaced files, copies the overlay, checks installed hashes, syncs the volume and optionally loads the launcher. A timestamped receipt in ignored dist storage records the device and rollback path. It does not change accounts, networking, Samba, the Linux installation or nonvolatile FPGA storage.

Only the Plus launcher, its uniquely addressed RBF, two boot ROMs and optional SSC ROM/path records are installed. The stock core and other guest media remain. Existing coco3plus_v51.CFG is kept. First installs get Audio expansions / SDC / ROM / Floppy, startup Slot4, 512K, and Sound & Speech enabled when ROMs are supplied. Existing users retain their own layout and expansion selection.

-WithoutSSC creates a base-only package without chip ROMs/path records. It does not delete SSC files already installed on a device. Its fresh configuration selects Extended palette. SSC remains unavailable until valid ROMs are supplied and its cartridge/mode is selected.

Files and copying instead of SSH

Package-Release.ps1 writes dist/coco3plus/fat and the matching dist/coco3plus.zip archive. The release also includes a corresponding-source ZIP, file checksums, notices and manifest. The FAT overlay contains:

fat/
  _Computer/Coco 3 Plus.mgl
  _Computer/.coco3plus/<RBF-hash-prefix>/coco3plus.rbf
  games/coco3plus/boot0.rom
  games/coco3plus/boot1.rom
  games/coco3plus/pic-7040-510.bin       (separate supplied input)
  games/coco3plus/sp0256-al2.bin         (separate supplied input)
  config/coco3plus.f4, coco3plus.f5     (when SSC included)
  config/coco3plus_v51.CFG             (new installs only)

Power off MiSTer before removing its card. Copy the contents of fat/ to its data-volume root, including _Computer's hidden .coco3plus child. Back up collisions and skip the supplied CFG when one already exists. Preserve the manifest next to your release archive. Copying this folder onto an unprepared card does not install Linux or make it bootable.

Guest .DSK, .VHD, .CCC, .ROM, .BIN and .CAS files belong in games/coco3plus or subfolders. A software library is optional and is not silently downloaded or redistributed by setup. Keep a pristine diagnostic disk and use writable copies for saved results.

Public source/core packages

Local complete packages can contain your own ROM inputs and must not be published as though ignored files were automatically excluded from ZIPs. Use Package-Release.ps1 -PublicPackage -Output dist/coco3plus-public for a source/core artifact that omits all boot and SSC ROMs. Supply the required ROMs before manual copy/launch. The SSH installer rejects this incomplete-ROM package and directs you to make a complete local package from your own verified inputs.

First launch and recovery

Choose Computer → Coco 3 Plus. It should reach Disk Extended Color BASIC. PRINT 1+1 should print 2. F12 → Sound & Expansion reports Sound & Speech ready after its original ROMs load automatically. F12 → Cartridges & Multi-Pak controls the four sockets and startup slot. F12 → Floppy Disks mounts images without changing the layout. Changing socket devices restarts the guest.

The MGL uses native setname=coco3plus, so settings and remembered files use the same canonical namespace. The RBF also identifies itself as Coco 3 Plus, so welcome/help strings no longer expose the retired development name. The native profile override remains coco3plus; changing the display identity does not require abandoning the existing saved settings or media.

For rollback, return to MENU and restore _Computer/Coco 3 Plus.mgl from the receipt's remote backup directory. Its previously addressed RBF remains in place. Restore backed-up boot/SSC/path files if those inputs also need rollback. Existing saved CFG was not overwritten. On a first installation, select the preserved stock CoCo3 entry to use the original environment. Keep backup/staging folders until physical cold-start and audio checks pass; failed installs retain their staging evidence instead of deleting it automatically.