Butano

Butano is a modern C++ high level engine for the Game Boy Advance.

This is the documentation for the Butano engine. To see a high-level overview, go to the GitHub main page.

Thanks to the Magnum Project for its awesome documentation! This documentation is heavily based on it.

What's new?

Check out the changelog.

Getting started

The best way to get started is to read the guide to download, install and start using Butano. After that, there are various examples explaining most aspects of the engine. At last, check how to import your own assets in a game and take a look at the modules page. The frequently asked questions (FAQ) are worth a look too.

Contact and support

If you spotted a bug, need a feature or have an awesome idea, the best you can do is to head over to GitHub and to the gbadev Discord server.

Licenses

Butano is licensed under the zlib license, see the LICENSE file for details.

Third party libraries are licensed under other licenses, please check the licenses folder for details.

Assets used in games, examples and other projects are licensed under other licenses, please check the credits folders for details.