Skip to content

Latest commit

 

History

History
71 lines (54 loc) · 3.16 KB

README.md

File metadata and controls

71 lines (54 loc) · 3.16 KB
Raw

License:Zlib License:Apache2 License:MIT

ci crates.io docs.rs

  • Built with cargo-make
  • Stability:None

gba

A crate to make GBA programming easy.

Currently we don't have as much documentation as we'd like. If you check out the awesome-gbadev repository they have many resources, though most are oriented towards C.

First Time Setup

Building for the GBA requires Nightly rust, and also uses the build-std feature, so you'll need the rust source available.

rustup install nightly
rustup +nightly component add rust-src

You'll also need the ARM binutils so that you can have the assembler and linker for the ARMv4T architecture. The way to get them varies by platform:

  • Ubuntu and other debian-like linux distros will usually have them in the package manager. 
    sudo apt-get install binutils-arm-none-eabi
  • With OSX you can get them via homebrew. 
    brew install --cask gcc-arm-embedded
  • On Windows you can get the installer from ARM's website and run that.
    • Download the GNU Arm Embedded Toolchain
    • When installing the toolchain, make sure to select "Add path to environment variable" during install.
    • You'll have to restart any open command prompts after you so run the installer so that they see the new PATH value.

Finally, rustc itself is only able to make ELF format files. These can be run in emulators, but aren't able to be played on actual hardware. You'll need to convert the ELF file into a GBA rom. There's a cargo-make file in this repository to do this, and it relies on a tool called gbafix to assign the right header data to the ROM when packing it.

cargo install cargo-make
cargo install gbafix

Contribution

This crate is tri-licensed under Zlib / Apache-2.0 / MIT. Any contributions you submit must be licensed the same.