apogee-rs 0.3.0

Apogee BK-01 emulator with MIDI support via PPI

Install

To download the source code, build the Apogee binary, and install it in $HOME/.cargo/bin in one go run:

cargo install --locked --git https://github.com/coignard/apogee

Or install via Homebrew:

brew install coignard/tap/apogee

Alternatively, you can manually download the source code and build the Apogee binary with:

git clone https://github.com/coignard/apogee
cd apogee
cargo build --release
sudo cp target/release/apogee /usr/local/bin/

Install as library

Add the following to your Cargo.toml:

[dependencies]
apogee-rs = { git = "https://github.com/coignard/apogee" }

Or to pin a specific version:

[dependencies]
apogee-rs = { git = "https://github.com/coignard/apogee", tag = "0.3.0" }

Test

cargo test

Tests use a replay-based snapshot system. Each file in tests/replays/ is a JSON recording of a session: input events, timing, and metadata (ROM name, sample rate, display settings, SHA-256 of the ROM).

The emulator replays the events and at each checkpoint compares machine state and screenshot against the expected dumps in tests/dumps/.

To update snapshots after an intentional change:

UPDATE_SNAPSHOTS=1 cargo test

Please note that changes to iz80 that affect instruction timing or CPU state require manually reviewing and rerecording the affected replays, not just regenerating snapshots.

Credits

Thanks to Kakos Nonos for sharing his Apogee BK-01 programs used in the test suite, Victor A. Pykhonin for helping debug checksums and KR580VI53 and for emu80 which was the main reference for this emulator, and Olga Podivilova for the Apogee BK-01 illustration.

License