rustboyadvance-ng/README.md

# RustBoyAdvance-NG

[![Build Status](https://travis-ci.com/michelhe/rustboyadvance-ng.svg?branch=master)](https://travis-ci.com/michelhe/rustboyadvance-ng)

RustBoyAdvance-NG Nintendo GameBoy Advance emulator and debugger, written in the rust programming language.

Currently passing armwrestler tests, and displays some of TONC's Demos.

# Using the REPL

You need to have rust installed, and somehow legally obtain a gba bios binary.

```bash
$ cargo run -- debug
```

# Why is this project needed ?

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.

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*.

# Links

- [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)
    A single webpage written by *no$gba* developer  Martin Korth.
    This page has pretty much everything. Seriously, it's the best.
- [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)
    A GameBoy Advance emulator written in C++17 by a nice person called fleroviux.
    I've used this emulator to search for a tough bug in mine.
- [Eggvance](https://github.com/jsmolka/eggvance/tree/master/tests)
    A GameBoy Advance emulator written in C++, with really useful CPU test roms.
Update README.md 2019-06-28 11:05:48 +01:00			`# RustBoyAdvance-NG`

			`[![Build Status](https://travis-ci.com/michelhe/rustboyadvance-ng.svg?branch=master)](https://travis-ci.com/michelhe/rustboyadvance-ng)`

Fix many bugs, refactor many things.. Passing: Armwrestler, cpu_test by Dead_Body Former-commit-id: 80d815d110c5341515dd01c476a0d7e25ecb66a8 2019-11-08 22:55:09 +00:00			`RustBoyAdvance-NG Nintendo GameBoy Advance emulator and debugger, written in the rust programming language.`
Update README.md 2019-06-28 11:05:48 +01:00
Fix many bugs, refactor many things.. Passing: Armwrestler, cpu_test by Dead_Body Former-commit-id: 80d815d110c5341515dd01c476a0d7e25ecb66a8 2019-11-08 22:55:09 +00:00			`Currently passing armwrestler tests, and displays some of TONC's Demos.`
Update README.md 2019-06-28 11:05:48 +01:00
			`# Using the REPL`

			`You need to have rust installed, and somehow legally obtain a gba bios binary.`

			```bash
			`$ cargo run -- debug`
			```

			`# Why is this project needed ?`

Update README.md Former-commit-id: 03b224b7de9735a1ed43dd7460fe5fa9ece147b4 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.`
Update README.md 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.`

			`# Links`

			`- [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)`
			`A single webpage written by no$gba developer Martin Korth.`
Update README.md Former-commit-id: 03b224b7de9735a1ed43dd7460fe5fa9ece147b4 2019-07-03 00:23:36 +01:00			`This page has pretty much everything. Seriously, it's the best.`
Fix many bugs, refactor many things.. Passing: Armwrestler, cpu_test by Dead_Body Former-commit-id: 80d815d110c5341515dd01c476a0d7e25ecb66a8 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)`
Fix that DAMN bug. Long story short, I've been hunting this bug for a while now. While passing armwresteler tests, I still had an emulation bug which causeed libgcc's iprintf to produce bugged strings. In order to find it, I've used https://github.com/fleroviux/NanoboyAdvance/ And patched it to produce a formatted log of every step of the execution of iprintf: {OPCODE} {PC} {R0} {R1} ... {R14} {FLAGS} Did the same on my emulator and searched for differences. Found out the a "CMP r3, #0x0" instruction turned off the carry flag when it shouldn't. Found this sad function, the check I'm using for carry flag is meaningless when done on signed integers. :sigh: Former-commit-id: 871d2581921796dae9bf4f5fdaa45c6ad46aebec 2019-11-05 22:40:06 +00:00			`A GameBoy Advance emulator written in C++17 by a nice person called fleroviux.`
Fix many bugs, refactor many things.. Passing: Armwrestler, cpu_test by Dead_Body Former-commit-id: 80d815d110c5341515dd01c476a0d7e25ecb66a8 2019-11-08 22:55:09 +00:00			`I've used this emulator to search for a tough bug in mine.`
			`- [Eggvance](https://github.com/jsmolka/eggvance/tree/master/tests)`
			`A GameBoy Advance emulator written in C++, with really useful CPU test roms.`