mirror of
https://github.com/italicsjenga/agb.git
synced 2024-10-16 23:21:48 +11:00
72 lines
2.5 KiB
Markdown
72 lines
2.5 KiB
Markdown
# AGBRS template
|
|
|
|
## A basic template example for agb projects
|
|
|
|
This makes getting started with a new project for the Game Boy Advance in rust really simple, by providing
|
|
all the boiler plate files for you.
|
|
|
|
## Building
|
|
|
|
### Prerequisites
|
|
|
|
You will need the following installed in order to build and run this project:
|
|
|
|
* A recent version of `rustup`. See the [rust website](https://www.rust-lang.org/tools/install) for instructions for your operating system
|
|
* `arm-none-eabi-binutils` for assembling and linking
|
|
* Windows: [GNU Arm Embedded Toolchain](https://developer.arm.com/tools-and-software/open-source-software/developer-tools/gnu-toolchain/gnu-rm/downloads).
|
|
Make sure you select "Add path to environment variable" during the install
|
|
* Debian and derivatives (e.g. Ubuntu, raspberry pi OS, linux mint): `sudo apt install binutils-arm-none-eabi`
|
|
* Arch linux and derivatives: `sudo pacman -S arm-none-eabi-binutils`
|
|
|
|
You will also want to install an emulator. The best support in agb is with [mgba](https://mgba.io), with
|
|
`println!` support via `agb::println!` but any emulator should work. You'll get the best experience if
|
|
`mgba-qt` is in your `PATH`.
|
|
|
|
If you want to run your game on real hardware, you will also need to install `agb-gbafix` which you can do after installing
|
|
rust with the following: `cargo install agb-gbafix`. This is not required if you are only running your game in an emulator.
|
|
|
|
### Running in an emulator
|
|
|
|
Once you have the prerequisites installed, you should be able to build using
|
|
|
|
```sh
|
|
cargo build
|
|
```
|
|
|
|
or in release mode (recommended for the final version to ship to players)
|
|
|
|
```sh
|
|
cargo build --release
|
|
```
|
|
|
|
The resulting file will be in `target/thumbv4t-none-eabi/debug/<your game>` or `target/thumbv4t-none-eabi/release/<your game>` depending on
|
|
whether you did a release or debug build.
|
|
|
|
If you have `mgba-qt` in your path, you will be able to run your game with
|
|
|
|
```sh
|
|
cargo run
|
|
```
|
|
|
|
or in release mode
|
|
|
|
```sh
|
|
cargo run --release
|
|
```
|
|
|
|
## Starting development
|
|
|
|
You can find the documentation for agb [here](https://docs.rs/agb/latest/agb/).
|
|
|
|
You may also want to change the package name and version in `Cargo.toml` before you start.
|
|
|
|
## Shipping a .gba file for real hardware
|
|
|
|
To make a game run on real hardware, you will need to convert the built file into a file suitable for
|
|
running on the real thing.
|
|
|
|
First build the binary in release mode using the instructions above, then do the following:
|
|
|
|
```sh
|
|
agb-gbafix target/thumbv4t-none-eabi/release/<your game> -o <your game>.gba
|
|
``` |