Skip to content

This repo will be used to learn, explore, and master the Butano BGA engine.

Notifications You must be signed in to change notification settings

GBA-Dev/supreme-spoon

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

17 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Butano GBA Engine Exploration

Welcome to the Butano GBA Engine Exploration repository! This repo is a collaborative space dedicated to learning, experimenting, and mastering the Butano engine for Game Boy Advance (GBA) development. Whether you're a beginner or an experienced developer, this is the perfect place to dive into retro game development and push the boundaries of what can be created on the GBA platform.

πŸ“š About Butano

Butano is a modern, high-level engine for Game Boy Advance that simplifies GBA development while offering powerful tools for creating 2D games. Butano allows developers to easily handle sprites, backgrounds, audio, and more without worrying about low-level hardware details.

πŸ› οΈ What You'll Find in This Repo

  • Sample Projects: Examples showcasing different aspects of Butano, such as sprite management, text rendering, audio integration, and more.
  • Learning Resources: Tutorials, guides, and documentation to help developers of all skill levels get started with GBA development.
  • Code Experiments: Hands-on experimentation with Butano’s features, pushing the limits of what’s possible on the GBA.
  • Collaborative Projects: Work together with other developers to create exciting GBA demos and games.
  • Best Practices: Tips, tricks, and best practices for optimizing GBA games using Butano.

πŸš€ Getting Started

To get started with Butano and GBA development, follow these steps:

  1. Clone the Repo:

    git clone git@github.com:GBA-Dev/supreme-spoon.git
    cd supreme-spoon
  2. Set Up the Butano Environment:

    • Follow the Butano installation guide to set up the required tools and environment for GBA development, including devkitPro and grit.
  3. Explore the Projects:

    • Navigate to the projects/ directory to explore various example projects.
    • Each project has its own README.md file with instructions and details.
  4. Build a Project:

    • To compile any project, navigate to its directory and run:

      make
    • Then, load the generated .gba file in your favorite GBA emulator (e.g., mGBA).

πŸ•ΉοΈ Sample Projects

  • Text Rendering: Learn how to display text on the screen using Butano’s sprite text generator.
  • Sprite Handling: Explore how to create, move, and manipulate sprites in a GBA game.
  • Audio Integration: Experiment with playing background music and sound effects in a Butano game.
  • Menu System: Build a basic menu system for GBA games with dynamic selections and transitions.

πŸ§‘β€πŸ€β€πŸ§‘ How to Contribute

We welcome contributions! If you'd like to add sample projects, improve the documentation, or collaborate on a game, feel free to fork the repo and submit a pull request.

Steps to Contribute:

  1. Fork the repo.
  2. Create a new branch for your feature or bugfix.
    git checkout -b my-new-feature
  3. Commit your changes.
    git commit -m "Add new feature"
  4. Push to the branch.
    git push origin my-new-feature
  5. Submit a pull request!

πŸ“„ License

This repository is licensed under the MIT License.

πŸ“ž Contact

Feel free to reach out via our Discord community if you have questions, want to collaborate, or just chat about GBA development!

About

This repo will be used to learn, explore, and master the Butano BGA engine.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published