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.
rustboyadvance-ng/README.md

42 lines
1.6 KiB
Markdown
Raw Normal View History

# rustboyadvance-ng
2019-06-28 11:05:48 +01:00
Nintendo GameBoy Advance™ emulator and debugger, written in Rust.
2019-06-28 11:05:48 +01:00
> This repository is a fork of [rustboyadvance-ng](https://github.com/michelhe/rustboyadvance-ng), with minimal non-feature changes.
# Project structure
* `core/` - Main emulator crate that ties everything together
* `arm7tdmi/` - Emulation of the Arm7tdmi processor
* `app/` - Contains the desktop application built with `sdl2`
## External content
The file at [`external/gamecontrollerdb.txt`](./external/gamecontrollerdb.txt) is not my work - it is sourced from [this GitHub repository](https://github.com/mdqinc/SDL_GameControllerDB) and covered by the appropriate license present in said repository.
2024-03-23 20:58:46 +00:00
## Usage
2024-03-23 21:05:09 +00:00
You will need to specify the BIOS file to run with, using the `--bios` command-line argument. Note that there is such a BIOS ROM present in this directory at [`./external/gba_bios.bin`](./external/gba_bios.bin).
2024-03-23 20:58:46 +00:00
## Key bindings
GBA key bindings:
| Keyboard | GBA |
|----------- |---------- |
| Up | Up |
| Down | Down |
| Left | Right |
| Right | Right |
| Z | B Button |
| X | A Button |
| Return | Start |
| Backspace | Select |
| A | L |
| S | R |
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 |