Go to file
Gwilym Kuiper 285643a973
Merge pull request #139 from gwilymk/import-asm-macro
Import the new asm macro required in newer versions of nightly
2022-01-01 11:41:01 +00:00
.github Update template repo on release of agb 2021-11-24 22:44:11 +00:00
.vscode move launch.json to parent 2021-05-20 07:25:51 +01:00
agb Add another missing must_use 2022-01-01 11:35:49 +00:00
agb-image-converter Add suuport for 32x32 tiles 2021-10-30 18:22:09 +01:00
agb-macros create a number macro that can use floating point numbes 2021-12-04 02:44:57 +00:00
agb-sound-converter Add support for 18157Hz 2021-10-29 15:51:05 +01:00
book Move some files around 2021-11-24 20:24:11 +00:00
mgba-test-runner share deps with image-converter 2021-08-01 18:03:13 +01:00
template Add gitignore for template 2021-11-24 22:42:55 +00:00
.gitignore Delete template/Cargo.lock 2021-06-20 23:53:42 +01:00
LICENSE add project wide MPLv2 license 2021-05-29 15:22:19 +01:00
logo-original.png Add logo to repo and readme 2021-07-05 23:56:43 +01:00
README.md Add CMake to the test runner instructions 2021-08-01 21:16:57 +01:00
release.sh Ensure agb-sound-converter tests pass too 2021-10-18 20:27:38 +01:00

Rust for the Game Boy Advance

AGB logo

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 necessarily contain the latest release, but in development versions. Further 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

  • libelf and cmake
    • Debian and derivatives: sudo apt install libelf-dev cmake
    • Arch Linux and derivatives: pacman -S libelf cmake
  • 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.