https://github.com/hanaasagi/ngc-224
:video_game: A Gameboy emulator built in Rust.
https://github.com/hanaasagi/ngc-224
gameboy gameboy-emulator
Last synced: about 2 months ago
JSON representation
:video_game: A Gameboy emulator built in Rust.
- Host: GitHub
- URL: https://github.com/hanaasagi/ngc-224
- Owner: Hanaasagi
- License: bsd-3-clause
- Created: 2021-04-23T08:58:29.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-06-06T19:19:39.000Z (over 4 years ago)
- Last Synced: 2025-09-23T22:42:10.345Z (about 2 months ago)
- Topics: gameboy, gameboy-emulator
- Language: Rust
- Homepage:
- Size: 538 KB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# NGC-224
A Gameboy emulator built in Rust.
## Features
- [x] CPU and instructions
- [x] PPU(GPU)
- [x] Cartridge(MBC)
- [x] MBC1
- [x] MBC2
- [x] MBC3
- [x] ROM ONLY
- [x] Memory Management
- [x] Joypad Control
- [ ] Audio
- [ ] Serial
- [ ] CGB-MODE
## Building and Installation
#### Build from source
```Bash
$ git clone https://github.com/Hanaasagi/NGC-224.git
$ cd NGC-224
$ cargo run -- -p
```
#### Install from the release page
I only upload the macos platform binary to Github. Download from the [release page](https://github.com/Hanaasagi/NGC-224/releases/).
## KeyBoard Mapping
| Keyboard | Gameboy |
| -------- | ------- |
| M | Start |
| N | Select |
| w | Up |
| s | Down |
| a | Left |
| d | Right |
| j | A |
| k | B |
## Bug Report
If the program panic, please send the `coredump` file in current directory and tell me which rom you are playing. Additionally, the process receive a `USR1` signal for starting a stepping debug.
## Reference
Thanks for the article and open source project below.
- [Gameboy Development Wiki](https://gbdev.gg8.se/wiki)
- [GameBoy 仿真器 / accu.cc](http://accu.cc/content/gameboy/preface/)
- [Gameboy Emulation / codeslinger.co.uk](http://www.codeslinger.co.uk/pages/projects/gameboy/dma.html)
- [mvdnes/rboy](https://github.com/mvdnes/rboy)
- [mohanson/gameboy](https://github.com/mohanson/gameboy)
- [HFO4/gameboy.live](https://github.com/HFO4/gameboy.live)