- Rust 97.7%
- Python 2.3%
08c8705904
Add --suite thumb while retaining default ARM preparation. Verify hashes, the Thumb-to-ARM evaluation bridge, and the result checkpoint; retain upstream provenance outside tracked files. Expand offline synthetic adapter and CLI regressions. Darwin arm64 baseline: the unmodified Thumb ROM reaches ARM eval at 0x08000934 after 771 steps with r7=229 in debug and release. ARM remains passing. Online/offline preparation agrees and all 21 Python tests pass. CPU behavior is unchanged. |
||
|---|---|---|
| crates | ||
| docs | ||
| tools | ||
| .envrc | ||
| .gitignore | ||
| AGENTS.md | ||
| Cargo.lock | ||
| Cargo.toml | ||
| CLAUDE.md | ||
| flake.lock | ||
| flake.nix | ||
| README.md | ||
gameboy-rust
Game Boy family emulation in Rust, written from scratch. The Game Boy Advance (GBA) is the first and currently only system.
This cannot run Pokémon Emerald or other commercial games yet. It is an emulator foundation: an ARM7TDMI interpreter, memory bus, timers, DMA, Mode 0–5 video, and an original BIOS replacement. The included demos run original ARM test programs through the emulated hardware. Raw ROM files can run in terminal sessions or a window with keyboard input. Audio and saves are not implemented.
Layout
| Crate | Purpose |
|---|---|
crates/gba-core |
Platform-independent GBA emulator. No external Rust dependencies. |
crates/gba-demos |
Original test programs that drive the core. |
crates/desktop |
Native window frontend on minifb. Builds the gameboy-rust executable. |
Quick start
macOS on Apple Silicon is the verified platform. Install Nix (with flakes) and direnv, then:
direnv allow .
direnv exec . cargo run --locked --release -- --tile-demo
direnv exec . cargo test --locked
Arrows scroll, Q rotates, W zooms, Z flips, X changes priority, Enter resets, and Escape exits.
Run direnv exec . cargo run --locked -- --help to list all modes.
For original ROM files, use --rom path/to/original.gba --window, or --steps 100000 instead of --window for terminal diagnostics.
See cartridge loading for limits and report meanings.
Use --test-suite suite.json for repeatable headless ROM assertions.
Documentation
| Document | Contents |
|---|---|
| docs/status.md | What works today, deliberate limits, and next steps |
| docs/demos.md | Every demo, its command, and its controls |
| docs/development.md | Nix, direnv, and macOS build notes |
| docs/testing.md | Validation commands and what the test suites cover |
| docs/rom-tests.md | Headless ROM suites, completion checks, assertions, and JSON reports |
| docs/public-arm-tests.md | Pinned public ARM test, preparation command, results, and limits |
| docs/public-thumb-tests.md | Pinned public Thumb test, result protocol, and compatibility baseline |
| docs/architecture.md | Crate boundaries and a file-by-file map |
| docs/hardware/cpu.md | ARM/Thumb execution rules, modes, exceptions, and timing |
| docs/hardware/cartridge.md | ROM loading, window/input controls, original ROM generator, and diagnostics |
| docs/hardware/bios.md | The original BIOS replacement and each supported service |
| docs/hardware/timers-irq.md | Timers, interrupt registers, HALT/STOP, and power control |
| docs/hardware/dma.md | DMA channels, triggers, and timing |
| docs/hardware/display-timing.md | Display clock, status, IRQs, and scanline capture |
| docs/hardware/video.md | Backgrounds, sprites, mosaic, windows, color effects, and input |
| docs/references.md | External hardware references and emulator sources consulted |
Coding agents should start with AGENTS.md.
Legal
All demo content and the BIOS replacement are original. No Nintendo code or assets are included. Only use game ROMs that you may lawfully use. Do not commit game ROMs, BIOS files, or game assets.