33 releases
0.13.1 | Oct 21, 2024 |
---|---|
0.12.0 | Aug 27, 2024 |
0.11.6 | May 12, 2024 |
0.11.5 | Mar 4, 2024 |
0.2.0 | Nov 13, 2018 |
#117 in Game dev
381 downloads per month
Used in rustygba
150KB
2.5K
SLoC
gba
Docs.rs Documentation
This crate is intended for working with the GBA.
To build for the GBA you'll need to use build-std
and you'll also need to
activate the compiler-builtins-weak-intrinsics
feature.
The following should be somewhere in your .cargo/config.toml
:
[unstable]
build-std = ["core"]
build-std-features = ["compiler-builtins-weak-intrinsics"]
lib.rs
:
A crate for GBA development.
How To Make Your Own GBA Project Using This Crate
This will require the use of Nightly Rust. Any recent-ish version of Nightly should be fine.
- Get The ARM Binutils: You'll need the ARM version of the GNU binutils
in your path, specifically the linker (
arm-none-eabi-ld
). Linux folks can use the package manager. Mac and Windows folks can use the ARM Website. - Run
rustup component add rust-src
: This makes rustup keep the standard library source code on hand, which is necessary forbuild-std
to work. - Create A
.cargo/config.toml
: You'll want to set up a file to provide all the right default settings so that a basiccargo build
andcargo run
will "just work". Something like the following is what you probably want.
[build]
target = "thumbv4t-none-eabi"
[unstable]
build-std = ["core"]
[target.thumbv4t-none-eabi]
runner = "mgba-qt" # sets the emulator to run bins/examples with
rustflags = [
"-Clinker=arm-none-eabi-ld", # uses the ARM linker
"-Clink-arg=-Tlinker_scripts/mono_boot.ld", # sets the link script
]
- Make Your Executables: At this point you can make a
bin
or anexample
file. Every executable will need to be#![no_std]
and#![no_main]
. They will also need a#[panic_handler]
defined, as well as a#[no_mangle] extern "C" fn main() -> ! {}
function, which is what the assembly runtime will call to start your Rust program after it fully initializes the system. The C ABI must be used because Rust's own ABI is not stable.
#![no_std]
#![no_main]
#[panic_handler]
fn panic_handler(_: &core::panic::PanicInfo) -> ! {
loop {}
}
#[no_mangle]
extern "C" fn main() -> ! {
loop {}
}
- Optional: Use
objcopy
andgbafix
: Thecargo build
will produce ELF files, which mGBA can run directly. If you want to run your program on real hardware you'll need to firstobjcopy
the raw binary out of the ELF into its own file, then Usegbafix
to give an appropriate header to the file.objcopy
is part of the ARM binutils you already installed, it should be namedarm-none-eabi-objcopy
. You can getgbafix
through cargo:cargo install gbafix
.
Other GBA-related Crates
This crate provides an API to interact with the GBA that is safe, but with minimal restrictions on what components can be changed when. If you'd like an API where the borrow checker provides stronger control over component access then the agb crate might be what you want.
Safety
All safety considerations for the crate assume that you're building for the
thumbv4t-none-eabi
or armv4t-none-eabi
targets, using the provided
linker script, and then running the code on a GBA. While it's possible to
break any of these assumptions, if you do that some or all of the code
provided by this crate may become unsound.
Dependencies
~215–720KB
~13K SLoC