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 f7719d4183 Add favicon to wasm app Former-commit-id: 54c3133e61b3c9edbe9e5ffb878ba232734f8326		2020-04-30 09:59:13 +03:00
.github/workflows	Fix deploy.yml	2020-04-13 23:49:15 +03:00
.vscode	chore: Update launch.json	2020-02-01 11:28:56 +02:00
assets	Add new project icon	2020-04-10 16:45:55 +03:00
bindings/rustboyadvance-jni	Fix crash with JNI bindings during audio buffer overrun	2020-04-19 22:24:23 +03:00
external	Bump gba-suite git submodule	2020-02-07 17:36:32 +02:00
fps_bench	Add simple fps benchmark	2020-04-13 00:34:50 +03:00
media	docs: update README.md	2020-01-12 02:04:44 +02:00
platform	Add favicon to wasm app	2020-04-30 09:59:13 +03:00
rustboyadvance-core	Fix unused warnings when not compiled with elf_support	2020-04-30 09:12:45 +03:00
.gitignore	Ignore .logs dir	2020-04-13 00:24:06 +03:00
.gitmodules	Bump gba-suite git submodule	2020-02-07 17:36:32 +02:00
.travis.yml	chore: Update .travis.yml	2020-02-21 22:07:06 +02:00
Cargo.lock	Run cargo-update	2020-04-30 08:41:46 +03:00
Cargo.toml	Add rustboyadvance-wasm	2020-04-13 17:55:39 +03:00
LICENSE	Create LICENSE	2019-06-24 16:36:20 +03:00
README.md	Update README.md	2020-04-13 19:48:59 +03:00

RustBoyAdvance-NG

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

Project Structure

rustboyadvance-core/src - Main library 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

Download SDL2 runtime binaries for windows (either 32bit or 64bit depending on the target machine) https://www.libsdl.org/download-2.0.php https://www.libsdl.org/projects/SDL_image/

Extract all the DLLs into the project root (Yeah, its dirty and a build script will be written in the future to automate this)

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.