Archived

Nintendo™ Game Boy Advance emulator and debugger.

This repository has been archived on 2024-06-01. You can view files and clone it, but cannot push or open issues or pull requests.

Find a file

Michel Heily 67c071595a Add Dockerfile for android targets Former-commit-id: 97d399e200cef304b1d76b099d7449b4a8f33a0b Former-commit-id: 842c1a99e6ac83f4caf90560167b8ddb57c8c93d		2021-06-05 20:27:27 +03:00
.github/workflows	ci: Use ./gradelew assemble instead of build	2020-10-20 02:03:42 +03:00
.vscode	Update tasks.json	2021-06-05 18:45:05 +03:00
assets	Add new project icon	2020-04-10 16:45:55 +03:00
bindings/rustboyadvance-jni	JNI/Android - Fix stupid copy-pasta bug	2020-10-20 02:10:38 +03:00
core	[perf] arm: Improve performance with barrel shifter.	2021-06-05 18:54:46 +03:00
external	Implement controller support for the SDL2 frontend	2020-05-11 20:26:11 +03:00
fps_bench	Refactor dir rustboyadvance-core -> core	2020-05-30 13:43:37 +03:00
media	docs: update README.md	2020-01-12 02:04:44 +02:00
platform	android: Fix takePersistableUriPermission() error on Android 10	2020-10-27 02:06:23 +02:00
.gitignore	Ignore .logs dir	2020-04-13 00:24:06 +03:00
.gitmodules	Implement controller support for the SDL2 frontend	2020-05-11 20:26:11 +03:00
.travis.yml	chore: Update .travis.yml	2020-02-21 22:07:06 +02:00
Cargo.lock	[perf] core: gpu: Refactor to use unpacked mmio configuration during rendering	2020-11-06 06:26:00 -08:00
Cargo.toml	Build with debuginfo	2021-06-05 18:44:46 +03:00
Dockerfile.android	Add Dockerfile for android targets	2021-06-05 20:27:27 +03:00
LICENSE	Create LICENSE	2019-06-24 16:36:20 +03:00
README.md	Refactor dir rustboyadvance-core -> core	2020-05-30 13:43:37 +03:00

RustBoyAdvance-NG

Nintendo GameBoy Advance ™ emulator and debugger, written in rust.

Project Structure

core/ - Main emulator crate
bindings/ - Bindings to other languages. Currently only java binidings through JNI.
platform/ - Constains executables & application built with rustboyadvance-core
- platform/rustbodyadvance-wasm - Web emulator powered by WebAssembly
- platform/rustbodyadvance-sdl2 - Desktop application built with sdl2
- platform/rustbodyadvance-minifb - Desktop application built with minifb, not maintained.
- platform/android - A PoC Android application.

To get started, you need to get a stable rust toolchain.

Install SDL2 dependencies

sudo apt-get -y install libsdl2-dev libsdl2-image-dev

SDL2 runtime binaries are included in this repository, no extra setup needed.

You need to obtain a gba bios binary. An open source GBA bios is also available and supported.

Place the bios file in the repository root and name it gba_bios.bin (or alternatively use the -b command line option)

Build and run in release mode (performance is terrible in the dev profile)

$ cargo run --release -p rustboyadvance-sdl2 -- path/to/rom

You can also drag&drop rom files or any zip files containing .gba files inside into the emulator window and a new rom will be loaded.

Currently the key bindings are not configureable.

GBA key bindings:

Special key bindings

Key	Function
Space (hold)	Disable 60fps cap
F1	Custom debugger (requires --features debugger)
F2	Spawn gdbserver (experimetnal, requires --features gdb)
F5	Save snapshot file
F9	Load snapshot file

The android project is placed inside platform/android. To build it, open it with Android Studio.

You also need to set up rust to build android targets with NDK.

TODO - instructions

ARM7TDMI Technical Reference Manual Technical Reference Manuals are fun.
GBATEK A single webpage written by no$gba developer Martin Korth. This page has pretty much everything. Seriously, it's the best.
TONC 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 A GameBoy Advance emulator written in C++17 by a nice person called fleroviux. I've used this for debugging.
Eggvance gba-suite Incredible test suite for the arm7tdmi interpreter that I'm using, written by Julian Smolka.