Go to file
2021-06-05 20:55:12 +01:00
.github/workflows Use $HOME rather than ~ (#36) 2021-05-30 21:02:11 +01:00
.vscode move launch.json to parent 2021-05-20 07:25:51 +01:00
agb Merge pull request #51 from corwinkuiper/fix-affine 2021-06-05 20:55:12 +01:00
agb-image-converter Merge pull request #48 from gwilymk/reduce-dependencies-for-agb-image-converter 2021-06-05 19:29:35 +01:00
mgba-test-runner fix regex 2021-06-04 19:15:16 +01:00
template lock file decided to update? 2021-05-23 06:34:30 +01:00
.gitignore remove .vscode from .gitignore 2021-05-20 07:25:38 +01:00
LICENSE add project wide MPLv2 license 2021-05-29 15:22:19 +01:00
README.md update readme 2021-06-03 18:55:42 +01:00

Rust for the Game Boy Advance

This is a library for making games on the Game Boy Advance using the Rust programming language. It attempts to be a high level abstraction over the internal workings of the Game Boy Advance whilst still being high performance and memory efficient.

The documentation for the latest release can be found on docs.rs. Note that this repository does not nesesarily contain the latest release, but in development versions. Futher work is needed to improve the documentation.

Build Requirements

  • Recent rustup, see the rust website for instructions for your operating system.
    • You can update rustup with rustup update, or using your package manager if you obtained rustup in this way.
  • arm eabi binutils
    • Debian and derivatives: sudo apt install binutils-arm-none-eabi
    • Arch Linux and derivatives: pacman -S arm-none-eabi-binutils
    • Windows can apparently use the GNU Arm Embedded Toolchain. Make sure to select "Add path to environment variable" during the install.
    • This process has only been tested on Ubuntu and Arch Linux.

Test Requirements

  • mgba 0.9.X
  • mgba-test-runner
    • Run cargo install --path mgba-test-runner inside this directory

Real Hardware Build

  • Need gbafix, rust implementation can be installed with cargo install gbafix.
  • On compiled elf file, additionally need to
arm-none-eabi-objcopy -O binary {input-elf} {output-gba}
gbafix {output-gba}

Stability

0% stable, I have no problems making drastic changes in the API in order to make something nice to work with.