Sage is a lightweight GBA development library for mode 5 inspired by 3DSage.
Explore the wiki »

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

Sage focuses on the GBA's bitmap display mode 5 providing back buffer page filping and full 32bit color with the trade off being halfed resolution (120x80) streched to fit the GBAs screen. The goal is to provide a small library, set of tooling, and build pipline that exposes concepts about the GBA for beginners or those looking to get set up quickly.

(back to top)

Built With

• DevKitPro
• 3DSage starter

(back to top)

Getting Started

To get started you will need the following installed on your system:

Prerequisites

• DevKitPro Setup
• GBA emulator

Installation

1. Once DevKitPro is intalled, make sure to add the devkitARM directory in your system path, this is where the gcc compiler for the GBA is.

2. Clone the repo

   git clone hhttps://github.com/BrandenM-OW/sage.git

3. Run the MakeFile

   cd path/to/repo/<project-name>
   make

4. The result of the makefile will be a .gba file in the root of the project folder which you can run in your emulator.

5. Automation. It's beneficial to automate the above to some degree. A batch file to run make clean && make && mgba-qt project.gba for example or using tasks in VSCode can improve the build / test loop.

(back to top)

Usage

We will be adding usage examples as branches to the repo as we build them.

(back to top)

Roadmap

• Sprites and images
• .bmp to c array pipeline in the build
• UI tooling
• Physics
• Better controller input handling

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Branden Morin - You won't catch me active on social media.

Project Link: hhttps://github.com/BrandenM-OW/sage

(back to top)

Acknowledgments

• 3DSage
• Devkitpro
• Tonc
• Brian Sowers

(back to top)