GameBoy Emulator

A work-in-progress GameBoy emulator written in Rust.

Useful Links

• Pan Docs – Official GameBoy hardware documentation.
• How to Write an Emulator in Rust – A guide to building your own emulator in Rust.
• Cheatsheet – A quick reference for CPU instructions.
• CPU Breakdown – Detailed documentation of CPU operations.

Getting Started

Prerequisites

• Rust: Install the latest stable version from rust-lang.org.

Running the Emulator

Launch the emulator with a GameBoy ROM:

cargo run -- path/to/game.gb

Testing

Run the test suite, which includes a set of GameBoy test ROMs:

cargo test

Contributing

Contributions are welcome! Please review our CONTRIBUTING guidelines for details on our code of conduct and the process for submitting pull requests.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Third-Party Licenses

• The test ROMs in roms/ are from Christoph Sprenger's Game Boy tests and are licensed under the MIT License. See LICENSE-THIRD-PARTY.

Acknowledgements

Special thanks to the GameBoy development community for the wealth of documentation and resources that have helped shape this project.