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.

License

Butano is licensed under the zlib license:

(C) 2020 Gustavo Valiente (gustavo.valiente@prontonmail.com)

This software is provided 'as-is', without any express or implied warranty. In no event will the authors be held liable for any damages arising from the use of this software.

Permission is granted to anyone to use this software for any purpose, including commercial applications, and to alter it and redistribute it freely, subject to the following restrictions:

  1. The origin of this software must not be misrepresented; you must not claim that you wrote the original software. If you use this software in a product, an acknowledgment in the product documentation would be appreciated but is not required.
  2. Altered source versions must be plainly marked as such, and must not be misrepresented as being the original software.
  3. This notice may not be removed or altered from any source distribution.