2019-06-28 11:05:48 +01:00
# RustBoyAdvance-NG
2020-01-12 00:08:19 +00:00
![license ](https://img.shields.io/github/license/michelhe/rustboyadvance-ng ) [![Build Status ](https://travis-ci.com/michelhe/rustboyadvance-ng.svg?branch=master )](https://travis-ci.com/michelhe/rustboyadvance-ng)
2019-06-28 11:05:48 +01:00
2020-01-11 23:29:36 +00:00
![icon ](assets/icon.png )
2020-01-12 00:04:44 +00:00
Nintendo GameBoy Advance ™ emulator and debugger, written in rust.
2019-06-28 11:05:48 +01:00
2020-01-12 00:04:44 +00:00
# Build and usage
2019-06-28 11:05:48 +01:00
2020-01-12 00:04:44 +00:00
1. set-up rust *nightly*
2. Obtain a gba bios binary. you can get an [open source GBA bios ](https://github.com/Nebuleon/ReGBA/blob/master/bios/gba_bios.bin )
3. Place the bios file in the repository root and name it `gba_bios.bin`
2019-06-28 11:05:48 +01:00
2020-01-12 00:04:44 +00:00
4. Build and run in release mode (performance is terrible in the `dev` profile)
```bash
$ cargo run --release -- path/to/rom
```
2019-06-28 11:05:48 +01:00
# Why is this project needed ?
2019-07-03 00:23:36 +01:00
It's actually **not** . There are quite a lot of GBA emulators, ~~and even some written in rust~~ . Actually, I couldn't find any game capable emulators written in rust.
2019-06-28 11:05:48 +01:00
I'm only doing this as a side project intended for learning rust.
This is my *third* take on this project. My first go at this was about 3 years ago, but I didn't like rust much at the time so it got abandoned.
I tried to resurrect it a year ago but didn't have the time to get invested in a side-project, let alone learning rust.
I've grown to like rust a lot since then, so here we go again.
You know what they say, *third time's a charm* .
2020-01-12 00:04:44 +00:00
# Progress
## Supported features:
* Display modes 0,4,5
* PCM Audio channels
## Todo:
* Display modes 2,3 (affine backgrounds)
* Flash(backup) support
* CGB audio (4 wave generator channels)
* web.asm frontend
* color correction
## Tested games status
### Kirby - Nightmare in Dreamland*
No issues so far
### Pokemon - Emerald
2020-01-26 00:16:54 +00:00
~~Won't boot unless binary patched to remove a loop querying the flash chip~~
2020-01-12 00:04:44 +00:00
### Dragon Ball - Legacy of Goku 2
2020-01-18 20:47:31 +00:00
~~crashes when entering in-game menu, other than that works fine.~~
2020-01-12 00:04:44 +00:00
## Screenshots
![Pokemon Emerald ](media/screenshot1.png ) ![Kirby - Nightmare in Dreamland ](media/screenshot2.png ) ![Dragon Ball - Legacy of Goku 2 ](media/screenshot3.png )
2020-01-16 23:28:11 +00:00
# Links and attribution
2019-06-28 11:05:48 +01:00
- [ARM7TDMI Technical Reference Manual ](http://infocenter.arm.com/help/topic/com.arm.doc.ddi0210c/DDI0210B.pdf )
Technical Reference Manuals are **fun** .
- [GBATEK ](http://problemkaputt.de/gbatek.htm )
2020-01-16 23:28:11 +00:00
A single webpage written by *no$gba* developer Martin Korth.
2019-07-03 00:23:36 +01:00
This page has pretty much everything. Seriously, it's the best.
2019-11-08 22:55:09 +00:00
- [TONC ](https://www.coranac.com/tonc/text/ )
A comprehensive GBA dev guide that I used a-lot in order to understand the GBA system.
Comes with neat demo roms that really helped me during development and debugging.
- [NanoboyAdvance ](https://github.com/fleroviux/NanoboyAdvance )
2019-11-05 22:40:06 +00:00
A GameBoy Advance emulator written in C++17 by a nice person called fleroviux.
2020-01-12 00:04:44 +00:00
I've used this for debugging.
2020-01-16 23:28:11 +00:00
- [Eggvance gba-suite ](https://github.com/jsmolka/gba-suite )
Incredible test suite for the arm7tdmi interpreter that I'm using, written by Julian Smolka.